magic-core

# Class: HttpFile Source Location: /core/helper/http/HttpFile.php
### Class Overview
マルチパートリクエストのファイルを管理するクラスです. #### Author(s): T.Okumura #### Version: 1.0.0 | ### Methods __construct get getFile getName getNameArray getSize getSizeArray getTmpName getTmpNameArray getType getTypeArray setInputName
### Class Details [line 18] マルチパートリクエストのファイルを管理するクラスです. $_FILESを操作するための機能を提供します。 #### Tags:
author: | T.Okumura
version: | 1.0.0
final: |
[ Top ] ### Class Methods ### constructor __construct [line 27]
`HttpFile __construct( )`
コンストラクタ. #### Tags:
access: | public
[ Top ] ### method get [line 52]
`mixed get( string $key, [string $inputName = NULL])`
ファイルを取得します. #### Tags:
return: | 取得できた場合はそのファイル、できなければFALSE
access: | public
#### Parameters:
string | $key | 取得する値のキー
string | $inputName | [optional] 取得するファイルのname属性(オプション)
[ Top ] ### method getFile [line 68]
`array getFile( )`
すべてのファイルを取得します. 返されるのはファイルのコピーです。 これによって返された配列に変更を加えても、元の$_FILESの内容は変更されない事に注意してください。 #### Tags:
return: | コピーされたファイルの配列
access: | public
[ Top ] ### method getName [line 78]
`mixed getName( [string $inputName = NULL], [int $index = 0])`
ファイルの名前を取得します. #### Tags:
return: | 存在しなければFALSE、インデックスが指定されていればその名前、省略されていれば最初の名前
access: | public
#### Parameters:
string | $inputName | [optional] 取得するファイルのname属性(オプション)
int | $index | [optional] ファイルが複数の場合、0から始まるインデックス番号(オプション)
[ Top ] ### method getNameArray [line 91]
`mixed getNameArray( [string $inputName = NULL])`
すべてのファイルのファイル名の配列を取得します. このファンクションは、常にarrayを返します。 リクエストされたファイルが一つだと分かっている場合には、getName()を使用する方が便利です。 #### Tags:
return: | 存在しなければFALSE、存在していればファイル名の配列
see: | HttpFile::getName()
access: | public
#### Parameters:
string | $inputName | [optional] 取得するファイルのname属性(オプション)
[ Top ] ### method getSize [line 128]
`mixed getSize( [string $inputName = NULL], [int $index = 0])`
ファイルのファイルサイズを取得します. #### Tags:
return: | 存在しなければFALSE、インデックスが指定されていればそのファイルのサイズ、省略されていれば最初のファイルのサイズ
access: | public
#### Parameters:
string | $inputName | [optional] 取得するファイルのname属性(オプション)
int | $index | [optional] ファイルが複数の場合、0から始まるインデックス番号(オプション)
[ Top ] ### method getSizeArray [line 141]
`mixed getSizeArray( [string $inputName = NULL])`
すべてのファイルのファイルサイズの配列を取得します. このファンクションは、常にarrayを返します。 リクエストされたファイルが一つだと分かっている場合には、getSize()を使用する方が便利です。 #### Tags:
return: | 存在しなければFALSE、存在していればファイルサイズの配列
see: | HttpFile::getSize()
access: | public
#### Parameters:
string | $inputName | [optional] 取得するファイルのname属性(オプション)
[ Top ] ### method getTmpName [line 153]
`mixed getTmpName( [string $inputName = NULL], [int $index = 0])`
ファイルの一時保存先を取得します. #### Tags:
return: | 存在しなければFALSE、インデックスが指定されていればそのファイルの一時保存先、省略されていれば最初のファイルの一時保存先
access: | public
#### Parameters:
string | $inputName | [optional] 取得するファイルのname属性(オプション)
int | $index | [optional] ファイルが複数の場合、0から始まるインデックス番号(オプション)
[ Top ] ### method getTmpNameArray [line 166]
`mixed getTmpNameArray( [string $inputName = NULL])`
すべてのファイルの一時保存先の配列を取得します. このファンクションは、常にarrayを返します。 リクエストされたファイルが一つだと分かっている場合には、getTmpName()を使用する方が便利です。 #### Tags:
return: | 存在しなければFALSE、存在していれば一時保存先の配列
see: | HttpFile::getTmpName()
access: | public
#### Parameters:
string | $inputName | [optional] 取得するファイルのname属性(オプション)
[ Top ] ### method getType [line 103]
`mixed getType( [string $inputName = NULL], [int $index = 0])`
ファイルのファイルタイプを取得します. #### Tags:
return: | 存在しなければFALSE、インデックスが指定されていればそのファイルのタイプ、省略されていれば最初のファイルのタイプ
access: | public
#### Parameters:
string | $inputName | [optional] 取得するファイルのname属性(オプション)
int | $index | [optional] ファイルが複数の場合、0から始まるインデックス番号(オプション)
[ Top ] ### method getTypeArray [line 116]
`mixed getTypeArray( [string $inputName = NULL])`
すべてのファイルのファイルタイプの配列を取得します. このファンクションは、常にarrayを返します。 リクエストされたファイルが一つだと分かっている場合には、getType()を使用する方が便利です。 #### Tags:
return: | 存在しなければFALSE、存在していればファイルタイプの配列
see: | HttpFile::getType()
access: | public
#### Parameters:
string | $inputName | [optional] 取得するファイルのname属性(オプション)
[ Top ] ### method setInputName [line 43]
`void setInputName( string $inputName)`
ファイルのnameを設定します. HTMLファイルの ＜input type="file" name="xxx" タグのname属性と一致させる必要があります。 予めこのファンクションで名前が設定されている場合は、 各ファンクションのオプション引数を省略できます。 ここで指定していなければ、個別に指定する必要があります。 #### Tags:
access: | public
#### Parameters:
string | $inputName | ファイルのname属性
[ Top ] Documentation generated on Fri, 16 Dec 2011 11:13:49 +0100 by phpDocumentor 1.4.3