UploadedFile

Type
Class
Namespace
Craft
Inherits
Craft\UploadedFile » CUploadedFile » CComponent
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

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__construct()Constructor.
__get()Returns a property value, an event handler list or a behavior based on its name.
__isset()Checks if a property value is null.
__set()Sets value of a component property.
__toString()String output.
__unset()Sets a component property to be null.
asa()Returns the named behavior object.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
attachEventHandler()Attaches an event handler to an event.
canGetProperty()Determines whether a property can be read.
canSetProperty()Determines whether a property can be set.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
detachEventHandler()Detaches an existing event handler.
disableBehavior()Disables an attached behavior.
disableBehaviors()Disables all behaviors attached to this component.
enableBehavior()Enables an attached behavior.
enableBehaviors()Enables all behaviors attached to this component.
evaluateExpression()Evaluates a PHP expression or callback under the context of this component.
getError()Returns an error code describing the status of this file uploading.
getEventHandlers()Returns the list of attached event handlers for an event.
getExtensionName()
getHasError()
getInstance()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()Returns all uploaded files for the given model attribute.
getInstancesByName()Returns an array of instances starting with specified array name.
getName()
getSize()
getTempName()
getType()
hasEvent()Determines whether an event is defined.
hasEventHandler()Checks whether the named event has attached handlers.
hasProperty()Determines whether a property is defined.
raiseEvent()Raises an event.
reset()Cleans up the loaded CUploadedFile instances.
saveAs()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

Arguments

  • $name (string) – The name of the file input field.
  • $ensureTempFileExists (boolean) – Whether to only return the instance if its temp files still exists.

Returns

CUploadedFile, null – 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

Arguments

  • $name (string) – The name of the array of files
  • $lookForSingleInstance (boolean) – If set to true, will look for a single instance of the given name.
  • $ensureTempFilesExist (boolean) – Whether only instances whose temp files still exist should be returned.

Returns

CUploadedFile – 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

MethodDescription
collectFilesRecursive()Processes incoming files for {@link getInstanceByName}.
prefetchFiles()Initially processes $_FILES superglobal for easier use.