[Summary view] [Print] [Text view]

   1  <?php
   2  /**
   3   * Part of the Joomla Framework Event Package
   4   *
   5   * @copyright  Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved.
   6   * @license    GNU General Public License version 2 or later; see LICENSE
   7   */
   8  
   9  namespace Joomla\Event;
  10  
  11  /**
  12   * Interface for events.
  13   * An event has a name and its propagation can be stopped.
  14   *
  15   * @since  1.0
  16   */
  17  interface EventInterface
  18  {
  19      /**
  20       * Get an event argument value.
  21       *
  22       * @param   string  $name     The argument name.
  23       * @param   mixed   $default  The default value if not found.
  24       *
  25       * @return  mixed  The argument value or the default value.
  26       *
  27       * @since   2.0.0
  28       */
  29  	public function getArgument($name, $default = null);
  30  
  31      /**
  32       * Get the event name.
  33       *
  34       * @return  string  The event name.
  35       *
  36       * @since   1.0
  37       */
  38  	public function getName();
  39  
  40      /**
  41       * Tell if the event propagation is stopped.
  42       *
  43       * @return  boolean  True if stopped, false otherwise.
  44       *
  45       * @since   1.0
  46       */
  47  	public function isStopped();
  48  
  49      /**
  50       * Stops the propagation of the event to further event listeners.
  51       *
  52       * @return  void
  53       *
  54       * @since   2.0.0
  55       */
  56  	public function stopPropagation(): void;
  57  }