$path
$path : string
The path to the temporary file.
Value object representing a single file uploaded through an HTTP request. Used by the IncomingRequest class to provide files.
Typically, implementors will extend the SplFileInfo class.
__construct(string $path, string $originalName, string $mimeType = null, integer $size = null, integer $error = null)
Accepts the file information as would be filled in from the $_FILES array.
| string | $path | The temporary location of the uploaded file. |
| string | $originalName | The client-provided filename. |
| string | $mimeType | The type of file as provided by PHP |
| integer | $size | The size of the file, in bytes |
| integer | $error | The error constant of the upload (one of PHP's UPLOADERRXXX constants) |
move(string $targetPath, string $name = null, boolean $overwrite = false) : boolean
Move the uploaded file to a new location.
$targetPath may be an absolute path, or a relative path. If it is a relative path, resolution should be the same as used by PHP's rename() function.
The original file MUST be removed on completion.
If this method is called more than once, any subsequent calls MUST raise an exception.
When used in an SAPI environment where $_FILES is populated, when writing files via moveTo(), is_uploaded_file() and move_uploaded_file() SHOULD be used to ensure permissions and upload status are verified correctly.
If you wish to move to a stream, use getStream(), as SAPI operations cannot guarantee writing to stream destinations.
| string | $targetPath | Path to which to move the uploaded file. |
| string | $name | the name to rename the file to. |
| boolean | $overwrite | State for indicating whether to overwrite the previously generated file with the same name or not. |
if the $path specified is invalid.
on any error during the move operation.
on the second or subsequent call to the method.
getError() : integer
Retrieve the error associated with the uploaded file.
The return value MUST be one of PHP's UPLOAD_ERR_XXX constants.
If the file was uploaded successfully, this method MUST return UPLOAD_ERR_OK.
Implementations SHOULD return the value stored in the "error" key of the file in the $_FILES array.
One of PHP's UPLOAD_ERR_XXX constants.
getName() : string
Retrieve the filename. This will typically be the filename sent by the client, and should not be trusted. If the file has been moved, this will return the final name of the moved file.
Do not trust the value returned by this method. A client could send a malicious filename with the intention to corrupt or hack your application.
Implementations SHOULD return the value stored in the "name" key of the file in the $_FILES array.
The filename sent by the client or null if none was provided.
getExtension()
Overrides SPLFileInfo's to work with uploaded files, since the temp file that's been uploaded doesn't have an extension.
Is simply an alias for guessExtension for a safer method than simply relying on the provided extension. Additionally it will return clientExtension in case if there are other extensions with the same mime type.
store(string $folderName = null, string $fileName = null) : string
Save the uploaded file to a new location.
By default, upload files are saved in writable/uploads directory. The YYYYMMDD folder and random file name will be created.
| string | $folderName | the folder name to writable/uploads directory. |
| string | $fileName | the name to rename the file to. |
file full path