Class Salient\Http\HttpServerRequestUpload

`implements`	`UploadedFileInterface`

A PSR-7 uploaded file (incoming, server-side)

Located at Toolkit/Http/HttpServerRequestUpload.php

Methods


					
	public

__construct(
	StreamInterface|resource|string $resource,
	?int $size = null,
	int $error = UPLOAD_ERR_OK,
	?string $clientFilename = null,
	?string $clientMediaType = null,
)

Creates a new HttpServerRequestUpload object


					
	public

getStream(): StreamInterface

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.

Returns

Stream representation of the uploaded file.

Implements

Psr\Http\Message\UploadedFileInterface::getStream()


					
	public

moveTo(string $targetPath): void

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.

Parameters

$targetPath

Path to which to move the uploaded file.

Implements

Psr\Http\Message\UploadedFileInterface::moveTo()


					
	public

getSize(): ?int

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.

Returns

The file size in bytes or null if unknown.

Implements

Psr\Http\Message\UploadedFileInterface::getSize()


					
	public

getError(): int

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

Psr\Http\Message\UploadedFileInterface::getError()


					
	public

getClientFilename(): ?string

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.

Implements

Psr\Http\Message\UploadedFileInterface::getClientFilename()


					
	public

getClientMediaType(): ?string

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.

Returns

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

Implements

Psr\Http\Message\UploadedFileInterface::getClientMediaType()

Constants
`protected`	ERROR_MESSAGE = [ UPLOAD_ERR_OK => 'There is no error, the file uploaded with success', UPLOAD_ERR_INI_SIZE => 'The uploaded file exceeds the upload_max_filesize directive in php.ini', UPLOAD_ERR_FORM_SIZE => 'The uploaded file exceeds the MAX_FILE_SIZE directive that was specified in the HTML form', UPLOAD_ERR_PARTIAL => 'The uploaded file was only partially uploaded', UPLOAD_ERR_NO_FILE => 'No file was uploaded', UPLOAD_ERR_NO_TMP_DIR => 'Missing a temporary folder', UPLOAD_ERR_CANT_WRITE => 'Failed to write file to disk', UPLOAD_ERR_EXTENSION => 'A PHP extension stopped the file upload', ]	#

Properties
`protected`	`StreamInterface`	`$Stream`	#
`protected`	`string`	`$File`	#
`protected`	`?int`	`$Size`	#
`protected`	`int`	`$Error`	#
`protected`	`?string`	`$ClientFilename`	#
`protected`	`?string`	`$ClientMediaType`	#

Namespaces

Classes

Traits

Class Salient\Http\HttpServerRequestUpload

Returns

Implements

Parameters

Implements

Returns

Implements

Returns

Implements

Returns

Implements

Returns

Implements