[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\Application\SessionAwareWebApplicationInterface;
  13  use Joomla\CMS\Document\Document;
  14  use Joomla\CMS\Menu\AbstractMenu;
  15  use Joomla\CMS\Router\Router;
  16  
  17  // phpcs:disable PSR1.Files.SideEffects
  18  \defined('JPATH_PLATFORM') or die;
  19  // phpcs:enable PSR1.Files.SideEffects
  20  
  21  /**
  22   * Interface defining a Joomla! CMS Application class for web applications.
  23   *
  24   * @since  4.0.0
  25   */
  26  interface CMSWebApplicationInterface extends SessionAwareWebApplicationInterface, CMSApplicationInterface
  27  {
  28      /**
  29       * Method to get the application document object.
  30       *
  31       * @return  Document  The document object
  32       *
  33       * @since   4.0.0
  34       */
  35      public function getDocument();
  36  
  37      /**
  38       * Get the menu object.
  39       *
  40       * @param   string  $name     The application name for the menu
  41       * @param   array   $options  An array of options to initialise the menu with
  42       *
  43       * @return  AbstractMenu|null  An AbstractMenu object or null if not set.
  44       *
  45       * @since   4.0.0
  46       */
  47      public function getMenu($name = null, $options = array());
  48  
  49      /**
  50       * Returns the application Router object.
  51       *
  52       * @param   string  $name     The name of the application.
  53       * @param   array   $options  An optional associative array of configuration settings.
  54       *
  55       * @return  Router
  56       *
  57       * @since      4.0.0
  58       *
  59       * @deprecated 5.0 Inject the router or load it from the dependency injection container
  60       */
  61      public static function getRouter($name = null, array $options = array());
  62  
  63      /**
  64       * Gets a user state.
  65       *
  66       * @param   string  $key      The path of the state.
  67       * @param   mixed   $default  Optional default value, returned if the internal value is null.
  68       *
  69       * @return  mixed  The user state or null.
  70       *
  71       * @since   4.0.0
  72       */
  73      public function getUserState($key, $default = null);
  74  
  75      /**
  76       * Gets the value of a user state variable.
  77       *
  78       * @param   string  $key      The key of the user state variable.
  79       * @param   string  $request  The name of the variable passed in a request.
  80       * @param   string  $default  The default value for the variable if not found. Optional.
  81       * @param   string  $type     Filter for the variable, for valid values see {@link InputFilter::clean()}. Optional.
  82       *
  83       * @return  mixed  The request user state.
  84       *
  85       * @since   4.0.0
  86       */
  87      public function getUserStateFromRequest($key, $request, $default = null, $type = 'none');
  88  
  89      /**
  90       * Sets the value of a user state variable.
  91       *
  92       * @param   string  $key    The path of the state.
  93       * @param   mixed   $value  The value of the variable.
  94       *
  95       * @return  mixed|void  The previous state, if one existed. Void otherwise.
  96       *
  97       * @since   4.0.0
  98       */
  99      public function setUserState($key, $value);
 100  }