spunQ_SessionTemporaryFileProvider Class Reference

Handles temporary files being stored in the session. More...

Inheritance diagram for spunQ_SessionTemporaryFileProvider:

spunQ_ITemporaryFileProvider

List of all members.

Public Member Functions

 storeTemporaryFile (spunQ_File $temporaryFile, string $originalFileName)
 retrieveTemporaryFile (string $identifier)
 getProviderType ()
 storeTemporaryFile (spunQ_File $temporaryFile, $originalFileName)
 Temporarily stores a file.
 retrieveTemporaryFile ($identifier)
 Gets the temporary file identified by the given string.

Static Public Member Functions

static getInstance ()
 Returns the singleton instance.

Static Private Attributes

static $instance = NULL
 Singleton instance.


Detailed Description

Handles temporary files being stored in the session.

Definition at line 6 of file SessionTemporaryFileProvider.class.php.


Member Function Documentation

spunQ_ITemporaryFileProvider::retrieveTemporaryFile ( identifier  )  [inherited]

Gets the temporary file identified by the given string.

E.g. used to convert submitted form values to files. The retrieved file should have the same file name as the original file. Therefore, temporary file providers will have to use a folder structure to avoid collisions.

Parameters:
$string The identifier of the file.
Returns:
spunQ_File

Implemented in spunQ_LocalTemporaryFileProvider.

spunQ_SessionTemporaryFileProvider::retrieveTemporaryFile ( string $  identifier  ) 

See also:
strg_ITemporaryFileProvider

Definition at line 35 of file SessionTemporaryFileProvider.class.php.

spunQ_ITemporaryFileProvider::storeTemporaryFile ( spunQ_File temporaryFile,
originalFileName 
) [inherited]

Temporarily stores a file.

Returns an identifier which may later be used to fetch the stored file. The string consists of a randomized string and the original filename. Thus, we cannot loose the original name of the file.

Parameters:
$file The file to store.
$originalFileName The original name of the file.
Returns:
string

Implemented in spunQ_LocalTemporaryFileProvider.

spunQ_SessionTemporaryFileProvider::storeTemporaryFile ( spunQ_File temporaryFile,
string $  originalFileName 
)

See also:
strg_ITemporaryFileProvider

Definition at line 26 of file SessionTemporaryFileProvider.class.php.


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

Generated on Fri Jul 1 11:12:43 2011 for spunQ3 by  doxygen 1.5.9