LocateUploadedFilesEvent

Type
Class
Namespace
craft\events
Inherits
craft\events\LocateUploadedFilesEvent » yii\base\Event (opens new window) » yii\base\BaseObject (opens new window)
Implements
yii\base\Configurable (opens new window)
Since
4.0.2

LocateUploadedFilesEvent event class.

View source (opens new window)

# Public Properties

Property Description
data (opens new window) mixed – The data that is passed to yii\base\Component::on() (opens new window) when attaching an event handler.
element craft\base\ElementInterface – The element being saved
files array (opens new window) – List of files being uploaded for the field.
handled (opens new window) boolean (opens new window) – Whether the event is handled.
name (opens new window) string (opens new window) – The event name.
sender (opens new window) object (opens new window) – The sender of this event.

# element

Type
craft\base\ElementInterface
Default value
null

The element being saved

View source (opens new window)

# files

Type
array (opens new window)
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, or upload)
  • filename – The filename the asset should have once saved
  • data – The file data string, if type is data
  • path – The path to the temp file, if type is file or upload

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.

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 the value of an object property.
__isset() (opens new window) Checks if a property is set, i.e. defined and not null.
__set() (opens new window) Sets value of an object property.
__unset() (opens new window) Sets an object property to null.
canGetProperty() (opens new window) Returns a value indicating whether a property can be read.
canSetProperty() (opens new window) Returns a value indicating whether a property can be set.
className() (opens new window) Returns the fully qualified name of this class.
hasHandlers() (opens new window) Returns a value indicating whether there is any handler attached to the specified class-level event.
hasMethod() (opens new window) Returns a value indicating whether a method is defined.
hasProperty() (opens new window) Returns a value indicating whether a property is defined.
init() (opens new window) Initializes the object.
off() (opens new window) Detaches an event handler from a class-level event.
offAll() (opens new window) Detaches all registered class-level event handlers.
on() (opens new window) Attaches an event handler to a class-level event.
trigger() (opens new window) Triggers a class-level event.