[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  /**
   4   * Joomla! Content Management System
   5   *
   6   * @copyright  (C) 2017 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\ConfigurationAwareApplicationInterface;
  13  use Joomla\CMS\Extension\ExtensionManagerInterface;
  14  use Joomla\CMS\Language\Language;
  15  use Joomla\CMS\User\User;
  16  use Joomla\Input\Input;
  17  
  18  // phpcs:disable PSR1.Files.SideEffects
  19  \defined('_JEXEC') or die;
  20  // phpcs:enable PSR1.Files.SideEffects
  21  
  22  /**
  23   * Interface defining a Joomla! CMS Application class
  24   *
  25   * @since  4.0.0
  26   * @note   In Joomla 5 this interface will no longer extend EventAwareInterface
  27   * @property-read   Input  $input  {@deprecated 5.0} The Joomla Input property. Deprecated in favour of getInput()
  28   */
  29  interface CMSApplicationInterface extends ExtensionManagerInterface, ConfigurationAwareApplicationInterface, EventAwareInterface
  30  {
  31      /**
  32       * Constant defining an enqueued emergency message
  33       *
  34       * @var    string
  35       * @since  4.0.0
  36       */
  37      public const MSG_EMERGENCY = 'emergency';
  38  
  39      /**
  40       * Constant defining an enqueued alert message
  41       *
  42       * @var    string
  43       * @since  4.0.0
  44       */
  45      public const MSG_ALERT = 'alert';
  46  
  47      /**
  48       * Constant defining an enqueued critical message
  49       *
  50       * @var    string
  51       * @since  4.0.0
  52       */
  53      public const MSG_CRITICAL = 'critical';
  54  
  55      /**
  56       * Constant defining an enqueued error message
  57       *
  58       * @var    string
  59       * @since  4.0.0
  60       */
  61      public const MSG_ERROR = 'error';
  62  
  63      /**
  64       * Constant defining an enqueued warning message
  65       *
  66       * @var    string
  67       * @since  4.0.0
  68       */
  69      public const MSG_WARNING = 'warning';
  70  
  71      /**
  72       * Constant defining an enqueued notice message
  73       *
  74       * @var    string
  75       * @since  4.0.0
  76       */
  77      public const MSG_NOTICE = 'notice';
  78  
  79      /**
  80       * Constant defining an enqueued info message
  81       *
  82       * @var    string
  83       * @since  4.0.0
  84       */
  85      public const MSG_INFO = 'info';
  86  
  87      /**
  88       * Constant defining an enqueued debug message
  89       *
  90       * @var    string
  91       * @since  4.0.0
  92       */
  93      public const MSG_DEBUG = 'debug';
  94  
  95      /**
  96       * Enqueue a system message.
  97       *
  98       * @param   string  $msg   The message to enqueue.
  99       * @param   string  $type  The message type.
 100       *
 101       * @return  void
 102       *
 103       * @since   4.0.0
 104       */
 105      public function enqueueMessage($msg, $type = self::MSG_INFO);
 106  
 107      /**
 108       * Get the system message queue.
 109       *
 110       * @return  array  The system message queue.
 111       *
 112       * @since   4.0.0
 113       */
 114      public function getMessageQueue();
 115  
 116      /**
 117       * Check the client interface by name.
 118       *
 119       * @param   string  $identifier  String identifier for the application interface
 120       *
 121       * @return  boolean  True if this application is of the given type client interface.
 122       *
 123       * @since   4.0.0
 124       */
 125      public function isClient($identifier);
 126  
 127      /**
 128       * Flag if the application instance is a CLI or web based application.
 129       *
 130       * Helper function, you should use the native PHP functions to detect if it is a CLI application.
 131       *
 132       * @return  boolean
 133       *
 134       * @since       4.0.0
 135       * @deprecated  5.0  Will be removed without replacements
 136       */
 137      public function isCli();
 138  
 139      /**
 140       * Get the application identity.
 141       *
 142       * @return  User|null  A User object or null if not set.
 143       *
 144       * @since   4.0.0
 145       */
 146      public function getIdentity();
 147  
 148      /**
 149       * Method to get the application input object.
 150       *
 151       * @return  Input
 152       *
 153       * @since   4.0.0
 154       */
 155      public function getInput(): Input;
 156  
 157      /**
 158       * Method to get the application language object.
 159       *
 160       * @return  Language  The language object
 161       *
 162       * @since   4.0.0
 163       */
 164      public function getLanguage();
 165  
 166      /**
 167       * Gets the name of the current running application.
 168       *
 169       * @return  string  The name of the application.
 170       *
 171       * @since   4.0.0
 172       */
 173      public function getName();
 174  
 175      /**
 176       * Allows the application to load a custom or default identity.
 177       *
 178       * @param   User  $identity  An optional identity object. If omitted, the factory user is created.
 179       *
 180       * @return  $this
 181       *
 182       * @since   4.0.0
 183       */
 184      public function loadIdentity(User $identity = null);
 185  }