\CodeIgniter\EventsEvents

initialize()

initialize() 

Ensures that we have a events file ready.

on()

on(  $event_name, callable  $callback, integer  $priority = EVENT_PRIORITY_NORMAL) 

Registers an action to happen on an event. The action can be any sort of callable:

Events::on('create', 'myFunction'); // procedural function Events::on('create', ['myClass', 'myMethod']); // Class::method Events::on('create', [$myInstance, 'myMethod']); // Method on an existing instance Events::on('create', function() {}); // Closure

Parameters

trigger()

trigger(  $eventName,   $arguments) : boolean

Runs through all subscribed methods running them one at a time, until either: a) All subscribers have finished or b) a method returns false, at which point execution of subscribers stops.

Parameters

Returns

listeners()

listeners(  $event_name) : array

Returns an array of listeners for a single event. They are sorted by priority.

If the listener could not be found, returns FALSE, or TRUE if it was removed.

Parameters

Returns

removeListener()

removeListener(  $event_name, callable  $listener) : boolean

Removes a single listener from an event.

If the listener couldn't be found, returns FALSE, else TRUE if it was removed.

Parameters

Returns

removeAllListeners()

removeAllListeners(null  $event_name = null) 

Removes all listeners.

If the event_name is specified, only listeners for that event will be removed, otherwise all listeners for all events are removed.

Parameters

setFiles()

setFiles(array  $files) 

Sets the path to the file that routes are read from.

Parameters

getFiles()

getFiles() : mixed

Returns the files that were found/loaded during this request.

Returns

simulate()

simulate(boolean  $choice = true) 

Turns simulation on or off. When on, events will not be triggered, simply logged. Useful during testing when you don't actually want the tests to run.

Parameters

getPerformanceLogs()

getPerformanceLogs() : array

Getter for the performance log records.

Returns