vendor/doctrine/common/lib/Doctrine/Common/EventSubscriber.php

   1 <?php
   2 /*
   3  *  $Id: EventListener.php 4653 2008-07-10 17:17:58Z romanb $
   4  *
   5  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   6  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   7  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
   8  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
   9  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  10  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  11  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  12  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  13  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  14  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  15  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  16  *
  17  * This software consists of voluntary contributions made by many individuals
  18  * and is licensed under the MIT license. For more information, see
  19  * <http://www.doctrine-project.org>.
  20  */
  21
  22 namespace Doctrine\Common;
  23
  24 /**
  25  * An EventSubscriber knows himself what events he is interested in.
  26  * If an EventSubscriber is added to an EventManager, the manager invokes
  27  * {@link getSubscribedEvents} and registers the subscriber as a listener for all
  28  * returned events.
  29  *
  30  * @license http://www.opensource.org/licenses/lgpl-license.php LGPL
  31  * @link    www.doctrine-project.org
  32  * @since   2.0
  33  * @author  Guilherme Blanco <guilhermeblanco@hotmail.com>
  34  * @author  Jonathan Wage <jonwage@gmail.com>
  35  * @author  Roman Borschel <roman@code-factory.org>
  36  */
  37 interface EventSubscriber
  38 {
  39     /**
  40      * Returns an array of events this subscriber wants to listen to.
  41      *
  42      * @return array
  43      */
  44     function getSubscribedEvents();
  45 }