Event ​
- Type
- Class
- Namespace
- craft\base
- Inherits
- craft\base\Event » yii\base\Event » yii\base\BaseObject
- Implements
- yii\base\Configurable
- Extended by
- craft\events\AssetBundleEvent, craft\events\AssetEvent, craft\events\AssetPreviewEvent, craft\events\AuthenticateUserEvent, craft\events\AuthorizationCheckEvent, craft\events\BackupEvent, craft\events\BulkElementsEvent, craft\events\BulkOpEvent, craft\events\CancelableEvent, craft\events\CategoryGroupEvent, craft\events\ConfigEvent, craft\events\CreateElementCheckEvent, craft\events\CreateFieldLayoutFormEvent, craft\events\CreateTwigEvent, craft\events\DefineAddressFieldLabelEvent, craft\events\DefineAddressFieldsEvent, craft\events\DefineAddressSubdivisionsEvent, craft\events\DefineAssetThumbUrlEvent, craft\events\DefineAssetUrlEvent, craft\events\DefineAttributeHtmlEvent, craft\events\DefineAttributeKeywordsEvent, craft\events\DefineBehaviorsEvent, craft\events\DefineCompatibleFieldTypesEvent, craft\events\DefineConsoleActionsEvent, craft\events\DefineEagerLoadingMapEvent, craft\events\DefineEditUserScreensEvent, craft\events\DefineElementEditorHtmlEvent, craft\events\DefineElementHtmlEvent, craft\events\DefineElementInnerHtmlEvent, craft\events\DefineEntryTypesEvent, craft\events\DefineEntryTypesForFieldEvent, craft\events\DefineFieldHtmlEvent, craft\events\DefineFieldKeywordsEvent, craft\events\DefineFieldLayoutCustomFieldsEvent, craft\events\DefineFieldLayoutElementsEvent, craft\events\DefineFieldLayoutFieldsEvent, craft\events\DefineFieldsEvent, craft\events\DefineGqlTypeFieldsEvent, craft\events\DefineGqlValidationRulesEvent, craft\events\DefineHtmlEvent, craft\events\DefineInputOptionsEvent, craft\events\DefineMenuItemsEvent, craft\events\DefineMetadataEvent, craft\events\DefineRulesEvent, craft\events\DefineShowFieldLayoutComponentInFormEvent, craft\events\DefineSourceSortOptionsEvent, craft\events\DefineSourceTableAttributesEvent, craft\events\DefineUrlEvent, craft\events\DefineUserContentSummaryEvent, craft\events\DefineUserGroupsEvent, craft\events\DefineValueEvent, craft\events\DeleteElementEvent, craft\events\DeleteSiteEvent, craft\events\DeleteTemplateCachesEvent, craft\events\DraftEvent, craft\events\DuplicateNestedElementsEvent, craft\events\EagerLoadElementsEvent, craft\events\EditionChangeEvent, craft\events\ElementActionEvent, craft\events\ElementContentEvent, craft\events\ElementCriteriaEvent, craft\events\ElementEvent, craft\events\ElementIndexTableAttributeEvent, craft\events\ElementQueryEvent, craft\events\EntryTypeEvent, craft\events\ErrorEvent, craft\events\ExceptionEvent, craft\events\ExecuteGqlQueryEvent, craft\events\FieldEvent, craft\events\FieldLayoutEvent, craft\events\FindLoginUserEvent, craft\events\FormActionsEvent, craft\events\FsEvent, craft\events\GenerateTransformEvent, craft\events\GlobalSetEvent, craft\events\ImageTransformEvent, craft\events\ImageTransformerOperationEvent, craft\events\IndexKeywordsEvent, craft\events\InvalidUserTokenEvent, craft\events\InvalidateElementCachesEvent, craft\events\ListVolumesEvent, craft\events\LocateUploadedFilesEvent, craft\events\LoginFailureEvent, craft\events\MergeElementsEvent, craft\events\MoveElementEvent, craft\events\MoveEntryEvent, craft\events\MultiElementActionEvent, craft\events\MutationPopulateElementEvent, craft\events\PluginEvent, craft\events\PopulateElementEvent, craft\events\PopulateElementsEvent, craft\events\RebuildConfigEvent, craft\events\RegisterAssetFileKindsEvent, craft\events\RegisterCacheOptionsEvent, craft\events\RegisterComponentTypesEvent, craft\events\RegisterConditionRulesEvent, craft\events\RegisterCpAlertsEvent, craft\events\RegisterCpNavItemsEvent, craft\events\RegisterCpSettingsEvent, craft\events\RegisterElementActionsEvent, craft\events\RegisterElementDefaultTableAttributesEvent, craft\events\RegisterElementExportersEvent, craft\events\RegisterElementFieldLayoutsEvent, craft\events\RegisterElementHtmlAttributesEvent, craft\events\RegisterElementSearchableAttributesEvent, craft\events\RegisterElementSortOptionsEvent, craft\events\RegisterElementSourcesEvent, craft\events\RegisterElementTableAttributesEvent, craft\events\RegisterEmailMessagesEvent, craft\events\RegisterGqlArgumentHandlersEvent, craft\events\RegisterGqlDirectivesEvent, craft\events\RegisterGqlEagerLoadableFields, craft\events\RegisterGqlMutationsEvent, craft\events\RegisterGqlQueriesEvent, craft\events\RegisterGqlSchemaComponentsEvent, craft\events\RegisterGqlTypesEvent, craft\events\RegisterMigratorEvent, craft\events\RegisterPreviewTargetsEvent, craft\events\RegisterTemplateRootsEvent, craft\events\RegisterUrlRulesEvent, craft\events\RegisterUserPermissionsEvent, craft\events\ReorderSitesEvent, craft\events\ReplaceAssetEvent, craft\events\ResolveResourcePathEvent, craft\events\RestoreEvent, craft\events\RevisionEvent, craft\events\RouteEvent, craft\events\SearchEvent, craft\events\SectionEvent, craft\events\SetAssetFilenameEvent, craft\events\SetEagerLoadedElementsEvent, craft\events\SetElementRouteEvent, craft\events\SiteEvent, craft\events\SiteGroupEvent, craft\events\SsoEvent, craft\events\TagGroupEvent, craft\events\TemplateEvent, craft\events\TransformImageEvent, craft\events\UserAssignGroupEvent, craft\events\UserEvent, craft\events\UserGroupEvent, craft\events\UserGroupPermissionsEvent, craft\events\UserGroupsAssignEvent, craft\events\UserPermissionsEvent, craft\events\UserPhotoEvent, craft\events\VolumeEvent, craft\events\WidgetEvent
- Since
- 4.4.0
ElementTrait implements the common methods and properties for element classes.
Public Properties ​
Property | Description |
---|---|
data | mixed – The data that is passed to yii\base\Component::on() when attaching an event handler. |
handled | boolean – Whether the event is handled. |
name | string – The event name. |
sender | object, null – The sender of this event. |
Public Methods ​
Method | Description |
---|---|
__call() | Calls the named method which is not a class method. |
__construct() | |
__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. |
once() | Attaches an event handler to a class-level event, which will be triggered at most one time. |
trigger() | Triggers a class-level event. |
__construct()
​
Arguments ​
$config
once()
​
Attaches an event handler to a class-level event, which will be triggered at most one time.
See also on()View source
Arguments ​
$class
(string) – The fully qualified class name to which the event handler needs to attach.$name
(string) – The event name.$handler
(callable) – The event handler.$data
(mixed
) – The data to be passed to the event handler when the event is triggered. When the event handler is invoked, this data can be accessed via yii\base\Event::$data.$append
(boolean) – Whether to append new event handler to the end of the existing handler list. Iffalse
, the new handler will be inserted at the beginning of the existing handler list.