symfony/tests/Symfony/Tests/Component/EventDispatcher/EventDispatcherTest.php

<?php

/*
 * This file is part of the Symfony package.
 * (c) Fabien Potencier <fabien.potencier@symfony-project.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Symfony\Tests\Component\EventDispatcher;

use Symfony\Component\EventDispatcher\Event;
use Symfony\Component\EventDispatcher\EventDispatcher;

class EventDispatcherTest extends \PHPUnit_Framework_TestCase
{
    public function testConnectAndDisconnect()
    {
        $dispatcher = new EventDispatcher();

        $dispatcher->connect('bar', 'listenToBar');
        $this->assertEquals(array('listenToBar'), $dispatcher->getListeners('bar'), '->connect() connects a listener to an event name');
        $dispatcher->connect('bar', 'listenToBarBar');
        $this->assertEquals(array('listenToBar', 'listenToBarBar'), $dispatcher->getListeners('bar'), '->connect() can connect several listeners for the same event name');

        $dispatcher->connect('barbar', 'listenToBarBar');
        $dispatcher->disconnect('bar', 'listenToBarBar');
        $this->assertEquals(array('listenToBar'), $dispatcher->getListeners('bar'), '->disconnect() disconnects a listener for an event name');
        $this->assertEquals(array('listenToBarBar'), $dispatcher->getListeners('barbar'), '->disconnect() disconnects a listener for an event name');

        $this->assertFalse($dispatcher->disconnect('foobar', 'listen'), '->disconnect() returns false if the listener does not exist');

        $dispatcher->disconnect('bar');
        $this->assertEquals(array(), $dispatcher->getListeners('bar'), '->disconnect() without a listener disconnects all listeners of for an event name');
        $this->assertEquals(array('listenToBarBar'), $dispatcher->getListeners('barbar'), '->disconnect() without a listener disconnects all listeners of for an event name');
    }

    public function testGetHasListeners()
    {
        $dispatcher = new EventDispatcher();

        $this->assertFalse($dispatcher->hasListeners('foo'), '->hasListeners() returns false if the event has no listener');
        $dispatcher->connect('foo', 'listenToFoo');
        $this->assertEquals(true, $dispatcher->hasListeners('foo'), '->hasListeners() returns true if the event has some listeners');
        $dispatcher->disconnect('foo', 'listenToFoo');
        $this->assertFalse($dispatcher->hasListeners('foo'), '->hasListeners() returns false if the event has no listener');

        $dispatcher->connect('bar', 'listenToBar');
        $this->assertEquals(array('listenToBar'), $dispatcher->getListeners('bar'), '->getListeners() returns an array of listeners connected to the given event name');
        $this->assertEquals(array(), $dispatcher->getListeners('foobar'), '->getListeners() returns an empty array if no listener are connected to the given event name');
    }

    public function testNotify()
    {
        $listener = new Listener();
        $dispatcher = new EventDispatcher();
        $dispatcher->connect('foo', array($listener, 'listenToFoo'));
        $dispatcher->connect('foo', array($listener, 'listenToFooBis'));
        $e = $dispatcher->notify($event = new Event(new \stdClass(), 'foo'));
        $this->assertEquals('listenToFoolistenToFooBis', $listener->getValue(), '->notify() notifies all registered listeners in order');
        $this->assertEquals($event, $e, '->notify() returns the event object');

        $listener->reset();
        $dispatcher = new EventDispatcher();
        $dispatcher->connect('foo', array($listener, 'listenToFooBis'));
        $dispatcher->connect('foo', array($listener, 'listenToFoo'));
        $dispatcher->notify(new Event(new \stdClass(), 'foo'));
        $this->assertEquals('listenToFooBislistenToFoo', $listener->getValue(), '->notify() notifies all registered listeners in order');
    }

    public function testNotifyUntil()
    {
        $listener = new Listener();
        $dispatcher = new EventDispatcher();
        $dispatcher->connect('foo', array($listener, 'listenToFoo'));
        $dispatcher->connect('foo', array($listener, 'listenToFooBis'));
        $e = $dispatcher->notifyUntil($event = new Event(new \stdClass(), 'foo'));
        $this->assertEquals('listenToFoolistenToFooBis', $listener->getValue(), '->notifyUntil() notifies all registered listeners in order and stops if it returns true');
        $this->assertEquals($event, $e, '->notifyUntil() returns the event object');

        $listener->reset();
        $dispatcher = new EventDispatcher();
        $dispatcher->connect('foo', array($listener, 'listenToFooBis'));
        $dispatcher->connect('foo', array($listener, 'listenToFoo'));
        $e = $dispatcher->notifyUntil($event = new Event(new \stdClass(), 'foo'));
        $this->assertEquals('listenToFooBis', $listener->getValue(), '->notifyUntil() notifies all registered listeners in order and stops if it returns true');
    }

    public function testFilter()
    {
        $listener = new Listener();
        $dispatcher = new EventDispatcher();
        $dispatcher->connect('foo', array($listener, 'filterFoo'));
        $dispatcher->connect('foo', array($listener, 'filterFooBis'));
        $e = $dispatcher->filter($event = new Event(new \stdClass(), 'foo'), 'foo');
        $this->assertEquals('-*foo*-', $e->getReturnValue(), '->filter() filters a value');
        $this->assertEquals($event, $e, '->filter() returns the event object');

        $listener->reset();
        $dispatcher = new EventDispatcher();
        $dispatcher->connect('foo', array($listener, 'filterFooBis'));
        $dispatcher->connect('foo', array($listener, 'filterFoo'));
        $e = $dispatcher->filter($event = new Event(new \stdClass(), 'foo'), 'foo');
        $this->assertEquals('*-foo-*', $e->getReturnValue(), '->filter() filters a value');
    }
}

class Listener
{
    protected
        $value = '';

    function filterFoo(Event $event, $foo)
    {
        return "*$foo*";
    }

    function filterFooBis(Event $event, $foo)
    {
        return "-$foo-";
    }

    function listenToFoo(Event $event)
    {
        $this->value .= 'listenToFoo';
    }

    function listenToFooBis(Event $event)
    {
        $this->value .= 'listenToFooBis';

        return true;
    }

    function getValue()
    {
        return $this->value;
    }

    function reset()
    {
        $this->value = '';
    }
}