Skip to content

AuthorizationCheckEvent

Type
Class
Namespace
craft\events
Inherits
craft\events\AuthorizationCheckEvent » yii\base\Event » yii\base\BaseObject
Implements
yii\base\Configurable
Extended by
craft\events\CreateElementCheckEvent
Since
4.0.0

Authorization Check Event.

View source

Public Properties

PropertyDescription
authorizedboolean, null – Whether the user is authorized.
datamixed – The data that is passed to yii\base\Component::on() when attaching an event handler.
elementcraft\base\ElementInterface, null – The element being authorized.
handledboolean – Whether the event is handled.
namestring – The event name.
senderobject, null – The sender of this event.
usercraft\elements\User – The user to be authorized.

authorized

Type
boolean, null
Default value
false

Whether the user is authorized.

View source

element

Type
craft\base\ElementInterface, null
Default value
null
Since
4.3.0

The element being authorized.

This will only be set if the event was triggered from craft\services\Elements.

View source

user

Type
craft\elements\User
Default value
null

The user to be authorized.

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.

__construct()

Constructor

View source

Arguments