UploadedFile
class UploadedFile implements UploadedFileInterface (View source)
Generic implementation of the PSR-7 UploadedFileInterface.
Properties
| protected string | $clientFilename | ||
| protected string | $clientMediaType | ||
| protected int | $error | ||
| protected null|string | $file | ||
| protected bool | $moved | ||
| protected int | $size | ||
| protected StreamInterface|null | $stream |
Methods
No description
Depending on the value set file or stream variable
Return true if there is no upload error
No description
Retrieve a stream representing the uploaded file.
Move the uploaded file to a new location.
Retrieve the file size.
Retrieve the error associated with the uploaded file.
Retrieve the filename sent by the client.
Retrieve the media type sent by the client.
No description
Write the uploaded file to the given path.
Details
__construct(StreamInterface|string|resource $streamOrFile, int $size, int $errorStatus, string|null $clientFilename = null, string|null $clientMediaType = null)
No description
protected
setStreamOrFile(string|StreamInterface|resource $streamOrFile)
Depending on the value set file or stream variable
protected bool
isOk()
Return true if there is no upload error
bool
isMoved()
No description
getStream()
Retrieve a stream representing the uploaded file.
This method MUST return a StreamInterface instance, representing the uploaded file. The purpose of this method is to allow utilizing native PHP stream functionality to manipulate the file upload, such as stream_copy_to_stream() (though the result will need to be decorated in a native PHP stream wrapper to work with such functions).
If the moveTo() method has been called previously, this method MUST raise an exception.
moveTo(string $targetPath)
Move the uploaded file to a new location.
Use this method as an alternative to move_uploaded_file(). This method is guaranteed to work in both SAPI and non-SAPI environments. Implementations must determine which environment they are in, and use the appropriate method (move_uploaded_file(), rename(), or a stream operation) to perform the operation.
$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 or stream 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.
int|null
getSize()
Retrieve the file size.
Implementations SHOULD return the value stored in the "size" key of the file in the $_FILES array if available, as PHP calculates this based on the actual size transmitted.
int
getError()
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.
string|null
getClientFilename()
Retrieve the filename sent by the client.
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.
getClientMediaType()
Retrieve the media type sent by the client.
Do not trust the value returned by this method. A client could send a malicious media type with the intention to corrupt or hack your application.
Implementations SHOULD return the value stored in the "type" key of the file in the $_FILES array.
protected
throwExceptionIfNotAccessible()
No description
protected bool
writeFile(string $path)
Write the uploaded file to the given path.