Class Event

An event.

Direct known subclasses

BlueTihi\Context\LoadedNodesEvent, Brickrouge\AlterCSSClassNamesEvent, ICanBoogie\Object\PropertyEvent, ICanBoogie\Operation\BeforeProcessEvent, ICanBoogie\Operation\ControlEventBase, ICanBoogie\Operation\Dispatcher\BeforeDispatchEvent, ICanBoogie\Operation\Dispatcher\DispatchEvent, ICanBoogie\Operation\FailureEvent, ICanBoogie\Operation\GetFormEvent, ICanBoogie\Operation\ProcessEvent, ICanBoogie\Operation\ValidateEventBase, ICanBoogie\Routes\BeforeCollectEvent, ICanBoogie\ActiveRecord\CollectDependenciesEvent, ICanBoogie\Routes\CollectEvent, ICanBoogie\Routing\Dispatcher\BeforeDispatchEvent, ICanBoogie\Routing\Dispatcher\DispatchEvent, ICanBoogie\Session\StartEvent, Icybee\ConfigOperation\BeforePropertiesEvent, Icybee\ConfigOperation\PropertiesEvent, Icybee\Document\BeforeRenderMetasEvent, Icybee\Document\BeforeRenderTitleEvent, Icybee\Document\RenderMetasEvent, Icybee\Document\RenderTitleEvent, ICanBoogie\Core\BeforeRunEvent, Icybee\Element\ActionbarContextual\CollectItemsEvent, Icybee\Element\ActionbarSearch\AlterInnerHTMLEvent, Icybee\Element\ActionbarToolbar\CollectEvent, Icybee\FormBlock\AlterEvent, Icybee\ManageBlock\AlterColumnsEvent, Icybee\ManageBlock\AlterQueryEvent, Icybee\ManageBlock\AlterRenderedCellsEvent, Icybee\ManageBlock\RegisterColumnsEvent, Icybee\Modules\Cache\Collection\CollectEvent, Icybee\Modules\Editor\Collection\AlterEvent, ICanBoogie\Core\RunEvent, Icybee\Modules\Files\File\MoveEvent, Icybee\Modules\Forms\Form\AlterNotifyEvent, Icybee\Modules\Forms\Form\BeforeAlterNotifyEvent, Icybee\Modules\Forms\Form\BeforeRenderEvent, Icybee\Modules\Forms\Form\NotifyEvent, Icybee\Modules\Forms\Form\RenderEvent, Icybee\Modules\Nodes\Module\CreateDefaultRoutesEvent, Icybee\Modules\Pages\BreadcrumbElement\BeforeRenderInnerHTMLEvent, Icybee\Modules\Pages\BreadcrumbElement\RenderInnerHTMLEvent, Icybee\Modules\Pages\LanguagesElement\AlterEvent, ICanBoogie\Exception\RescueEvent, Icybee\Modules\Pages\LanguagesElement\CollectEvent, Icybee\Modules\Pages\NavigationBranchElement\AlterBlueprintEvent, Icybee\Modules\Pages\NavigationElement\AlterEvent, Icybee\Modules\Pages\Page\MoveEvent, Icybee\Modules\Pages\Page\RenderRegionEvent, Icybee\Modules\Pages\Page\RenderTitleEvent, Icybee\Modules\Pages\PageController\BeforeRenderEvent, Icybee\Modules\Pages\PageController\RenderEvent, Icybee\Modules\Views\ActiveRecordProvider\AlterEvent, Icybee\Modules\Views\Collection\CollectEvent, ICanBoogie\HTTP\Dispatcher\AlterEvent, Icybee\Modules\Views\View\BeforeRenderEvent, Icybee\Modules\Views\View\RenderEvent, Icybee\Modules\Views\View\RescueEvent, ICanBoogie\HTTP\Dispatcher\BeforeDispatchEvent, ICanBoogie\HTTP\Dispatcher\DispatchEvent, ICanBoogie\Modules\Thumbnailer\Versions\AlterEvent

Indirect known subclasses

ICanBoogie\Operation\BeforeControlEvent, ICanBoogie\Operation\BeforeValidateEvent, Icybee\EditBlock\AlterValuesEvent, Icybee\EditBlock\BeforeAlterActionsEvent, Icybee\EditBlock\BeforeAlterAttributesEvent, Icybee\EditBlock\BeforeAlterChildrenEvent, Icybee\EditBlock\BeforeAlterValuesEvent, Icybee\FormBlock\AlterActionsEvent, Icybee\FormBlock\AlterAttributesEvent, Icybee\FormBlock\AlterChildrenEvent, Icybee\FormBlock\AlterValuesEvent, Icybee\FormBlock\BeforeAlterActionsEvent, ICanBoogie\Operation\ControlEvent, Icybee\FormBlock\BeforeAlterAttributesEvent, Icybee\FormBlock\BeforeAlterChildrenEvent, Icybee\FormBlock\BeforeAlterValuesEvent, Icybee\Modules\Views\ActiveRecordProvider\AlterConditionsEvent, Icybee\Modules\Views\ActiveRecordProvider\AlterContextEvent, Icybee\Modules\Views\ActiveRecordProvider\AlterQueryEvent, Icybee\Modules\Views\ActiveRecordProvider\AlterResultEvent, Icybee\Modules\Views\ActiveRecordProvider\BeforeAlterConditionsEvent, Icybee\Modules\Views\ActiveRecordProvider\BeforeAlterContextEvent, Icybee\Modules\Views\ActiveRecordProvider\BeforeAlterQueryEvent, ICanBoogie\Operation\RescueEvent, ICanBoogie\Operation\ValidateEvent, ICanBoogie\Routing\Dispatcher\RescueEvent, Icybee\EditBlock\AlterActionsEvent, Icybee\EditBlock\AlterAttributesEvent, Icybee\EditBlock\AlterChildrenEvent, Icybee\EditBlock\AlterEvent

Namespace: ICanBoogie
Located at vendor/icanboogie/event/lib/event.php

Methods summary

`public`	# `__construct( mixed $target, string $type, array $payload = array() )` Creates an event and fires it immediately. Creates an event and fires it immediately. If the event's target is specified its class is used to prefix the event type. For example, if the event's target is an instance of `ICanBoogie\Operation` and the event type is `process` the final event type will be `ICanBoogie\Operation::process`. Parameters `$target` `mixed` $target The target of the event. `$type` `string` $type The event type. `$payload` `array` $payload Event payload. Throws `ICanBoogie\PropertyIsReserved` in attempt to specify a reserved property with the payload.
`public mixed`	# `__get( string $property )` Handles the read-only properties $stopped, $used, $used_by and $target. Handles the read-only properties $stopped, $used, $used_by and $target. Parameters `$property` `string` $property The read-only property to return. Returns `mixed` Throws `ICanBoogie\PropertyNotReadable` if the property exists but is not readable. `ICanBoogie\PropertyNotDefined` if the property doesn't exists.
`public`	# `stop( )` Stops the hooks chain. Stops the hooks chain. After the `stop()` method is called the hooks chain is broken and no other hook is called.
`public ICanBoogie\Event`	# `chain( callable $hook )` Add an event hook to the finish chain. Add an event hook to the finish chain. The finish chain is executed after the event chain was traversed without being stopped. Parameters `$hook` `callable` $hook Returns `ICanBoogie\Event`

Magic methods summary

Properties summary

`public static array`	`$profiling`	# Profiling information about events. Profiling information about events.

Magic properties

`public read-only mixed`	`$stopped`		# bool `true` when the event was stopped, `false` otherwise. bool `true` when the event was stopped, `false` otherwise.
`public read-only mixed`	`$used`		# int The number of event hooks that were invoked while dispatching the event. int The number of event hooks that were invoked while dispatching the event.
`public read-only mixed`	`$used_by`		# array Event hooks that were invoked while dispatching the event. array Event hooks that were invoked while dispatching the event.
`public read-only mixed`	`$target`		# mixed The object the event is dispatched on. mixed The object the event is dispatched on.