eZPublishCommunityProject(LegacyStack)  2013.9
eZHTTPFile Class Reference

Provides access to HTTP post files. More...

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. More...
 
static fetch ($http_name)
 

Public Attributes

 $Filename
 The local filename. More...
 
 $HTTPName
 The name of the HTTP file. More...
 
 $IsTemporary
 Whether the file is a temporary file or if it has been moved(stored). More...
 
 $MimeCategory
 The mimetype category (first part) More...
 
 $MimePart
 The mimetype type (second part) More...
 
 $OriginalFilename
 The original name of the file from the client. More...
 
 $Size
 The size of the local file. More...
 
 $Type
 The mime type of the file. More...
 
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.

Member Function Documentation

eZHTTPFile::attribute (   $attr)
Returns
the value for the attribute $attr or null if the attribute does not exist.
eZHTTPFile::attributes ( )
Returns
an array with the attributes for this object.

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

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

Referenced by fetch().

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

Changes the MIME-Type to $mime.

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

Stores the temporary file to the destination dir $dir.

Member Data Documentation

eZHTTPFile::$Filename

The local filename.

Referenced by attribute().

eZHTTPFile::$HTTPName

The name of the HTTP file.

eZHTTPFile::$IsTemporary

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

Referenced by attribute().

eZHTTPFile::$MimeCategory

The mimetype category (first part)

Referenced by attribute(), storageDir(), and store().

eZHTTPFile::$MimePart

The mimetype type (second part)

Referenced by attribute().

eZHTTPFile::$OriginalFilename

The original name of the file from the client.

Referenced by attribute().

eZHTTPFile::$Size

The size of the local file.

Referenced by attribute().

eZHTTPFile::$Type

The mime type of the file.

Referenced by attribute().

const eZHTTPFile::UPLOADEDFILE_CANT_WRITE = -5
const eZHTTPFile::UPLOADEDFILE_MISSING_TMP_DIR = -4
const eZHTTPFile::UPLOADEDFILE_OK = 0
const eZHTTPFile::UPLOADEDFILE_UNKNOWN_ERROR = -6

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