- md5
- b2800a31eafcd884858ae8e2eca6de39
- sha1
- 42a0c8678fa797f90979edc92f832a0f0d1baa75
- sha256
- cb3f0e2a4e54e6886acd0c85fca799747d36628f6b038c5ce6ce4da26f32ccf3
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103
<?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.txt
*/
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('_JEXEC') 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. Optional.
* @see \Joomla\CMS\Filter\InputFilter::clean() for valid values.
*
* @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 113 releases, Joomla 5.0.0-alpha4 to 6.0.0. See them all, or every version of this file.