[DoctrineBridge] ContainerAwareEventManager class
This allows services to be registered (and lazily loaded) with Doctrine Common's EventManager.
This commit is contained in:
parent
611b241f56
commit
f15dde6c59
138
src/Symfony/Bridge/Doctrine/ContainerAwareEventManager.php
Normal file
138
src/Symfony/Bridge/Doctrine/ContainerAwareEventManager.php
Normal file
@ -0,0 +1,138 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
/*
|
||||||
|
* This file is part of the Symfony package.
|
||||||
|
*
|
||||||
|
* (c) Fabien Potencier <fabien@symfony.com>
|
||||||
|
*
|
||||||
|
* For the full copyright and license information, please view the LICENSE
|
||||||
|
* file that was distributed with this source code.
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace Symfony\Bridge\Doctrine;
|
||||||
|
|
||||||
|
use Doctrine\Common\EventArgs;
|
||||||
|
use Doctrine\Common\EventManager;
|
||||||
|
use Doctrine\Common\EventSubscriber;
|
||||||
|
use Symfony\Component\DependencyInjection\ContainerInterface;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Allows lazy loading of listener services.
|
||||||
|
*
|
||||||
|
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
|
||||||
|
*/
|
||||||
|
class ContainerAwareEventManager extends EventManager
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Map of registered listeners.
|
||||||
|
* <event> => <listeners>
|
||||||
|
*
|
||||||
|
* @var array
|
||||||
|
*/
|
||||||
|
private $listeners = array();
|
||||||
|
private $initialized = array();
|
||||||
|
private $container;
|
||||||
|
|
||||||
|
public function __construct(ContainerInterface $container)
|
||||||
|
{
|
||||||
|
$this->container = $container;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Dispatches an event to all registered listeners.
|
||||||
|
*
|
||||||
|
* @param string $eventName The name of the event to dispatch. The name of the event is
|
||||||
|
* the name of the method that is invoked on listeners.
|
||||||
|
* @param EventArgs $eventArgs The event arguments to pass to the event handlers/listeners.
|
||||||
|
* If not supplied, the single empty EventArgs instance is used.
|
||||||
|
* @return boolean
|
||||||
|
*/
|
||||||
|
public function dispatchEvent($eventName, EventArgs $eventArgs = null)
|
||||||
|
{
|
||||||
|
if (isset($this->listeners[$eventName])) {
|
||||||
|
$eventArgs = $eventArgs === null ? EventArgs::getEmptyInstance() : $eventArgs;
|
||||||
|
|
||||||
|
$initialized = isset($this->initialized[$eventName]);
|
||||||
|
|
||||||
|
foreach ($this->listeners[$eventName] as $hash => $listener) {
|
||||||
|
if (!$initialized && is_string($listener)) {
|
||||||
|
$this->listeners[$eventName][$hash] = $listener = $this->container->get($listener);
|
||||||
|
}
|
||||||
|
|
||||||
|
$listener->$eventName($eventArgs);
|
||||||
|
}
|
||||||
|
$this->initialized[$eventName] = true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the listeners of a specific event or all listeners.
|
||||||
|
*
|
||||||
|
* @param string $event The name of the event.
|
||||||
|
* @return array The event listeners for the specified event, or all event listeners.
|
||||||
|
*/
|
||||||
|
public function getListeners($event = null)
|
||||||
|
{
|
||||||
|
return $event ? $this->listeners[$event] : $this->listeners;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Checks whether an event has any registered listeners.
|
||||||
|
*
|
||||||
|
* @param string $event
|
||||||
|
* @return boolean TRUE if the specified event has any listeners, FALSE otherwise.
|
||||||
|
*/
|
||||||
|
public function hasListeners($event)
|
||||||
|
{
|
||||||
|
return isset($this->listeners[$event]) && $this->listeners[$event];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Adds an event listener that listens on the specified events.
|
||||||
|
*
|
||||||
|
* @param string|array $events The event(s) to listen on.
|
||||||
|
* @param object|string $listener The listener object.
|
||||||
|
*/
|
||||||
|
public function addEventListener($events, $listener)
|
||||||
|
{
|
||||||
|
if (is_string($listener)) {
|
||||||
|
if ($this->initialized) {
|
||||||
|
throw new \RuntimeException('Adding lazy-loading listeners after construction is not supported.');
|
||||||
|
}
|
||||||
|
|
||||||
|
$hash = '_service_'.$listener;
|
||||||
|
} else {
|
||||||
|
// Picks the hash code related to that listener
|
||||||
|
$hash = spl_object_hash($listener);
|
||||||
|
}
|
||||||
|
|
||||||
|
foreach ((array) $events as $event) {
|
||||||
|
// Overrides listener if a previous one was associated already
|
||||||
|
// Prevents duplicate listeners on same event (same instance only)
|
||||||
|
$this->listeners[$event][$hash] = $listener;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Removes an event listener from the specified events.
|
||||||
|
*
|
||||||
|
* @param string|array $events
|
||||||
|
* @param object|string $listener
|
||||||
|
*/
|
||||||
|
public function removeEventListener($events, $listener)
|
||||||
|
{
|
||||||
|
if (is_string($listener)) {
|
||||||
|
$hash = '_service_'.$listener;
|
||||||
|
} else {
|
||||||
|
// Picks the hash code related to that listener
|
||||||
|
$hash = spl_object_hash($listener);
|
||||||
|
}
|
||||||
|
|
||||||
|
foreach ((array) $events as $event) {
|
||||||
|
// Check if actually have this listener associated
|
||||||
|
if (isset($this->listeners[$event][$hash])) {
|
||||||
|
unset($this->listeners[$event][$hash]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
@ -0,0 +1,62 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
/*
|
||||||
|
* This file is part of the Symfony package.
|
||||||
|
*
|
||||||
|
* (c) Fabien Potencier <fabien@symfony.com>
|
||||||
|
*
|
||||||
|
* For the full copyright and license information, please view the LICENSE
|
||||||
|
* file that was distributed with this source code.
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace Doctrine\Bundle\DoctrineBundle\Tests;
|
||||||
|
|
||||||
|
use Symfony\Bridge\Doctrine\ContainerAwareEventManager;
|
||||||
|
use Symfony\Component\DependencyInjection\Container;
|
||||||
|
|
||||||
|
class ContainerAwareEventManagerTest extends \PHPUnit_Framework_TestCase
|
||||||
|
{
|
||||||
|
protected function setUp()
|
||||||
|
{
|
||||||
|
$this->container = new Container();
|
||||||
|
$this->evm = new ContainerAwareEventManager($this->container);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testDispatchEvent()
|
||||||
|
{
|
||||||
|
$this->container->set('foobar', $listener1 = new MyListener());
|
||||||
|
$this->evm->addEventListener('foo', 'foobar');
|
||||||
|
$this->evm->addEventListener('foo', $listener2 = new MyListener());
|
||||||
|
|
||||||
|
$this->evm->dispatchEvent('foo');
|
||||||
|
|
||||||
|
$this->assertTrue($listener1->called);
|
||||||
|
$this->assertTrue($listener2->called);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testRemoveEventListener()
|
||||||
|
{
|
||||||
|
$this->evm->addEventListener('foo', 'bar');
|
||||||
|
$this->evm->addEventListener('foo', $listener = new MyListener());
|
||||||
|
|
||||||
|
$listeners = array('foo' => array('_service_bar' => 'bar', spl_object_hash($listener) => $listener));
|
||||||
|
$this->assertSame($listeners, $this->evm->getListeners());
|
||||||
|
$this->assertSame($listeners['foo'], $this->evm->getListeners('foo'));
|
||||||
|
|
||||||
|
$this->evm->removeEventListener('foo', $listener);
|
||||||
|
$this->assertSame(array('_service_bar' => 'bar'), $this->evm->getListeners('foo'));
|
||||||
|
|
||||||
|
$this->evm->removeEventListener('foo', 'bar');
|
||||||
|
$this->assertSame(array(), $this->evm->getListeners('foo'));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
class MyListener
|
||||||
|
{
|
||||||
|
public $called = false;
|
||||||
|
|
||||||
|
public function foo()
|
||||||
|
{
|
||||||
|
$this->called = true;
|
||||||
|
}
|
||||||
|
}
|
Reference in New Issue
Block a user