spunQ_ITemporaryFileProvider Interface Reference
An interface for temporarily store files. More...
Inheritance diagram for spunQ_ITemporaryFileProvider:
Public Member Functions | |
| storeTemporaryFile (spunQ_File $temporaryFile, $originalFileName) | |
| Temporarily stores a file. | |
| retrieveTemporaryFile ($identifier) | |
| Gets the temporary file identified by the given string. | |
Detailed Description
An interface for temporarily store files.Implemented for the multi upload module.
Definition at line 7 of file ITemporaryFileProvider.interface.php.
Member Function Documentation
| spunQ_ITemporaryFileProvider::retrieveTemporaryFile | ( | $ | identifier | ) |
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_ITemporaryFileProvider::storeTemporaryFile | ( | spunQ_File $ | temporaryFile, | |
| $ | originalFileName | |||
| ) |
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.
The documentation for this interface was generated from the following file:
