eZ Publish  [4.2]
Public Member Functions | Static Public Member Functions | Public Attributes
eZHTTPFile Class Reference
HTTP utilities

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 ($http_name, $maxSize=false)
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_DOES_NOT_EXIST = -1
const UPLOADEDFILE_EXCEEDS_MAX_SIZE = -3
const UPLOADEDFILE_EXCEEDS_PHP_LIMIT = -2
const UPLOADEDFILE_OK = 0

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 42 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 176 of file ezhttpfile.php.

eZHTTPFile::attributes ( )
Returns:
an array with the attributes for this object.

Definition at line 154 of file ezhttpfile.php.

Referenced by hasAttribute().

static eZHTTPFile::canFetch ( $  http_name,
$  maxSize = false 
) [static]
Returns:
true if the HTTP file $http_name can be fetched. If $maxSize is given, the function returns 0 (eZHTTPFile::UPLOADEDFILE_OK) if the file can be fetched, -1 (eZHTTPFile::UPLOADEDFILE_DOES_NOT_EXIST) if there has been no file uploaded, -2 (eZHTTPFile::UPLOADEDFILE_EXCEEDS_PHP_LIMIT) if the file was uploaded but size exceeds the upload_max_size limit (set in the PHP configuration), -3 (eZHTTPFile::UPLOADEDFILE_EXCEEDS_MAX_SIZE) if the file was uploaded but size exceeds $maxSize or MAX_FILE_SIZE variable in the form.

Definition at line 212 of file ezhttpfile.php.

Referenced by eZContentUpload\fetchHTTPFile(), eZImageType\fetchObjectAttributeHTTPInput(), eZMediaType\fetchObjectAttributeHTTPInput(), eZBinaryFileType\fetchObjectAttributeHTTPInput(), eZStylePackageCreator\validateCSSFile(), eZStylePackageCreator\validateImageFiles(), eZImageType\validateObjectAttributeHTTPInput(), eZMediaType\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 52 of file ezhttpfile.php.

Referenced by fetch().

static eZHTTPFile::fetch ( $  http_name) [static]

Fetches the HTTP file named $http_name and returns a eZHTTPFile object, or null if the file could not be fetched.

Definition at line 263 of file ezhttpfile.php.

Referenced by eZStylePackageCreator\commitCSSFile(), eZContentUpload\fetchHTTPFile(), eZImageType\fetchObjectAttributeHTTPInput(), eZMediaType\fetchObjectAttributeHTTPInput(), eZBinaryFileType\fetchObjectAttributeHTTPInput(), eZStylePackageCreator\validateCSSFile(), eZStylePackageCreator\validateImageFiles(), and eZPackageCreationHandler\validatePackageThumbnail().

eZHTTPFile::hasAttribute ( $  attr)
Returns:
true if the attribute $attr exists

Definition at line 168 of file ezhttpfile.php.

eZHTTPFile::setMimeType ( $  mime)

Changes the MIME-Type to $mime.

Definition at line 289 of file ezhttpfile.php.

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

Definition at line 69 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 83 of file ezhttpfile.php.

Member Data Documentation

eZHTTPFile::$Filename

The local filename.

Definition at line 306 of file ezhttpfile.php.

eZHTTPFile::$HTTPName

The name of the HTTP file.

Definition at line 296 of file ezhttpfile.php.

eZHTTPFile::$IsTemporary

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

Definition at line 310 of file ezhttpfile.php.

eZHTTPFile::$MimeCategory

The mimetype category (first part)

Definition at line 302 of file ezhttpfile.php.

eZHTTPFile::$MimePart

The mimetype type (second part)

Definition at line 304 of file ezhttpfile.php.

eZHTTPFile::$OriginalFilename

The original name of the file from the client.

Definition at line 298 of file ezhttpfile.php.

eZHTTPFile::$Size

The size of the local file.

Definition at line 308 of file ezhttpfile.php.

eZHTTPFile::$Type

The mime type of the file.

Definition at line 300 of file ezhttpfile.php.

const eZHTTPFile::UPLOADEDFILE_DOES_NOT_EXIST = -1

Definition at line 45 of file ezhttpfile.php.

Referenced by canFetch(), eZImageType\validateObjectAttributeHTTPInput(), eZMediaType\validateObjectAttributeHTTPInput(), and eZBinaryFileType\validateObjectAttributeHTTPInput().

const eZHTTPFile::UPLOADEDFILE_EXCEEDS_MAX_SIZE = -3

Definition at line 47 of file ezhttpfile.php.

Referenced by canFetch(), eZImageType\validateObjectAttributeHTTPInput(), eZMediaType\validateObjectAttributeHTTPInput(), and eZBinaryFileType\validateObjectAttributeHTTPInput().

const eZHTTPFile::UPLOADEDFILE_EXCEEDS_PHP_LIMIT = -2

Definition at line 46 of file ezhttpfile.php.

Referenced by canFetch(), eZImageType\validateObjectAttributeHTTPInput(), eZMediaType\validateObjectAttributeHTTPInput(), and eZBinaryFileType\validateObjectAttributeHTTPInput().

const eZHTTPFile::UPLOADEDFILE_OK = 0

Definition at line 44 of file ezhttpfile.php.

Referenced by canFetch().

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