Search

Projects

Classes

Methods

⇦ Back to Joomla project (class list)

Class CMSWebApplicationInterface - list of methods

Interface defining a Joomla! CMS Application class for web applications.
Package: Joomla\CMS\Application
Copyright: (C) 2020 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE
Located at: Joomla/Application/CMSWebApplicationInterface.php
Project: Joomla

Method Summary

public \Joomla\CMS\Document\Document
()

Method to get the application document object.
Returns
  • \Joomla\CMS\Document\Document The document object
Since
  • 4.0.0
Show source code of this method: getDocument Source Code

public \Joomla\CMS\Menu\AbstractMenu|null
(mixed $name = null, mixed $options = array())

Get the menu object.
Parameters
  • string $name The application name for the menu
  • array $options An array of options to initialise the menu with
Returns
  • \Joomla\CMS\Menu\AbstractMenu|null An AbstractMenu object or null if not set.
Since
  • 4.0.0
Show source code of this method: getMenu Source Code

public static \Joomla\CMS\Router\Router
(mixed $name = null, array $options = array())

Returns the application Router object.
Parameters
  • string $name The name of the application.
  • array $options An optional associative array of configuration settings.
Returns
  • \Joomla\CMS\Router\Router
Since
  • 4.0.0
Show source code of this method: getRouter Source Code

public mixed
(mixed $key, mixed $default = null)

Gets a user state.
Parameters
  • string $key The path of the state.
  • mixed $default Optional default value, returned if the internal value is null.
Returns
  • mixed The user state or null.
Since
  • 4.0.0
Show source code of this method: getUserState Source Code

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

Gets the value of a user state variable.
Parameters
  • 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 {@link InputFilter::clean()}. Optional.
Returns
  • mixed The request user state.
Since
  • 4.0.0
Show source code of this method: getUserStateFromRequest Source Code

public mixed|void
(mixed $key, mixed $value)

Sets the value of a user state variable.
Parameters
  • string $key The path of the state.
  • mixed $value The value of the variable.
Returns
  • mixed|void The previous state, if one existed. Void otherwise.
Since
  • 4.0.0
Show source code of this method: setUserState Source Code

Tags Summary

Since
4.0.0