ConfigEvent

Type
Class
Namespace
craft\events
Inherits
craft\events\ConfigEvent » yii\base\Event » yii\base\BaseObject
Implements
yii\base\Configurable
Since
3.1.0

Config event class.

View source

Public Properties

PropertyDescription
datamixed – The data that is passed to \craft\events\Component::on() when attaching an event handler.
handledboolean – Whether the event is handled.
namestring – The event name.
newValuearray – The new config item value
oldValuearray – The old config item value
pathstring, null – The config path being processed
senderobject – The sender of this event.
tokenMatchesstring[], null – Any parts of the path that were matched by {uid} tokens.

newValue

Type
array

The new config item value

View source

oldValue

Type
array

The old config item value

View source

path

Type
string, null

The config path being processed

View source

tokenMatches

Type
string[], null

Any parts of the path that were matched by {uid} tokens. This wil be populated if the handler was registered using craft\services\ProjectConfig::registerChangeEventHandler(), or one of its shortcut methods.

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.