| Methods |
public
|
__construct(string $path, string $originalName, string $mimeType = null, int $size = null, int $error = null)
Accepts the file information as would be filled in from the $_FILES array.
Accepts the file information as would be filled in from the $_FILES array.
Parameters
| $path |
The temporary location of the uploaded file.
|
| $originalName |
The client-provided filename.
|
| $mimeType |
The type of file as provided by PHP
|
| $size |
The size of the file, in bytes
|
| $error |
The error constant of the upload (one of PHP's UPLOADERRXXX constants)
|
Overrides
Implements
|
#
|
public
|
move(string $targetPath, string $name = null, bool $overwrite = false): bool
Move the uploaded file to a new location.
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.
Parameters
| $targetPath |
Path to which to move the uploaded file.
|
| $name |
the name to rename the file to.
|
| $overwrite |
State for indicating whether to overwrite the previously generated file with the same
name or not.
|
Throws
Overrides
Implements
|
#
|
protected
|
setPath(string $path): string
create file target path if
the set path does not exist
create file target path if
the set path does not exist
Returns
|
#
|
public
|
hasMoved(): bool
Returns whether the file has been moved or not. If it has,
the move() method will not work and certain properties, like…
Returns whether the file has been moved or not. If it has,
the move() method will not work and certain properties, like
the tempName, will no longer be available.
Implements
|
#
|
public
|
getError(): int
Retrieve the error associated with the uploaded file.
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.
Returns
One of PHP's UPLOAD_ERR_XXX constants.
Implements
|
#
|
public
|
getErrorString(): string
Get error string
|
#
|
public
|
getClientMimeType(): string
Returns the mime type as provided by the client.
This is NOT a trusted value.
For a trusted version, use getMimeType()…
Returns the mime type as provided by the client.
This is NOT a trusted value.
For a trusted version, use getMimeType() instead.
Returns
The media type sent by the client or null if none was provided.
Implements
|
#
|
public
|
getName(): string
Retrieve the filename. This will typically be the filename sent
by the client, and should not be trusted. If the file…
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.
Returns
The filename sent by the client or null if none was provided.
Implements
|
#
|
public
|
getClientName(): string
Returns the name of the file as provided by the client during upload.
Returns the name of the file as provided by the client during upload.
|
#
|
public
|
getTempName(): string
Gets the temporary filename where the file was uploaded to.
Gets the temporary filename where the file was uploaded to.
Implements
|
#
|
public
|
getExtension(): string
Overrides SPLFileInfo's to work with uploaded files, since
the temp file that's been uploaded doesn't have an extension.
Overrides SPLFileInfo's to work with uploaded files, since
the temp file that's been uploaded doesn't have an extension.
This method tries to guess the extension from the files mime
type but will return the clientExtension if it fails to do so.
This method will always return a more or less helpfull extension
but might be insecure if the mime type is not matched. Consider
using guessExtension for a more safe version.
Overrides
|
#
|
public
|
guessExtension(): string
Attempts to determine the best file extension from the file's
mime type. In contrast to getExtension, this method will…
Attempts to determine the best file extension from the file's
mime type. In contrast to getExtension, this method will return
an empty string if it fails to determine an extension instead of
falling back to the unsecure clientExtension.
Overrides
|
#
|
public
|
getClientExtension(): string
Returns the original file extension, based on the file name that
was uploaded. This is NOT a trusted source.
For a…
Returns the original file extension, based on the file name that
was uploaded. This is NOT a trusted source.
For a trusted version, use guessExtension() instead.
Implements
|
#
|
public
|
isValid(): bool
Returns whether the file was uploaded successfully, based on whether
it was uploaded via HTTP and has no errors.
Returns whether the file was uploaded successfully, based on whether
it was uploaded via HTTP and has no errors.
Implements
|
#
|
public
|
store(string $folderName = null, string $fileName = null): string
Save the uploaded file to a new location.
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.
Parameters
| $folderName |
the folder name to writable/uploads directory.
|
| $fileName |
the name to rename the file to.
|
Returns
|
#
|