Référence de l'interface CMSWebApplicationInterface

Graphe d'héritage de CMSWebApplicationInterface:

Fonctions membres publiques
	getDocument ()
	getMenu ($name=null, $options=array())
	getUserState ($key, $default=null)
	getUserStateFromRequest ($key, $request, $default=null, $type='none')
	setUserState ($key, $value)
Fonctions membres publiques hérités de SessionAwareWebApplicationInterface
	getSession ()
	setSession (SessionInterface $session)
	checkToken ($method='post')
	getFormToken ($forceNew=false)
Fonctions membres publiques hérités de WebApplicationInterface
	getInput ()
	redirect ($url, $status=303)
	allowCache ($allow=null)
	setHeader ($name, $value, $replace=false)
	getHeaders ()
	clearHeaders ()
	sendHeaders ()
	setBody ($content)
	prependBody ($content)
	appendBody ($content)
	getBody ()
	getResponse ()
	isValidHttpStatus ($code)
	setResponse (ResponseInterface $response)
	isSslConnection ()
Fonctions membres publiques hérités de ApplicationInterface
	close ($code=0)
	execute ()
Fonctions membres publiques hérités de CMSApplicationInterface
	enqueueMessage ($msg, $type=self::MSG_INFO)
	getMessageQueue ()
	isClient ($identifier)
	isCli ()
	getIdentity ()
	getInput ()
	getLanguage ()
	getName ()
	loadIdentity (User $identity=null)
Fonctions membres publiques hérités de ExtensionManagerInterface
	bootComponent ($component)
	bootModule ($module, $applicationName)
	bootPlugin ($plugin, $type)
Fonctions membres publiques hérités de ConfigurationAwareApplicationInterface
	get ($key, $default=null)
	set ($key, $value=null)
	setConfiguration (Registry $config)
Fonctions membres publiques hérités de EventAwareInterface
	getDispatcher ()
	triggerEvent ($eventName, $args=[])
Fonctions membres publiques hérités de DispatcherAwareInterface
	setDispatcher (DispatcherInterface $dispatcher)

Fonctions membres publiques statiques
static	getRouter ($name=null, array $options=array())

Membres hérités additionnels
Champs de données hérités de CMSApplicationInterface
const	MSG_EMERGENCY = 'emergency'
const	MSG_ALERT = 'alert'
const	MSG_CRITICAL = 'critical'
const	MSG_ERROR = 'error'
const	MSG_WARNING = 'warning'
const	MSG_NOTICE = 'notice'
const	MSG_INFO = 'info'
const	MSG_DEBUG = 'debug'

Description détaillée

Interface defining a Joomla! CMS Application class for web applications.

Depuis

4.0.0

Documentation des fonctions membres

getDocument()

getDocument

(

)

Method to get the application document object.

Renvoie

Document The document object

Depuis

4.0.0

getMenu()

getMenu	(		$name = null,
			$options = array()
	)

Get the menu object.

Paramètres

string	$name	The application name for the menu
array	$options	An array of options to initialise the menu with

Renvoie

AbstractMenu|null An AbstractMenu object or null if not set.

Depuis

4.0.0

Implémenté dans InstallationApplication, et CMSApplication.

getRouter()

static getRouter (   $name = null, array  $options = array()  )

static

Returns the application Router object.

Paramètres

string	$name	The name of the application.
array	$options	An optional associative array of configuration settings.

Renvoie

Router

Depuis

4.0.0

Obsolète:

5.0 Inject the router or load it from the dependency injection container

Implémenté dans CMSApplication, SiteApplication, et AdministratorApplication.

getUserState()

getUserState	(		$key,
			$default = null
	)

Gets a user state.

Paramètres

string	$key	The path of the state.
mixed	$default	Optional default value, returned if the internal value is null.

Renvoie

mixed The user state or null.

Depuis

4.0.0

Implémenté dans CMSApplication.

getUserStateFromRequest()

getUserStateFromRequest	(		$key,
			$request,
			$default = null,
			$type = 'none'
	)

Gets the value of a user state variable.

Paramètres

string	$key	The key of the user state variable.
string	$request	The name of the variable passed in a request.
string	$default	The default value for the variable if not found. Optional.
string	$type	Filter for the variable, for valid values see InputFilter::clean(). Optional.

Renvoie

mixed The request user state.

Depuis

4.0.0

Implémenté dans CMSApplication.

setUserState()

setUserState	(		$key,
			$value
	)

Sets the value of a user state variable.

Paramètres

string	$key	The path of the state.
mixed	$value	The value of the variable.

Renvoie

mixed|void The previous state, if one existed. Void otherwise.

Depuis

4.0.0

Implémenté dans CMSApplication.

---

La documentation de cette interface a été générée à partir du fichier suivant :

• CMSWebApplicationInterface.php