Skip to content

UserGroupsAssignEvent

Type
Class
Namespace
craft\events
Inherits
craft\events\UserGroupsAssignEvent » craft\events\CancelableEvent » yii\base\Event » yii\base\BaseObject
Implements
yii\base\Configurable
Since
3.0.0

User Groups assign event class.

View source

Public Properties

PropertyDescription
datamixed – The data that is passed to yii\base\Component::on() when attaching an event handler.
groupIdsinteger[] – All of the user group IDs that the user belongs to now
handledboolean – Whether the event is handled.
isValidboolean – Whether to continue performing the action that called this event
namestring – The event name.
newGroupIdsinteger[] – The user group IDs that are being added to the user
removedGroupIdsinteger[] – The user group IDs that are being removed from the user
senderobject, null – The sender of this event.
userIdinteger, null – The user ID associated with this event

groupIds

Type
integer[]
Default value
null

All of the user group IDs that the user belongs to now

View source

newGroupIds

Type
integer[]
Default value
null

The user group IDs that are being added to the user

View source

removedGroupIds

Type
integer[]
Default value
null

The user group IDs that are being removed from the user

View source

userId

Type
integer, null
Default value
null

The user ID associated with this event

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.