BlockTypesEvent

Type
Class
Namespace
craft\events
Inherits
craft\events\BlockTypesEvent » yii\base\Event » yii\base\BaseObject
Implements
yii\base\Configurable
Since
3.1.27

Matrix block types event class.

View source

Public Properties

PropertyDescription
blockTypescraft\models\MatrixBlockType[] – The block types that will be available for the current field
datamixed – The data that is passed to \craft\events\Component::on() when attaching an event handler.
elementcraft\base\ElementInterface, null – The element that the field is generating an input for.
handledboolean – Whether the event is handled.
namestring – The event name.
senderobject – The sender of this event.
valuecraft\elements\MatrixBlock[] – The current value of the field.

blockTypes

Type
craft\models\MatrixBlockType[]

The block types that will be available for the current field

View source

element

Type
craft\base\ElementInterface, null

The element that the field is generating an input for.

View source

value

Type
craft\elements\MatrixBlock[]

The current value of the field.

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.