www.aleph1.co.uk Git - yaffs-website/blob - vendor/doctrine/common/lib/Doctrine/Common/EventSubscriber.php

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