Skip to content

LocateUploadedFilesEvent

Type
Class
Namespace
craft\events
Inherits
craft\events\LocateUploadedFilesEvent » yii\base\Event » yii\base\BaseObject
Implements
yii\base\Configurable
Since
4.0.2

LocateUploadedFilesEvent event class.

View source

Public Properties

PropertyDescription
datamixed – The data that is passed to yii\base\Component::on() when attaching an event handler.
elementcraft\base\ElementInterface – The element being saved
filesarray – List of files being uploaded for the field.
handledboolean – Whether the event is handled.
namestring – The event name.
senderobject, null – The sender of this event.

element

Type
craft\base\ElementInterface
Default value
null

The element being saved

View source

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, 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

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__construct()Constructor.
__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.
trigger()Triggers a class-level event.