Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Fetching contributors…

Octocat-spinner-32-eaf2f5

Cannot retrieve contributors at this time

file 122 lines (110 sloc) 2.711 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
<?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\Component\EventDispatcher;

/**
* Event is the base class for classes containing event data.
*
* This class contains no event data. It is used by events that do not pass
* state information to an event handler when an event is raised.
*
* You can call the method stopPropagation() to abort the execution of
* further listeners in your event listener.
*
* @author Guilherme Blanco <guilhermeblanco@hotmail.com>
* @author Jonathan Wage <jonwage@gmail.com>
* @author Roman Borschel <roman@code-factory.org>
* @author Bernhard Schussek <bschussek@gmail.com>
*
* @api
*/
class Event
{
    /**
* @var Boolean Whether no further event listeners should be triggered
*/
    private $propagationStopped = false;

    /**
* @var EventDispatcher Dispatcher that dispatched this event
*/
    private $dispatcher;

    /**
* @var string This event's name
*/
    private $name;

    /**
* Returns whether further event listeners should be triggered.
*
* @see Event::stopPropagation
* @return Boolean Whether propagation was already stopped for this event.
*
* @api
*/
    public function isPropagationStopped()
    {
        return $this->propagationStopped;
    }

    /**
* Stops the propagation of the event to further event listeners.
*
* If multiple event listeners are connected to the same event, no
* further event listener will be triggered once any trigger calls
* stopPropagation().
*
* @api
*/
    public function stopPropagation()
    {
        $this->propagationStopped = true;
    }

    /**
* Stores the EventDispatcher that dispatches this Event
*
* @param EventDispatcher $dispatcher
*
* @api
*/
    public function setDispatcher(EventDispatcher $dispatcher)
    {
        $this->dispatcher = $dispatcher;
    }

    /**
* Returns the EventDispatcher that dispatches this Event
*
* @return EventDispatcher
*
* @api
*/
    public function getDispatcher()
    {
        return $this->dispatcher;
    }

    /**
* Gets the event's name.
*
* @return string
*
* @api
*/
    public function getName()
    {
        return $this->name;
    }

    /**
* Sets the event's name property.
*
* @param string $name The event name.
*
* @api
*/
    public function setName($name)
    {
        $this->name = $name;
    }
}
Something went wrong with that request. Please try again.