Manual

SDK

 
   

API Reference
 

Sections

Todo

eZHTTPFile Class Reference
[HTTP utilities]

Provides access to HTTP post files. More...

List of all members.


Public Methods

 eZHTTPFile ($http_name,$variable)
 storageDir ($sub_dir=false)
 store ($sub_dir=false,$suffix=false)
 attributes ()
 hasAttribute ($attr)
 attribute ($attr)
 canFetch ($http_name)
& fetch ($http_name)

Public Attributes

 HTTPName
 The name of the HTTP file.

 OriginalFilename
 The original name of the file from the client.

 Type
 The mime type of the file.

 MimeCategory
 The mimetype category (first part).

 MimePart
 The mimetype type (second part).

 Filename
 The local filename.

 Size
 The size of the local file.

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

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 ezhttpfile.php.

Constructor & Destructor Documentation

eZHTTPFile::eZHTTPFile (  $    http_name,
$    variable
) 
 

Initializes with a name and http variable.

Parameters:
http_name  Name of the HTTP variable
variable  The HTTP variable structure

Definition at line ezhttpfile.php.

References Type.

Referenced by fetch().

Member Function Documentation

eZHTTPFile::attribute (  $    attr ) 
 

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

Definition at line ezhttpfile.php.

References Type.

eZHTTPFile::attributes (    ) 
 

Returns:
an array with the attributes for this object.

Definition at line ezhttpfile.php.

eZHTTPFile::canFetch (  $    http_name ) 
 

Returns:
true if the HTTP file $http_name can be fetched.

Definition at line ezhttpfile.php.

Referenced by eZBinaryFileType::fetchObjectAttributeHTTPInput().

& eZHTTPFile::fetch (  $    http_name ) 
 

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

Definition at line ezhttpfile.php.

References eZDebug::writeError().

Referenced by eZBinaryFileType::validateObjectAttributeHTTPInput().

eZHTTPFile::hasAttribute (  $    attr ) 
 

Returns:
true if the attribute $attr exists

Definition at line ezhttpfile.php.

eZHTTPFile::storageDir (  $    sub_dir = false ) 
 

Returns:
the directory where the file should be stored.

Definition at line ezhttpfile.php.

References MimeCategory.

Referenced by store().

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

Stores the temporary file to the destination dir $dir.

Definition at line ezhttpfile.php.

References eZDebug::writeError().

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

Exponential