Interface EventListenerInterface

Objects implementing this interface should declare the implementedEvents function to notify the event manager what methods should be called when an event is triggered.

Direct Implementers

Indirect Implementers

Namespace: Cake\Event
Location: Event/EventListenerInterface.php

Method Summary

  • Returns a list of events this object is implementing. When the class is registered in an event manager, each individual method will be associated with the respective event.

Method Detail

implementedEvents()source public 

implementedEvents( )

Returns a list of events this object is implementing. When the class is registered in an event manager, each individual method will be associated with the respective event.

Example:

public function implementedEvents()
 {
     return [
         'Order.complete' => 'sendEmail',
         'Article.afterBuy' => 'decrementInventory',
         'User.onRegister' => ['callable' => 'logRegistration', 'priority' => 20, 'passParams' => true]
     ];
 }

Returns

array

associative array or event key names pointing to the function that should be called in the object when the respective event is fired


© 2005–2017 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.4/class-Cake.Event.EventListenerInterface.html