Joomla! API

Download
Launch

CMSWebApplicationInterface

Extends SessionAwareWebApplicationInterface, CMSApplicationInterface

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

since

4.0.0
package

Joomla CMS

Methods

bootComponent

Boots the component with the given name.

bootComponent( component) : \Joomla\CMS\Extension\ComponentInterface
inherited
since

4.0.0

Arguments

component

stringThe component to boot.

Response

ComponentInterface

bootModule

Boots the module with the given name.

bootModule( module,  applicationName) : \Joomla\CMS\Extension\ModuleInterface
inherited
since

4.0.0

Arguments

module

stringThe module to boot

applicationName

stringThe application name

Response

ModuleInterface

bootPlugin

Boots the plugin with the given name and type.

bootPlugin( plugin,  type) : \Joomla\CMS\Extension\PluginInterface
inherited
since

4.0.0

Arguments

plugin

stringThe plugin name

type

stringThe type of the plugin

Response

PluginInterface

enqueueMessage

Enqueue a system message.

enqueueMessage( msg,  type = self::MSG_INFO) :
inherited
since

4.0.0

Arguments

msg

stringThe message to enqueue.

type

stringThe message type.

Response

void

getDispatcher

Get the event dispatcher.

getDispatcher() : \Joomla\Event\DispatcherInterface
inherited
since

4.0.0
throws

UnexpectedValueExceptionMay be thrown if the dispatcher has not been set.

Response

DispatcherInterface

getDocument

Method to get the application document object.

getDocument() : \Joomla\CMS\Document\Document
since

4.0.0

Response

DocumentThe document object

getIdentity

Get the application identity.

getIdentity() : \Joomla\CMS\User\User|null
inherited
since

4.0.0

Response

User|nullA User object or null if not set.

getInput

Method to get the application input object.

getInput() : \Joomla\Input\Input
inherited
since

4.0.0

Response

Input

getLanguage

Method to get the application language object.

getLanguage() : \Joomla\CMS\Language\Language
inherited
since

4.0.0

Response

LanguageThe language object

getMenu

Get the menu object.

getMenu( name = null, mixed||string|int options = []) : \Joomla\CMS\Menu\AbstractMenu|null
since

4.0.0

Arguments

name

stringThe application name for the menu

options

array<string|int, mixed>An array of options to initialise the menu with

Response

AbstractMenu|nullAn AbstractMenu object or null if not set.

getMessageQueue

Get the system message queue.

getMessageQueue() : mixed||string|int
inherited
since

4.0.0

Response

array<string|int, mixed>The system message queue.

getName

Gets the name of the current running application.

getName() :
inherited
since

4.0.0

Response

stringThe name of the application.

getRouter

Returns the application Router object.

getRouter( name = null, mixed||string|int options = []) : \Joomla\CMS\Router\Router
static deprecated
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);

Arguments

name

stringThe name of the application.

options

array<string|int, mixed>An optional associative array of configuration settings.

Response

Router

getUserState

Gets a user state.

getUserState( key,  default = null) :
since

4.0.0

Arguments

key

stringThe path of the state.

default

mixedOptional default value, returned if the internal value is null.

Response

mixedThe user state or null.

getUserStateFromRequest

Gets the value of a user state variable.

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

4.0.0

Arguments

key

stringThe key of the user state variable.

request

stringThe name of the variable passed in a request.

default

stringThe default value for the variable if not found. Optional.

type

stringFilter for the variable, for valid values see {@link InputFilter::clean()}. Optional.

Response

mixedThe request user state.

isCli

Flag if the application instance is a CLI or web based application.

isCli() :
inherited deprecated

Helper function, you should use the native PHP functions to detect if it is a CLI application.

since

4.0.0
deprecated

4.0 will be removed in 6.0 Will be removed without replacement. CLI will be handled by the joomla/console package instead

Response

bool

isClient

Check the client interface by name.

isClient( identifier) :
inherited
since

4.0.0

Arguments

identifier

stringString identifier for the application interface

Response

boolTrue if this application is of the given type client interface.

loadIdentity

Allows the application to load a custom or default identity.

loadIdentity(\Joomla\CMS\User\User identity = null) :
inherited
since

4.0.0

Arguments

identity

UserAn optional identity object. If omitted, the factory user is created.

Response

$this

setUserState

Sets the value of a user state variable.

setUserState( key,  value) :
since

4.0.0

Arguments

key

stringThe path of the state.

value

mixedThe value of the variable.

Response

mixedThe previous state, if one existed. Null otherwise.

triggerEvent

Calls all handlers associated with an event group.

triggerEvent( eventName, array|\Joomla\Event\Event args = []) : mixed||string|int
inherited deprecated

This is a legacy method, implementing old-style (Joomla! 3.x) plugin calls. It's best to go directly through the Dispatcher and handle the returned EventInterface object instead of going through this method. This method is deprecated and will be removed in Joomla! 5.x.

This method will only return the 'result' argument of the event

since

4.0.0
throws

InvalidArgumentException
deprecated

4.0 will be removed in 6.0 Use the Dispatcher method instead Example: Factory::getApplication()->getDispatcher()->dispatch($eventName, $event);

Arguments

eventName

stringThe event name.

args

array<string|int, mixed>|EventAn array of arguments or an Event object (optional).

Response

array<string|int, mixed>An array of results from each function call. Note this will be an empty array if no dispatcher is set.

Constants

MSG_EMERGENCY

Constant defining an enqueued emergency message

inherited
Value 'emergency'
since

4.0.0

Type(s)

string

MSG_ALERT

Constant defining an enqueued alert message

inherited
Value 'alert'
since

4.0.0

Type(s)

string

MSG_CRITICAL

Constant defining an enqueued critical message

inherited
Value 'critical'
since

4.0.0

Type(s)

string

MSG_ERROR

Constant defining an enqueued error message

inherited
Value 'error'
since

4.0.0

Type(s)

string

MSG_WARNING

Constant defining an enqueued warning message

inherited
Value 'warning'
since

4.0.0

Type(s)

string

MSG_NOTICE

Constant defining an enqueued notice message

inherited
Value 'notice'
since

4.0.0

Type(s)

string

MSG_INFO

Constant defining an enqueued info message

inherited
Value 'info'
since

4.0.0

Type(s)

string

MSG_DEBUG

Constant defining an enqueued debug message

inherited
Value 'debug'
since

4.0.0

Type(s)

string
  • \ Joomla
  • \ CMS
  • \ Application
  • \ CMSWebApplicationInterface