GuzzleHttp\Psr7\UploadedFile Class Reference

Inheritance diagram for GuzzleHttp\Psr7\UploadedFile:

Collaboration diagram for GuzzleHttp\Psr7\UploadedFile:

Public Member Functions
	__construct ( $streamOrFile, $size, $errorStatus, $clientFilename=null, $clientMediaType=null)
	isMoved ()
	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. Returns StreamInterface Stream representation of the uploaded file. Exceptions } More...
	moveTo ($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. See also http://php.net/is_uploaded_file http://php.net/move_uploaded_file Parameters string $targetPath Path to which to move the uploaded file. Exceptions } More...
	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. Returns int|null The file size in bytes or null if unknown. } More...
	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. See also http://php.net/manual/en/features.file-upload.errors.php Returns int One of PHP's UPLOAD_ERR_XXX constants. } More...
	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. Returns string|null The filename sent by the client or null if none was provided. } More...
	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. Returns string|null The media type sent by the client or null if none was provided. } More...

Private Member Functions
	setStreamOrFile ($streamOrFile)
	Depending on the value set file or stream variable. More...
	setError ($error)
	setSize ($size)
	isStringOrNull ($param)
	isStringNotEmpty ($param)
	setClientFilename ($clientFilename)
	setClientMediaType ($clientMediaType)
	isOk ()
	Return true if there is no upload error. More...
	validateActive ()

Private Attributes
	$clientFilename
	$clientMediaType
	$error
	$file
	$moved = false
	$size
	$stream

Static Private Attributes
static	$errors

Detailed Description

Definition at line 9 of file UploadedFile.php.

Constructor & Destructor Documentation

__construct()

GuzzleHttp\Psr7\UploadedFile::__construct	(		$streamOrFile,
			$size,
			$errorStatus,
			$clientFilename = null,
			$clientMediaType = null
	)

Parameters

StreamInterface | string | resource	$streamOrFile
int	$size
int	$errorStatus
string | null	$clientFilename
string | null	$clientMediaType

Definition at line 67 of file UploadedFile.php.

References GuzzleHttp\Psr7\UploadedFile\$clientFilename, GuzzleHttp\Psr7\UploadedFile\$clientMediaType, GuzzleHttp\Psr7\UploadedFile\$size, GuzzleHttp\Psr7\UploadedFile\isOk(), GuzzleHttp\Psr7\UploadedFile\setClientFilename(), GuzzleHttp\Psr7\UploadedFile\setClientMediaType(), GuzzleHttp\Psr7\UploadedFile\setError(), GuzzleHttp\Psr7\UploadedFile\setSize(), and GuzzleHttp\Psr7\UploadedFile\setStreamOrFile().

      {
        $this->setError($errorStatus);
        $this->setSize($size);
        $this->setClientFilename($clientFilename);
        $this->setClientMediaType($clientMediaType);

        if ($this->isOk()) {
            $this->setStreamOrFile($streamOrFile);
        }
    }

Here is the call graph for this function:

Member Function Documentation

getClientFilename()

GuzzleHttp\Psr7\UploadedFile::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.

Returns

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

}

Returns

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

Implements Psr\Http\Message\UploadedFileInterface.

Definition at line 304 of file UploadedFile.php.

References GuzzleHttp\Psr7\UploadedFile\$clientFilename.

    {
        return $this->clientFilename;
    }

getClientMediaType()

GuzzleHttp\Psr7\UploadedFile::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.

Returns

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

}

Implements Psr\Http\Message\UploadedFileInterface.

Definition at line 312 of file UploadedFile.php.

References GuzzleHttp\Psr7\UploadedFile\$clientMediaType.

    {
        return $this->clientMediaType;
    }

getError()

GuzzleHttp\Psr7\UploadedFile::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.

See also

http://php.net/manual/en/features.file-upload.errors.php

Returns

int One of PHP's UPLOAD_ERR_XXX constants.

}

See also

http://php.net/manual/en/features.file-upload.errors.php

Returns

int One of PHP's UPLOAD_ERR_XXX constants.

Implements Psr\Http\Message\UploadedFileInterface.

Definition at line 293 of file UploadedFile.php.

References GuzzleHttp\Psr7\UploadedFile\$error.

    {
        return $this->error;
    }

getSize()

GuzzleHttp\Psr7\UploadedFile::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.

Returns

int|null The file size in bytes or null if unknown.

}

Returns

int|null The file size in bytes or null if unknown.

Implements Psr\Http\Message\UploadedFileInterface.

Definition at line 282 of file UploadedFile.php.

References GuzzleHttp\Psr7\UploadedFile\$size.

    {
        return $this->size;
    }

getStream()

GuzzleHttp\Psr7\UploadedFile::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.

Returns

StreamInterface Stream representation of the uploaded file.

Exceptions

}

Exceptions

RuntimeException

if the upload was not successful.

Implements Psr\Http\Message\UploadedFileInterface.

Definition at line 225 of file UploadedFile.php.

References GuzzleHttp\Psr7\UploadedFile\$stream, file, and GuzzleHttp\Psr7\UploadedFile\validateActive().

Referenced by GuzzleHttp\Psr7\UploadedFile\moveTo().

    {
        $this->validateActive();

        if ($this->stream instanceof StreamInterface) {
            return $this->stream;
        }

        return new LazyOpenStream($this->file, 'r+');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isMoved()

GuzzleHttp\Psr7\UploadedFile::isMoved

(

)

Returns

boolean

Definition at line 202 of file UploadedFile.php.

References GuzzleHttp\Psr7\UploadedFile\$moved.

Referenced by GuzzleHttp\Psr7\UploadedFile\validateActive().

    {
        return $this->moved;
    }

Here is the caller graph for this function:

isOk()

GuzzleHttp\Psr7\UploadedFile::isOk ( )

private

Return true if there is no upload error.

Returns

boolean

Definition at line 194 of file UploadedFile.php.

Referenced by GuzzleHttp\Psr7\UploadedFile\__construct(), and GuzzleHttp\Psr7\UploadedFile\validateActive().

    {
        return $this->error === UPLOAD_ERR_OK;
    }

Here is the caller graph for this function:

isStringNotEmpty()

GuzzleHttp\Psr7\UploadedFile::isStringNotEmpty (   $param )

private

Parameters

mixed

$param

Returns

boolean

Definition at line 154 of file UploadedFile.php.

Referenced by GuzzleHttp\Psr7\UploadedFile\moveTo().

    {
        return is_string($param) && false === empty($param);
    }

Here is the caller graph for this function:

isStringOrNull()

GuzzleHttp\Psr7\UploadedFile::isStringOrNull (   $param )

private

Parameters

mixed

$param

Returns

boolean

Definition at line 145 of file UploadedFile.php.

Referenced by GuzzleHttp\Psr7\UploadedFile\setClientFilename(), and GuzzleHttp\Psr7\UploadedFile\setClientMediaType().

    {
        return in_array(gettype($param), ['string', 'NULL']);
    }

Here is the caller graph for this function:

moveTo()

GuzzleHttp\Psr7\UploadedFile::moveTo

(

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

See also

http://php.net/is_uploaded_file

http://php.net/move_uploaded_file

Parameters

string

$targetPath

Path to which to move the uploaded file.

Exceptions

}

See also

http://php.net/is_uploaded_file

http://php.net/move_uploaded_file

Parameters

string

$targetPath

Path to which to move the uploaded file.

Exceptions

RuntimeException	if the upload was not successful.
InvalidArgumentException	if the $path specified is invalid.
RuntimeException	on any error during the move operation, or on the second or subsequent call to the method.

Implements Psr\Http\Message\UploadedFileInterface.

Definition at line 247 of file UploadedFile.php.

References GuzzleHttp\Psr7\copy_to_stream(), file, GuzzleHttp\Psr7\UploadedFile\getStream(), GuzzleHttp\Psr7\UploadedFile\isStringNotEmpty(), and GuzzleHttp\Psr7\UploadedFile\validateActive().

    {
        $this->validateActive();

        if (false === $this->isStringNotEmpty($targetPath)) {
            throw new InvalidArgumentException(
                'Invalid path provided for move operation; must be a non-empty string'
            );
        }

        if ($this->file) {
            $this->moved = php_sapi_name() == 'cli'
                ? rename($this->file, $targetPath)
                : move_uploaded_file($this->file, $targetPath);
        } else {
            copy_to_stream(
                $this->getStream(),
                new LazyOpenStream($targetPath, 'w')
            );

            $this->moved = true;
        }

        if (false === $this->moved) {
            throw new RuntimeException(
                sprintf('Uploaded file could not be moved to %s', $targetPath)
            );
        }
    }

Here is the call graph for this function:

setClientFilename()

GuzzleHttp\Psr7\UploadedFile::setClientFilename (   $clientFilename )

private

Parameters

string | null

$clientFilename

Exceptions

InvalidArgumentException

Definition at line 163 of file UploadedFile.php.

References GuzzleHttp\Psr7\UploadedFile\$clientFilename, and GuzzleHttp\Psr7\UploadedFile\isStringOrNull().

Referenced by GuzzleHttp\Psr7\UploadedFile\__construct().

    {
        if (false === $this->isStringOrNull($clientFilename)) {
            throw new InvalidArgumentException(
                'Upload file client filename must be a string or null'
            );
        }

        $this->clientFilename = $clientFilename;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setClientMediaType()

GuzzleHttp\Psr7\UploadedFile::setClientMediaType (   $clientMediaType )

private

Parameters

string | null

$clientMediaType

Exceptions

InvalidArgumentException

Definition at line 178 of file UploadedFile.php.

References GuzzleHttp\Psr7\UploadedFile\$clientMediaType, and GuzzleHttp\Psr7\UploadedFile\isStringOrNull().

Referenced by GuzzleHttp\Psr7\UploadedFile\__construct().

    {
        if (false === $this->isStringOrNull($clientMediaType)) {
            throw new InvalidArgumentException(
                'Upload file client media type must be a string or null'
            );
        }

        $this->clientMediaType = $clientMediaType;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setError()

GuzzleHttp\Psr7\UploadedFile::setError (   $error )

private

Parameters

int

$error

Exceptions

InvalidArgumentException

Definition at line 109 of file UploadedFile.php.

References GuzzleHttp\Psr7\UploadedFile\$error, and GuzzleHttp\Psr7\UploadedFile\$errors.

Referenced by GuzzleHttp\Psr7\UploadedFile\__construct().

    {
        if (false === is_int($error)) {
            throw new InvalidArgumentException(
                'Upload file error status must be an integer'
            );
        }

        if (false === in_array($error, UploadedFile::$errors)) {
            throw new InvalidArgumentException(
                'Invalid error status for UploadedFile'
            );
        }

        $this->error = $error;
    }

Here is the caller graph for this function:

setSize()

GuzzleHttp\Psr7\UploadedFile::setSize (   $size )

private

Parameters

int

$size

Exceptions

InvalidArgumentException

Definition at line 130 of file UploadedFile.php.

References GuzzleHttp\Psr7\UploadedFile\$size, and size.

Referenced by GuzzleHttp\Psr7\UploadedFile\__construct().

    {
        if (false === is_int($size)) {
            throw new InvalidArgumentException(
                'Upload file size must be an integer'
            );
        }

        $this->size = $size;
    }

Here is the caller graph for this function:

setStreamOrFile()

GuzzleHttp\Psr7\UploadedFile::setStreamOrFile (   $streamOrFile )

private

Depending on the value set file or stream variable.

Parameters

mixed

$streamOrFile

Exceptions

InvalidArgumentException

Definition at line 90 of file UploadedFile.php.

References file.

Referenced by GuzzleHttp\Psr7\UploadedFile\__construct().

    {
        if (is_string($streamOrFile)) {
            $this->file = $streamOrFile;
        } elseif (is_resource($streamOrFile)) {
            $this->stream = new Stream($streamOrFile);
        } elseif ($streamOrFile instanceof StreamInterface) {
            $this->stream = $streamOrFile;
        } else {
            throw new InvalidArgumentException(
                'Invalid stream or file provided for UploadedFile'
            );
        }
    }

Here is the caller graph for this function:

validateActive()

GuzzleHttp\Psr7\UploadedFile::validateActive ( )

private

Exceptions

RuntimeException

if is moved or not ok

Definition at line 210 of file UploadedFile.php.

References GuzzleHttp\Psr7\UploadedFile\isMoved(), and GuzzleHttp\Psr7\UploadedFile\isOk().

Referenced by GuzzleHttp\Psr7\UploadedFile\getStream(), and GuzzleHttp\Psr7\UploadedFile\moveTo().

    {
        if (false === $this->isOk()) {
            throw new RuntimeException('Cannot retrieve stream due to upload error');
        }

        if ($this->isMoved()) {
            throw new RuntimeException('Cannot retrieve stream after it has already been moved');
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$clientFilename

GuzzleHttp\Psr7\UploadedFile::$clientFilename

private

Definition at line 28 of file UploadedFile.php.

Referenced by GuzzleHttp\Psr7\UploadedFile\__construct(), GuzzleHttp\Psr7\UploadedFile\getClientFilename(), and GuzzleHttp\Psr7\UploadedFile\setClientFilename().

$clientMediaType

GuzzleHttp\Psr7\UploadedFile::$clientMediaType

private

Definition at line 33 of file UploadedFile.php.

Referenced by GuzzleHttp\Psr7\UploadedFile\__construct(), GuzzleHttp\Psr7\UploadedFile\getClientMediaType(), and GuzzleHttp\Psr7\UploadedFile\setClientMediaType().

$error

GuzzleHttp\Psr7\UploadedFile::$error

private

Definition at line 38 of file UploadedFile.php.

Referenced by GuzzleHttp\Psr7\UploadedFile\getError(), and GuzzleHttp\Psr7\UploadedFile\setError().

$errors

GuzzleHttp\Psr7\UploadedFile::$errors

staticprivate

Initial value:

= [
        UPLOAD_ERR_OK,
        UPLOAD_ERR_INI_SIZE,
        UPLOAD_ERR_FORM_SIZE,
        UPLOAD_ERR_PARTIAL,
        UPLOAD_ERR_NO_FILE,
        UPLOAD_ERR_NO_TMP_DIR,
        UPLOAD_ERR_CANT_WRITE,
        UPLOAD_ERR_EXTENSION,
    ]

Definition at line 14 of file UploadedFile.php.

Referenced by GuzzleHttp\Psr7\UploadedFile\setError().

$file

GuzzleHttp\Psr7\UploadedFile::$file

private

Definition at line 43 of file UploadedFile.php.

$moved

GuzzleHttp\Psr7\UploadedFile::$moved = false

private

Definition at line 48 of file UploadedFile.php.

Referenced by GuzzleHttp\Psr7\UploadedFile\isMoved().

$size

GuzzleHttp\Psr7\UploadedFile::$size

private

Definition at line 53 of file UploadedFile.php.

Referenced by GuzzleHttp\Psr7\UploadedFile\__construct(), GuzzleHttp\Psr7\UploadedFile\getSize(), and GuzzleHttp\Psr7\UploadedFile\setSize().

$stream

GuzzleHttp\Psr7\UploadedFile::$stream

private

Definition at line 58 of file UploadedFile.php.

Referenced by GuzzleHttp\Psr7\UploadedFile\getStream().

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/guzzlehttp/psr7/src/UploadedFile.php