\CodeIgniter\HTTP\FilesUploadedFileInterface

__construct()

__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.

Parameters

move()

move(string  $targetPath, string  $name = null) 

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

Throws

\InvalidArgumentException

if the $path specified is invalid.

\RuntimeException

on any error during the move operation.

\RuntimeException

on the second or subsequent call to the method.

hasMoved()

hasMoved() : boolean

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.

Returns

getError()

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.

Returns

One of PHP's UPLOAD_ERR_XXX constants.

getName()

getName() : string|null

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.

Returns

The filename sent by the client or null if none was provided.

getTempName()

getTempName() : string

Gets the temporary filename where the file was uploaded to.

Returns

getClientExtension()

getClientExtension() : string|null

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.

Returns

getClientMimeType()

getClientMimeType() : string|null

Returns the mime type as provided by the client.

This is NOT a trusted value. For a trusted version, use getMimeType() instead.

Returns

isValid()

isValid() : boolean

Returns whether the file was uploaded successfully, based on whether it was uploaded via HTTP and has no errors.

Returns

getDestination()

getDestination(string  $destination, string  $delimiter = '_', integer  $i) : string

Returns the destination path for the move operation where overwriting is not expected.

First, it checks whether the delimiter is present in the filename, if it is, then it checks whether the last element is an integer as there may be cases that the delimiter may be present in the filename. For the all other cases, it appends an integer starting from zero before the file's extension.

Parameters

Returns