UploadedFile

API reference › PSR bridge › http › UploadedFile

class	`yii2\extensions\psrbridge\http\UploadedFile`
Extends	`yii\web\UploadedFile` » `yii\base\BaseObject`
Implements	`yii\base\Configurable`
Source	`src/http/UploadedFile.php`

Extends Yii uploaded file handling with PSR-7 uploaded files.

Successful upload conversion detaches the PSR stream resource for Yii file handling. Failed uploads preserve their error without accessing the stream. reset() closes retained resources and clears both bridge and parent Yii caches; the bridge application invokes it before attaching each request.

Properties

Property	Type	Description	Defined by
`$_files` static	`array<string, array{name: string, tempName: string, tempResource: resource\|null, type: string, size: int, error: int, fullPath: string\|null}>`	Uploaded files cache. Default: `[]`.	`UploadedFile`
`$baseName` read-only	`string`	Original file base name.	`yii\web\UploadedFile`
`$error`	`int`	An error code describing the status of this file uploading. Default: `null`.	`yii\web\UploadedFile`
`$extension` read-only	`string`	File extension.	`yii\web\UploadedFile`
`$fullPath`	`string\|null`	The full path as submitted by the browser. Default: `null`. Available since 2.0.46.	`yii\web\UploadedFile`
`$hasError` read-only	`bool`	Whether there is an error with the uploaded file.	`yii\web\UploadedFile`
`$name`	`string`	The original name of the file being uploaded Default: `null`.	`yii\web\UploadedFile`
`$size`	`int`	The actual size of the uploaded file in bytes Default: `null`.	`yii\web\UploadedFile`
`$tempName`	`string`	The path of the uploaded file on the server. Default: `null`.	`yii\web\UploadedFile`
`$type`	`string`	The MIME-type of the uploaded file (such as “image/gif”). Default: `null`.	`yii\web\UploadedFile`

Methods

Method	Description	Defined by
`__construct()`	UploadedFile constructor.	`yii\web\UploadedFile`
`__call()`	Calls the named method which is not a class method.	`yii\base\BaseObject`
`__get()`	Returns the value of an object property.	`yii\base\BaseObject`
`__isset()`	Checks if a property is set, i.e. defined and not null.	`yii\base\BaseObject`
`__set()`	Sets value of an object property.	`yii\base\BaseObject`
`__toString()`	String output.	`yii\web\UploadedFile`
`__unset()`	Sets an object property to null.	`yii\base\BaseObject`
`canGetProperty()`	Returns a value indicating whether a property can be read.	`yii\base\BaseObject`
`canSetProperty()`	Returns a value indicating whether a property can be set.	`yii\base\BaseObject`
`className()` static	Returns the fully qualified name of this class.	`yii\base\BaseObject`
`getBaseName()`		`yii\web\UploadedFile`
`getExtension()`		`yii\web\UploadedFile`
`getHasError()`		`yii\web\UploadedFile`
`getInstance()` static	Returns the instance of the uploaded file associated with the specified model attribute.	`UploadedFile`
`getInstanceByName()` static	Returns the instance of the uploaded file for the specified input name.	`UploadedFile`
`getInstances()` static	Returns an array of uploaded file instances associated with the specified model attribute.	`UploadedFile`
`getInstancesByName()` static	Returns an array of uploaded file instances for the specified input name.	`UploadedFile`
`hasMethod()`	Returns a value indicating whether a method is defined.	`yii\base\BaseObject`
`hasProperty()`	Returns a value indicating whether a property is defined.	`yii\base\BaseObject`
`init()`	Initializes the object.	`yii\base\BaseObject`
`reset()` static	Resets the internal uploaded files cache, PSR-7 adapter state, and closes any open tempResource handles.	`UploadedFile`
`saveAs()`	Saves the uploaded file.	`yii\web\UploadedFile`
`setPsr7Adapter()` static	Sets the PSR-7 ServerRequestAdapter for file handling.	`UploadedFile`
`copyTempFile()` protected	Copy temporary file into file specified	`yii\web\UploadedFile`

Method details

getInstance()

public static function getInstance(yii\base\Model $model, string $attribute): yii2\extensions\psrbridge\http\UploadedFile|null

Returns the instance of the uploaded file associated with the specified model attribute.

Retrieves the uploaded file instance for the given model and attribute, supporting array-indexed attribute names such as ‘[1]file’ for tabular uploads or ‘file[1]’ for file arrays. The method resolves the input name using Html::getInputName() and delegates to getInstanceByName() for file lookup.

Parameters

Parameter	Type	Description
`$model`	`yii\base\Model`	Data model.
`$attribute`	`string`	Attribute name, which may contain array indexes (for example, ‘[1]file’, ‘file[1]’).

Returns

UploadedFile|null: Instance of the uploaded file, or null if no file was uploaded for the attribute.

getInstanceByName()

public static function getInstanceByName(string $name): self|null

Returns the instance of the uploaded file for the specified input name.

Parameters

Parameter	Type	Description
`$name`	`string`	Name of the file input field.

Returns

self|null: Instance of the uploaded file, or null if no file was uploaded for the name.

getInstances()

public static function getInstances(yii\base\Model $model, string $attribute): list<yii2\extensions\psrbridge\http\UploadedFile>

Returns an array of uploaded file instances associated with the specified model attribute.

Resolves the input name for the given model and attribute using Html::getInputName() and delegates to getInstancesByName() for file lookup. Supports array-indexed attribute names for tabular file uploading, such as ‘[1]file’.

Parameters

Parameter	Type	Description
`$model`	`yii\base\Model`	Data model.
`$attribute`	`string`	Attribute name, which may contain array indexes (for example, ‘[1]file’).

Returns

list<UploadedFile>: Uploaded files for the attribute.

getInstancesByName()

public static function getInstancesByName(string $name): list<yii2\extensions\psrbridge\http\UploadedFile>

Returns an array of uploaded file instances for the specified input name.

Iterates over the internal file cache and collects all uploaded files whose keys match the given input name or are prefixed with the input name followed by an opening bracket (for array-style file inputs).

Parameters

Parameter	Type	Description
`$name`	`string`	Name of the file input field or array of files.

Returns

list<UploadedFile>: Uploaded files for the input name.

reset()

public static function reset(): void

Resets the internal uploaded files cache, PSR-7 adapter state, and closes any open tempResource handles.

setPsr7Adapter()

public static function setPsr7Adapter(yii2\extensions\psrbridge\adapter\ServerRequestAdapter $adapter): void

Sets the PSR-7 ServerRequestAdapter for file handling.

Parameters

Parameter	Type	Description
`$adapter`	`yii2\extensions\psrbridge\adapter\ServerRequestAdapter`	PSR-7 adapter containing UploadedFileInterface instances.