eZ Publish  [trunk]
eZHTTPFile Class Reference

Provides access to HTTP post files. More...

List of all members.

Public Member Functions

 attribute ($attr)
 attributes ()
 eZHTTPFile ($http_name, $variable)
 hasAttribute ($attr)
 setMimeType ($mime)
 storageDir ($sub_dir=false)
 store ($sub_dir=false, $suffix=false, $mimeData=false)

Static Public Member Functions

static canFetch ($httpName, $maxSize=false)
 Returns whether a file can be fetched.
static fetch ($http_name)

Public Attributes

 $Filename
 The local filename.
 $HTTPName
 The name of the HTTP file.
 $IsTemporary
 Whether the file is a temporary file or if it has been moved(stored).
 $MimeCategory
 The mimetype category (first part)
 $MimePart
 The mimetype type (second part)
 $OriginalFilename
 The original name of the file from the client.
 $Size
 The size of the local file.
 $Type
 The mime type of the file.
const UPLOADEDFILE_CANT_WRITE = -5
const UPLOADEDFILE_DOES_NOT_EXIST = -1
const UPLOADEDFILE_EXCEEDS_MAX_SIZE = -3
const UPLOADEDFILE_EXCEEDS_PHP_LIMIT = -2
const UPLOADEDFILE_MISSING_TMP_DIR = -4
const UPLOADEDFILE_OK = 0
const UPLOADEDFILE_UNKNOWN_ERROR = -6

Detailed Description

Provides access to HTTP post files.

This class provides easy access to files posted by clients over HTTP. The HTTP file will be present as a temporary file which can be moved to store it, if not the file will be removed when the PHP script is done.

Definition at line 22 of file ezhttpfile.php.


Member Function Documentation

eZHTTPFile::attribute ( attr)
Returns:
the value for the attribute $attr or null if the attribute does not exist.

Definition at line 159 of file ezhttpfile.php.

Returns:
an array with the attributes for this object.

Definition at line 137 of file ezhttpfile.php.

Referenced by hasAttribute().

static eZHTTPFile::canFetch ( httpName,
maxSize = false 
) [static]

Returns whether a file can be fetched.

Parameters:
string$httpNameName of the file.
bool|intWhether a maximum file size applies or size in bytes of the maximum allowed.
Returns:
bool|int true if the HTTP file $httpName can be fetched. If $maxSize is given, the function returns eZHTTPFile::UPLOADEDFILE_OK if the file can be fetched, eZHTTPFile::UPLOADEDFILE_DOES_NOT_EXIST if there has been no file uploaded, eZHTTPFile::UPLOADEDFILE_EXCEEDS_PHP_LIMIT if the file was uploaded but size exceeds the upload_max_size limit (set in the PHP configuration), eZHTTPFile::UPLOADEDFILE_EXCEEDS_MAX_SIZE if the file was uploaded but size exceeds $maxSize or MAX_FILE_SIZE variable in the form. eZHTTPFile::UPLOADEDFILE_MISSING_TMP_DIR if the temporary directory is missing eZHTTPFile::UPLOADEDFILE_CANT_WRITE if the file can't be written eZHTTPFile::UPLOADEDFILE_UNKNOWN_ERROR if an unknown error occured

Definition at line 203 of file ezhttpfile.php.

Referenced by checkRelationActions(), eZContentUpload\fetchHTTPFile(), eZMediaType\fetchObjectAttributeHTTPInput(), eZImageType\fetchObjectAttributeHTTPInput(), eZBinaryFileType\fetchObjectAttributeHTTPInput(), eZStepSiteTypes\uploadPackage(), eZStylePackageCreator\validateCSSFile(), eZStylePackageCreator\validateImageFiles(), eZMediaType\validateObjectAttributeHTTPInput(), eZImageType\validateObjectAttributeHTTPInput(), eZBinaryFileType\validateObjectAttributeHTTPInput(), and eZPackageCreationHandler\validatePackageThumbnail().

eZHTTPFile::eZHTTPFile ( http_name,
variable 
)

Initializes with a name and http variable.

Parameters:
http_nameName of the HTTP variable
variableThe HTTP variable structure

Definition at line 35 of file ezhttpfile.php.

Referenced by fetch().

Returns:
true if the attribute $attr exists

Definition at line 151 of file ezhttpfile.php.

Changes the MIME-Type to $mime.

Definition at line 295 of file ezhttpfile.php.

eZHTTPFile::storageDir ( sub_dir = false)
Returns:
the directory where the file should be stored.

Definition at line 52 of file ezhttpfile.php.

eZHTTPFile::store ( sub_dir = false,
suffix = false,
mimeData = false 
)

Stores the temporary file to the destination dir $dir.

Definition at line 66 of file ezhttpfile.php.


Member Data Documentation

eZHTTPFile::$Filename

The local filename.

Definition at line 312 of file ezhttpfile.php.

eZHTTPFile::$HTTPName

The name of the HTTP file.

Definition at line 302 of file ezhttpfile.php.

eZHTTPFile::$IsTemporary

Whether the file is a temporary file or if it has been moved(stored).

Definition at line 316 of file ezhttpfile.php.

eZHTTPFile::$MimeCategory

The mimetype category (first part)

Definition at line 308 of file ezhttpfile.php.

eZHTTPFile::$MimePart

The mimetype type (second part)

Definition at line 310 of file ezhttpfile.php.

eZHTTPFile::$OriginalFilename

The original name of the file from the client.

Definition at line 304 of file ezhttpfile.php.

eZHTTPFile::$Size

The size of the local file.

Definition at line 314 of file ezhttpfile.php.

eZHTTPFile::$Type

The mime type of the file.

Definition at line 306 of file ezhttpfile.php.

Definition at line 29 of file ezhttpfile.php.

Referenced by canFetch(), and eZContentUpload\fetchHTTPFile().

Definition at line 28 of file ezhttpfile.php.

Referenced by canFetch(), and eZContentUpload\fetchHTTPFile().

Definition at line 24 of file ezhttpfile.php.

Referenced by canFetch(), and eZContentUpload\fetchHTTPFile().

Definition at line 30 of file ezhttpfile.php.

Referenced by canFetch(), and eZContentUpload\fetchHTTPFile().


The documentation for this class was generated from the following file: