www.aleph1.co.uk Git - yaffs-website/blob - vendor/doctrine/common/lib/Doctrine/Common/EventArgs.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  * EventArgs is the base class for classes containing event data.
  24  *
  25  * This class contains no event data. It is used by events that do not pass state
  26  * information to an event handler when an event is raised. The single empty EventArgs
  27  * instance can be obtained through {@link getEmptyInstance}.
  28  *
  29  * @link   www.doctrine-project.org
  30  * @since  2.0
  31  * @author Guilherme Blanco <guilhermeblanco@hotmail.com>
  32  * @author Jonathan Wage <jonwage@gmail.com>
  33  * @author Roman Borschel <roman@code-factory.org>
  34  */
  35 class EventArgs
  36 {
  37     /**
  38      * Single instance of EventArgs.
  39      *
  40      * @var EventArgs
  41      */
  42     private static $_emptyEventArgsInstance;
  43
  44     /**
  45      * Gets the single, empty and immutable EventArgs instance.
  46      *
  47      * This instance will be used when events are dispatched without any parameter,
  48      * like this: EventManager::dispatchEvent('eventname');
  49      *
  50      * The benefit from this is that only one empty instance is instantiated and shared
  51      * (otherwise there would be instances for every dispatched in the abovementioned form).
  52      *
  53      * @see EventManager::dispatchEvent
  54      *
  55      * @link http://msdn.microsoft.com/en-us/library/system.eventargs.aspx
  56      *
  57      * @return EventArgs
  58      */
  59     public static function getEmptyInstance()
  60     {
  61         if ( ! self::$_emptyEventArgsInstance) {
  62             self::$_emptyEventArgsInstance = new EventArgs;
  63         }
  64
  65         return self::$_emptyEventArgsInstance;
  66     }
  67 }