EventEmitter
Adds system event related features to any class.

 trait System\Traits\EventEmitter

Methods

public fireSystemEvent (string $event, array $params = `[]`, boolean $halt = `true`) : mixed

Fires a combination of local and global events. The first segment is removed from the event name locally and the local object is passed as the first argument to the event globally. Halting is also enabled by default.

For example:

$this->fireSystemEvent('backend.list.myEvent', ['my value']);

Is equivalent to:

$this->fireEvent('list.myEvent', ['myvalue'], true);

Event::fire('backend.list.myEvent', [$this, 'myvalue'], true);

Parameters

Property	Type	Description
$event	string	string Event name
$params	array	array Event parameters
$halt	boolean	boolean Halt after first non-null result

Returns

mixed

public fireViewEvent (string $event, array $params = `[]`) : string

Special event function used for extending within view files, allowing HTML to be injected multiple times.

For example:

= $this->fireViewEvent('backend.auth.extendSigninView') ?>

Parameters

Property	Type	Description
$event	string	string Event name
$params	array	array Event parameters

Returns

string

Used by

Class	Description
`EventLogs`	Event Logs controller
`MailBrandSettings`	Mail brand customization controller
`MailLayouts`	Mail layouts controller
`MailPartials`	Mail partials controller
`MailTemplates`	Mail templates controller
`RequestLogs`	Request Logs controller
`Settings`	Settings controller
`Updates`	Updates controller
`Status`	System status report widget.
`Controller`	The Backend base controller class, used by Backend controllers.
`FormWidgetBase`	Form Widget base class Widgets used specifically for forms
`ReportWidgetBase`	Report Widget base class Report widgets are used inside the ReportContainer.
`WidgetBase`	Widget base class.
`AccessLogs`	Access Logs controller
`Auth`	Authentication controller
`Files`	Backend files controller
`Index`	Dashboard controller
`Media`	Backend Media Manager
`Preferences`	Editor Settings controller
`UserGroups`	Backend user groups controller
`UserRoles`	Backend user groups controller
`Users`	Backend user controller
`CodeEditor`	Code Editor Renders a code editor field.
`ColorPicker`	Color picker Renders a color picker field.
`DataTable`	Data Table Renders a table field.
`DatePicker`	Date picker Renders a date picker field.
`FileUpload`	File upload field Renders a form file uploader field.
`IconPicker`	Icon picker Renders an icon picker field.
`MarkdownEditor`	Code Editor Renders a code editor field.
`MediaFinder`	Media Finder Renders a record finder field.
`NestedForm`	Nested Form Renders a nested form bound to a jsonable field of a model.
`PermissionEditor`	User/group permission editor This widget is used by the system internally on the System / Administrators pages.
`RecordFinder`	Record Finder Renders a record finder field.
`Relation`	Form Relationship Renders a field prepopulated with a belongsTo and belongsToHasMany relation.
`RelationManager`
`Repeater`	Repeater Form Widget
`RichEditor`	Rich Editor Renders a rich content editor field.
`Sensitive`	Sensitive widget.
`TagList`	Tag List Form Widget
`Welcome`	User welcome report widget.
`Filter`	Filter Widget Renders a container used for filtering things.
`Form`	Form Widget Used for building back end forms and renders a form.
`Lists`	List Widget Used for building back end lists, renders a list of model objects
`MediaManager`	Media Manager widget.
`ReportContainer`	Report Container Widget Creates an area hosting report widgets.
`Search`	Search Widget Used for building a toolbar, Renders a search container.
`Table`	Table Widget.
`Toolbar`	Toolbar Widget Used for building a toolbar, renders a toolbar.
`ComponentBase`	Component base class
`Controller`	The CMS controller class.
`Resources`	Resources component
`SoftComponent`
`UnknownComponent`
`ViewBag`	The view bag stores custom template properties.
`Index`	CMS index
`Media`	CMS Media Manager
`ThemeLogs`	Request Logs controller
`ThemeOptions`	Theme customization controller
`Themes`	Theme selector controller
`Components`	Component Builder Builds a collection of Cms components and configures them.
`MediaFinder`	Media Finder Renders a record finder field.
`ActiveTheme`	Active theme report widget.
`AssetList`	CMS asset list widget.
`ComponentList`	Component list widget.
`MediaManager`	Media Manager widget.
`TemplateList`	Template list widget.

← Previous page System\Traits\ConfigMaker Next page → System\Traits\LazyOwnerAlias

EventEmitter Adds system event related features to any class.

# Methods

# public fireSystemEvent (string $event, array $params = [], boolean $halt = true) : mixed

# public fireViewEvent (string $event, array $params = []) : string

# Used by

EventEmitter
Adds system event related features to any class.

Methods

public fireSystemEvent (string $event, array $params = `[]`, boolean $halt = `true`) : mixed

public fireViewEvent (string $event, array $params = `[]`) : string

Used by