UploadedFile
- Type
- Class
- Namespace
- Craft
- Inherits
- Craft\UploadedFile » CUploadedFile (opens new window) » CComponent (opens new window)
- Since
- 2.0
UploadedFile represents the information for an uploaded file.
Call {@link getInstance} to retrieve the instance of an uploaded file, and then use {@link saveAs} to save it on the server. You may also query other information about the file, including {@link name}, {@link tempName}, {@link type}, {@link size} and {@link error}.
See also http://craftcms.com
View source (opens new window)
# Public Methods
| Method | Description |
|---|---|
| __call() (opens new window) | Calls the named method which is not a class method. |
| __construct() (opens new window) | Constructor. |
| __get() (opens new window) | Returns a property value, an event handler list or a behavior based on its name. |
| __isset() (opens new window) | Checks if a property value is null. |
| __set() (opens new window) | Sets value of a component property. |
| __toString() (opens new window) | String output. |
| __unset() (opens new window) | Sets a component property to be null. |
| asa() (opens new window) | Returns the named behavior object. |
| attachBehavior() (opens new window) | Attaches a behavior to this component. |
| attachBehaviors() (opens new window) | Attaches a list of behaviors to the component. |
| attachEventHandler() (opens new window) | Attaches an event handler to an event. |
| canGetProperty() (opens new window) | Determines whether a property can be read. |
| canSetProperty() (opens new window) | Determines whether a property can be set. |
| detachBehavior() (opens new window) | Detaches a behavior from the component. |
| detachBehaviors() (opens new window) | Detaches all behaviors from the component. |
| detachEventHandler() (opens new window) | Detaches an existing event handler. |
| disableBehavior() (opens new window) | Disables an attached behavior. |
| disableBehaviors() (opens new window) | Disables all behaviors attached to this component. |
| enableBehavior() (opens new window) | Enables an attached behavior. |
| enableBehaviors() (opens new window) | Enables all behaviors attached to this component. |
| evaluateExpression() (opens new window) | Evaluates a PHP expression or callback under the context of this component. |
| getError() (opens new window) | Returns an error code describing the status of this file uploading. |
| getEventHandlers() (opens new window) | Returns the list of attached event handlers for an event. |
| getExtensionName() (opens new window) | |
| getHasError() (opens new window) | |
| getInstance() (opens new window) | Returns an instance of the specified uploaded file. |
| getInstanceByName() | Returns an instance of the specified uploaded file. The name can be a plain string or a string like an array element (e.g. 'Post[imageFile]', or 'Post[0][imageFile]'). |
| getInstances() (opens new window) | Returns all uploaded files for the given model attribute. |
| getInstancesByName() | Returns an array of instances starting with specified array name. |
| getName() (opens new window) | |
| getSize() (opens new window) | |
| getTempName() (opens new window) | |
| getType() (opens new window) | |
| hasEvent() (opens new window) | Determines whether an event is defined. |
| hasEventHandler() (opens new window) | Checks whether the named event has attached handlers. |
| hasProperty() (opens new window) | Determines whether a property is defined. |
| raiseEvent() (opens new window) | Raises an event. |
| reset() (opens new window) | Cleans up the loaded CUploadedFile instances. |
| saveAs() (opens new window) | Saves the uploaded file. |
# getInstanceByName()
Returns an instance of the specified uploaded file. The name can be a plain string or a string like an array element (e.g. 'Post[imageFile]', or 'Post[0][imageFile]').
View source (opens new window)
Arguments
$name(string (opens new window)) – The name of the file input field.$ensureTempFileExists(boolean (opens new window)) – Whether to only return the instance if its temp files still exists.
Returns
CUploadedFile (opens new window), null (opens new window) – The instance of the uploaded file. null is returned if no file is uploaded for the specified name.
Signature
public static CUploadedFile, null getInstanceByName ( $name, $ensureTempFileExists = true )
# getInstancesByName()
Returns an array of instances starting with specified array name. If multiple files were uploaded and saved as 'Files[0]', 'Files[1]', 'Files[n]'..., you can have them all by passing 'Files' as array name.
View source (opens new window)
Arguments
$name(string (opens new window)) – The name of the array of files$lookForSingleInstance(boolean (opens new window)) – If set to true, will look for a single instance of the given name.$ensureTempFilesExist(boolean (opens new window)) – Whether only instances whose temp files still exist should be returned.
Returns
CUploadedFile (opens new window) – The array of UploadedFile objects. Empty array is returned if no adequate upload was found. Please note that this array will contain all files from all subarrays regardless how deeply nested they are.
Signature
public static CUploadedFile getInstancesByName ( $name, $lookForSingleInstance = true, $ensureTempFilesExist = true )
# Protected Methods
| Method | Description |
|---|---|
| collectFilesRecursive() (opens new window) | Processes incoming files for {@link getInstanceByName}. |
| prefetchFiles() (opens new window) | Initially processes $_FILES superglobal for easier use. |