LocateUploadedFilesEvent ​
- Type
- Class
- Namespace
- craft\events
- Inherits
- craft\events\LocateUploadedFilesEvent » craft\base\Event » yii\base\Event » yii\base\BaseObject
- Implements
- yii\base\Configurable
- Since
- 4.0.2
LocateUploadedFilesEvent event class.
Public Properties ​
Property | Description |
---|---|
data | mixed – The data that is passed to yii\base\Component::on() when attaching an event handler. |
element | craft\base\ElementInterface – The element being saved |
files | array – List of files being uploaded for the field. |
handled | boolean – Whether the event is handled. |
name | string – The event name. |
sender | object, null – The sender of this event. |
element
​
- Type
- craft\base\ElementInterface
- Default value
null
The element being saved
files
​
- Type
- array
- Default value
null
List of files being uploaded for the field.
Each file should be represented as an array with the following keys:
type
– The upload time (data
,file
, orupload
)filename
– The filename the asset should have once saveddata
– The file data string, iftype
isdata
path
– The path to the temp file, iftype
isfile
orupload
Only set type
to upload
if the temp file is located within the temp uploads directory, and the file is referenced in $_FILES
. Otherwise, use file
.
Public Methods ​
Method | Description |
---|---|
__call() | Calls the named method which is not a class method. |
__construct() | |
__get() | Returns the value of an object property. |
__isset() | Checks if a property is set, i.e. defined and not null. |
__set() | Sets value of an object property. |
__unset() | Sets an object property to null. |
canGetProperty() | Returns a value indicating whether a property can be read. |
canSetProperty() | Returns a value indicating whether a property can be set. |
className() | Returns the fully qualified name of this class. |
hasHandlers() | Returns a value indicating whether there is any handler attached to the specified class-level event. |
hasMethod() | Returns a value indicating whether a method is defined. |
hasProperty() | Returns a value indicating whether a property is defined. |
init() | Initializes the object. |
off() | Detaches an event handler from a class-level event. |
offAll() | Detaches all registered class-level event handlers. |
on() | Attaches an event handler to a class-level event. |
once() | Attaches an event handler to a class-level event, which will be triggered at most one time. |
trigger() | Triggers a class-level event. |