[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  /**
   4   * Joomla! Content Management System
   5   *
   6   * @copyright  (C) 2020 Open Source Matters, Inc. <https://www.joomla.org>
   7   * @license    GNU General Public License version 2 or later; see LICENSE
   8   */
   9  
  10  namespace Joomla\CMS\Application;
  11  
  12  use Joomla\Event\DispatcherAwareInterface;
  13  use Joomla\Event\DispatcherInterface;
  14  use Joomla\Event\Event;
  15  
  16  // phpcs:disable PSR1.Files.SideEffects
  17  \defined('_JEXEC') or die;
  18  // phpcs:enable PSR1.Files.SideEffects
  19  
  20  /**
  21   * Interface defining application that can trigger Joomla 3.x style events
  22   *
  23   * @since       4.0.0
  24   * @deprecated  5.0   This interface will be removed as the Joomla 3.x compatibility layer will be removed
  25   */
  26  interface EventAwareInterface extends DispatcherAwareInterface
  27  {
  28      /**
  29       * Get the event dispatcher.
  30       *
  31       * @return  DispatcherInterface
  32       *
  33       * @since   4.0.0
  34       * @throws  \UnexpectedValueException May be thrown if the dispatcher has not been set.
  35       */
  36      public function getDispatcher();
  37  
  38      /**
  39       * Calls all handlers associated with an event group.
  40       *
  41       * This is a legacy method, implementing old-style (Joomla! 3.x) plugin calls. It's best to go directly through the
  42       * Dispatcher and handle the returned EventInterface object instead of going through this method. This method is
  43       * deprecated and will be removed in Joomla! 5.x.
  44       *
  45       * This method will only return the 'result' argument of the event
  46       *
  47       * @param   string       $eventName  The event name.
  48       * @param   array|Event  $args       An array of arguments or an Event object (optional).
  49       *
  50       * @return  array  An array of results from each function call. Note this will be an empty array if no dispatcher is set.
  51       *
  52       * @since       4.0.0
  53       * @throws      \InvalidArgumentException
  54       * @deprecated  5.0
  55       */
  56      public function triggerEvent($eventName, $args = []);
  57  }