class EventArgs in Plug 7

EventArgs 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. The single empty EventArgs instance can be obtained through {@link getEmptyInstance}.

@link www.doctrine-project.org @since 2.0 @author Guilherme Blanco <[e-mail]> @author Jonathan Wage <[e-mail]> @author Roman Borschel <[e-mail]>

Hierarchy

• class \Doctrine\Common\EventArgs

5 files declare their use of EventArgs

EventManagerTest.php in lib/doctrine/common/tests/Doctrine/Tests/Common/EventManagerTest.php

LifecycleEventArgs.php in lib/doctrine/common/lib/Doctrine/Common/Persistence/Event/LifecycleEventArgs.php

LoadClassMetadataEventArgs.php in lib/doctrine/common/lib/Doctrine/Common/Persistence/Event/LoadClassMetadataEventArgs.php

ManagerEventArgs.php in lib/doctrine/common/lib/Doctrine/Common/Persistence/Event/ManagerEventArgs.php

OnClearEventArgs.php in lib/doctrine/common/lib/Doctrine/Common/Persistence/Event/OnClearEventArgs.php

File

lib/doctrine/common/lib/Doctrine/Common/EventArgs.php, line 35

Namespace

Doctrine\Common

class EventArgs {

  /**
   * Single instance of EventArgs.
   *
   * @var EventArgs
   */
  private static $_emptyEventArgsInstance;

  /**
   * Gets the single, empty and immutable EventArgs instance.
   *
   * This instance will be used when events are dispatched without any parameter,
   * like this: EventManager::dispatchEvent('eventname');
   *
   * The benefit from this is that only one empty instance is instantiated and shared
   * (otherwise there would be instances for every dispatched in the abovementioned form).
   *
   * @see EventManager::dispatchEvent
   *
   * @link http://msdn.microsoft.com/en-us/library/system.eventargs.aspx
   *
   * @return EventArgs
   */
  public static function getEmptyInstance() {
    if (!self::$_emptyEventArgsInstance) {
      self::$_emptyEventArgsInstance = new EventArgs();
    }
    return self::$_emptyEventArgsInstance;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
EventArgs::$_emptyEventArgsInstance	private static	property	Single instance of EventArgs.
EventArgs::getEmptyInstance	public static	function	Gets the single, empty and immutable EventArgs instance.