Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add an interface for EventDispatcher.
Having an interface will let us not duck type on the method and instead use `instanceof`. It also lets us make typehints elsewhere in CakePHP if we need to. Refs #6689
- Loading branch information
Showing
6 changed files
with
65 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
<?php | ||
/** | ||
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org) | ||
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org) | ||
* | ||
* Licensed under The MIT License | ||
* For full copyright and license information, please see the LICENSE.txt | ||
* Redistributions of files must retain the above copyright notice. | ||
* | ||
* @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org) | ||
* @link http://cakephp.org CakePHP(tm) Project | ||
* @since 3.0.7 | ||
* @license http://www.opensource.org/licenses/mit-license.php MIT License | ||
*/ | ||
namespace Cake\Event; | ||
|
||
use Cake\Event\EventManager; | ||
|
||
/** | ||
* Objects implementing this interface can emit events. | ||
* | ||
* Objects with this interface can trigger events, and have | ||
* an event manager retrieved from them. | ||
* | ||
* The Cake\Event\EventManagerTrait lets you easily implement | ||
* this interface. | ||
*/ | ||
interface EventDispatcherInterface | ||
{ | ||
/** | ||
* Wrapper for creating and dispatching events. | ||
* | ||
* Returns a dispatched event. | ||
* | ||
* @param string $name Name of the event. | ||
* @param array|null $data Any value you wish to be transported with this event to | ||
* it can be read by listeners. | ||
* @param object|null $subject The object that this event applies to | ||
* ($this by default). | ||
* | ||
* @return \Cake\Event\Event | ||
*/ | ||
public function dispatchEvent($name, $data = null, $subject = null); | ||
|
||
/** | ||
* Returns the Cake\Event\EventManager manager instance for this object. | ||
* | ||
* You can use this instance to register any new listeners or callbacks to the | ||
* object events, or create your own events and trigger them at will. | ||
* | ||
* @param \Cake\Event\EventManager|null $eventManager the eventManager to set | ||
* @return \Cake\Event\EventManager | ||
*/ | ||
public function eventManager(EventManager $eventManager = null); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters