[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  /**
   4   * Joomla! Content Management System
   5   *
   6   * @copyright  (C) 2018 Open Source Matters, Inc. <https://www.joomla.org>
   7   * @license    GNU General Public License version 2 or later; see LICENSE.txt
   8   */
   9  
  10  namespace Joomla\CMS\Extension;
  11  
  12  use Joomla\CMS\Application\CMSApplicationInterface;
  13  use Joomla\CMS\Dispatcher\DispatcherInterface;
  14  use Joomla\Input\Input;
  15  
  16  // phpcs:disable PSR1.Files.SideEffects
  17  \defined('JPATH_PLATFORM') or die;
  18  // phpcs:enable PSR1.Files.SideEffects
  19  
  20  /**
  21   * Access to module specific services.
  22   *
  23   * @since  4.0.0
  24   */
  25  interface ModuleInterface
  26  {
  27      /**
  28       * Returns the dispatcher for the given application, module and input.
  29       *
  30       * @param   \stdClass                $module       The module
  31       * @param   CMSApplicationInterface  $application  The application
  32       * @param   Input                    $input        The input object, defaults to the one in the application
  33       *
  34       * @return  DispatcherInterface
  35       *
  36       * @since   4.0.0
  37       */
  38      public function getDispatcher(\stdClass $module, CMSApplicationInterface $application, Input $input = null): DispatcherInterface;
  39  }