- md5
- 0cb447530f031903027f9a2a6938c0a4
- sha1
- 1d391f8fc3abf1fa6c5037856d074dd79390caed
- sha256
- 105cf8e1e7674db00bee76a7e9631d17186f7c4fb15c6d1cfd327ad555c9e9ac
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102
<?php
/**
* Joomla! Content Management System
*
* @copyright (C) 2020 Open Source Matters, Inc. <https://www.joomla.org>
* @license GNU General Public License version 2 or later; see LICENSE
*/
namespace Joomla\CMS\Application;
use Joomla\Application\SessionAwareWebApplicationInterface;
use Joomla\CMS\Document\Document;
use Joomla\CMS\Menu\AbstractMenu;
use Joomla\CMS\Router\Router;
// phpcs:disable PSR1.Files.SideEffects
\defined('JPATH_PLATFORM') or die;
// phpcs:enable PSR1.Files.SideEffects
/**
* Interface defining a Joomla! CMS Application class for web applications.
*
* @since 4.0.0
*/
interface CMSWebApplicationInterface extends SessionAwareWebApplicationInterface, CMSApplicationInterface
{
/**
* Method to get the application document object.
*
* @return Document The document object
*
* @since 4.0.0
*/
public function getDocument();
/**
* Get the menu object.
*
* @param string $name The application name for the menu
* @param array $options An array of options to initialise the menu with
*
* @return AbstractMenu|null An AbstractMenu object or null if not set.
*
* @since 4.0.0
*/
public function getMenu($name = null, $options = []);
/**
* Returns the application Router object.
*
* @param string $name The name of the application.
* @param array $options An optional associative array of configuration settings.
*
* @return Router
*
* @since 4.0.0
*
* @deprecated 4.3 will be removed in 6.0
* Inject the router or load it from the dependency injection container
* Example: Factory::getContainer()->get($name);
*/
public static function getRouter($name = null, array $options = []);
/**
* Gets a user state.
*
* @param string $key The path of the state.
* @param mixed $default Optional default value, returned if the internal value is null.
*
* @return mixed The user state or null.
*
* @since 4.0.0
*/
public function getUserState($key, $default = null);
/**
* Gets the value of a user state variable.
*
* @param string $key The key of the user state variable.
* @param string $request The name of the variable passed in a request.
* @param string $default The default value for the variable if not found. Optional.
* @param string $type Filter for the variable, for valid values see {@link InputFilter::clean()}. Optional.
*
* @return mixed The request user state.
*
* @since 4.0.0
*/
public function getUserStateFromRequest($key, $request, $default = null, $type = 'none');
/**
* Sets the value of a user state variable.
*
* @param string $key The path of the state.
* @param mixed $value The value of the variable.
*
* @return mixed The previous state, if one existed. Null otherwise.
*
* @since 4.0.0
*/
public function setUserState($key, $value);
}
The same content is in 4 releases, Joomla 4.3.0-rc3 to 4.3.1. See them all, or every version of this file.