Joomla! API

Class constructor.

__construct(\Joomla\Input\Input $input = null, \Joomla\Registry\Registry $config = null)

inherited

since	1.0

Arguments

$input: \Joomla\Input\InputAn optional argument to provide dependency injection for the application's input object. If the argument is an Input object that object will become the application's input object, otherwise a default input object is created.
$config: \Joomla\Registry\RegistryAn optional argument to provide dependency injection for the application's config object. If the argument is a Registry object that object will become the application's config object, otherwise a default config object is created.

Returns the response as a string.

__toString() : string

deprecated

since	1.6
deprecated	3.2

Response

stringThe response

Create the configuration registry.

_createConfiguration(string $file) : \JConfig

deprecated

since	1.5
deprecated	3.2

Arguments

$file: stringThe path to the configuration file

Response

\JConfigA JConfig object

Create the user session.

_createSession(string $name) : \JSession

deprecated

Old sessions are flushed based on the configuration value for the cookie lifetime. If an existing session, then the last access time is updated. If a new session, a session id is generated and a record is created in the #__sessions table.

since	1.5
deprecated	3.2

Arguments

$name: stringThe sessions name.

Response

\JSessionJSession on success. May call exit() on database error.

After the session has been started we need to populate it with some default values.

afterSessionStart() : void

deprecated

since	3.0
deprecated	3.2

Checks the user session.

checkSession() : void

deprecated

If the session record doesn't exist, initialise it. If session is new, create session variables

since	1.6
deprecated	3.2

Method to close the application.

close(integer $code) : void

inherited

since	1.0

Arguments

$code: integerThe exit code (optional; default is 0).

Dispatch the application.

dispatch(string $component = null) : void

deprecated

Dispatching is the process of pulling the option from the request object and mapping them to a component. If the component does not exist, it handles determining a default component to dispatch.

since	1.5
deprecated	3.2

Arguments

$component: stringThe component to dispatch.

Method to run the application routines. Most likely you will want to instantiate a controller and execute it, or perform some sort of task directly.

doExecute() : mixed

inherited abstract

since	1.0

Response

mixed

Enqueue a system message.

enqueueMessage(string $msg, string $type = 'message') : void

deprecated

since	1.5
deprecated	3.2

Arguments

$msg: stringThe message to enqueue.
$type: stringThe message type. Default is message.

Execute the application.

execute() : void

inherited

since	1.0

Returns a property of the object or the default value if the property is not set.

get(string $key, mixed $default = null) : mixed

inherited

since	1.0

Arguments

$key: stringThe name of the property.
$default: mixedThe default value (optional) if none is set.

Response

mixedThe value of the configuration.

Gets a configuration value.

getCfg(string $varname, string $default = null) : mixed

deprecated

since	1.5
deprecated	3.2

Arguments

$varname: stringThe name of the value to get.
$default: stringDefault value to return

Response

mixedThe user state.

Gets the client id of the current running application.

getClientId() : integer

deprecated

since	1.5
deprecated	3.2

Response

integerA client identifier.

Provides a secure hash based on a seed

getHash(string $seed) : string

static deprecated

since	1.6
deprecated	3.2 Use JApplicationHelper::getHash instead

Arguments

$seed: stringSeed string.

Response

stringA secure hash

Get the application identity.

getIdentity() : mixed

inherited

since	3.0.0

Response

mixedA \JUser object or null.

Returns the global JApplicationCms object, only creating it if it doesn't already exist.

getInstance(mixed $client, array $config = array(), string $prefix = 'J') : \JApplicationCms

static deprecated

since	1.5
deprecated	3.2 Use JApplicationCms::getInstance() instead
note	As of 3.2, this proxies to JApplicationCms::getInstance()

Arguments

$client: mixedA client identifier or name.
$config: arrayAn optional associative array of configuration settings.
$prefix: stringA prefix for class names

Response

\JApplicationCmsA JApplicationCms object.

Get the logger.

getLogger() : \Psr\Log\LoggerInterface

inherited

since	1.0

Response

\Psr\Log\LoggerInterface

Returns the application JPathway object.

getMenu(string $name = null, array $options = array()) : \JMenu|null

deprecated

since	1.5
deprecated	3.2

Arguments

$name: stringThe name of the application/client.
$options: arrayAn optional associative array of configuration settings.

Response

\JMenu|nullJMenu object.

Get the system message queue.

getMessageQueue() : array

deprecated

since	1.5
deprecated	3.2

Response

arrayThe system message queue.

Method to get the application name.

getName() : string

deprecated

The dispatcher name is by default parsed using the classname, or it can be set by passing a $config['name'] in the class constructor.

since	1.5
deprecated	3.2

Response

stringThe name of the dispatcher.

Returns the application JPathway object.

getPathway(string $name = null, array $options = array()) : \JPathway|null

deprecated

since	1.5
deprecated	3.2

Arguments

$name: stringThe name of the application.
$options: arrayAn optional associative array of configuration settings.

Response

\JPathway|nullA JPathway object

Returns the application JRouter object.

getRouter(string $name = null, array $options = array()) : \JRouter|null

static deprecated

since	1.5
deprecated	3.2

Arguments

$name: stringThe name of the application.
$options: arrayAn optional associative array of configuration settings.

Response

\JRouter|nullA JRouter object

Gets the name of the current template.

getTemplate(boolean $params = false) : mixed

deprecated

since	1.5
deprecated	3.2

Arguments

$params: booleanAn optional associative array of configuration settings

Response

mixedSystem is the fallback.

Gets a user state.

getUserState(string $key, mixed $default = null) : mixed

deprecated

since	1.5
deprecated	3.2

Arguments

$key: stringThe path of the state.
$default: mixedOptional default value, returned if the internal value is null.

Response

mixedThe user state or null.

Gets the value of a user state variable.

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

deprecated

since	1.5
deprecated	3.2

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 JFilterInput::clean()}. Optional.

Response

mixedThe request user state.

Custom initialisation method.

initialise() : void

inherited

Called at the end of the AbstractApplication::__construct method. This is for developers to inject initialisation code for their application classes.

since	1.0

Is admin interface?

isAdmin() : boolean

deprecated

since	1.0.2
deprecated	3.2

Response

booleanTrue if this application is administrator.

Check the client interface by name.

isClient(string $identifier) : boolean

since	3.7.0

Arguments

$identifier: stringString identifier for the application interface

Response

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

Is site interface?

isSite() : boolean

deprecated

since	1.5
deprecated	3.2

Response

booleanTrue if this application is site.

Determine if we are using a secure (SSL) connection.

isSSLConnection() : boolean

deprecated

since	3.0
deprecated	3.2

Response

booleanTrue if using SSL, false if not.

Method to determine if the host OS is Windows

isWinOs() : boolean

static deprecated

since	1.6
deprecated	4.0 Use the IS_WIN constant instead.

Response

booleanTrue if Windows OS

Allows the application to load a custom or default dispatcher.

loadDispatcher(\JEventDispatcher $dispatcher = null) : \Joomla\CMS\Application\BaseApplication

inherited

The logic and options for creating this object are adequately generic for default cases but for many applications it will make sense to override this method and create event dispatchers, if required, based on more specific needs.

since	3.0.0

Arguments

$dispatcher: \JEventDispatcherAn optional dispatcher object. If omitted, the factory dispatcher is created.

Response

\Joomla\CMS\Application\BaseApplicationThis method is chainable.

Allows the application to load a custom or default identity.

loadIdentity(\JUser $identity = null) : \Joomla\CMS\Application\BaseApplication

inherited

The logic and options for creating this object are adequately generic for default cases but for many applications it will make sense to override this method and create an identity, if required, based on more specific needs.

since	3.0.0

Arguments

$identity: \JUserAn optional identity object. If omitted, the factory user is created.

Response

\Joomla\CMS\Application\BaseApplicationThis method is chainable.

Login authentication function.

login(array $credentials, array $options = array()) : boolean|\JException

deprecated

Username and encoded password are passed the onUserLogin event which is responsible for the user validation. A successful validation updates the current session record with the user's details.

Username and encoded password are sent as credentials (along with other possibilities) to each observer (authentication plugin) for user validation. Successful validation will update the current session with the user details.

since	1.5
deprecated	3.2

Arguments

$credentials: arrayArray('username' => string, 'password' => string)
$options: arrayArray('remember' => boolean)

Response

boolean|\JExceptionTrue on success, false if failed or silent handling is configured, or a JException object on authentication error.

Logout authentication function.

logout(integer $userid = null, array $options = array()) : boolean

deprecated

Passed the current user information to the onUserLogout event and reverts the current session record back to 'anonymous' parameters. If any of the authentication plugins did not successfully complete the logout routine then the whole method fails. Any errors raised should be done in the plugin as this provides the ability to give much more information about why the routine may have failed.

since	1.5
deprecated	3.2

Arguments

$userid: integerThe user to load - Can be an integer or string - If string, it is converted to ID automatically
$options: arrayArray('clientid' => array of client id's)

Response

booleanTrue on success

Redirect to another URL.

redirect(string $url, string $msg = '', string $msgType = 'message', boolean $moved = false) : void

deprecated

Optionally enqueues a message in the system message queue (which will be displayed the next time a page is loaded) using the enqueueMessage method. If the headers have not been sent the redirect will be accomplished using a "301 Moved Permanently" code in the header pointing to the new location. If the headers have already been sent this will be accomplished using a JavaScript statement.

since	1.5
deprecated	3.2
see	\JApplication::enqueueMessage()

Arguments

$url: stringThe URL to redirect to. Can only be http/https URL
$msg: stringAn optional message to display on redirect.
$msgType: stringAn optional message type. Defaults to message.
$moved: booleanTrue if the page is 301 Permanently Moved, otherwise 303 See Other is assumed.

Registers a handler to a particular event group.

registerEvent(string $event, callable $handler) : \Joomla\CMS\Application\BaseApplication

inherited

since	3.0.0

Arguments

$event: stringThe event name.
$handler: callableThe handler, a function or an instance of an event object.

Response

\Joomla\CMS\Application\BaseApplicationThe application to allow chaining.

Render the application.

render() : void

deprecated

Rendering is the process of pushing the document buffers into the template placeholders, retrieving data from the document and pushing it into the JResponse buffer.

since	1.5
deprecated	3.2

Route the application.

route() : void

deprecated

Routing is the process of examining the request environment to determine which component should receive the request. The component optional parameters are then set in the request object to be processed when the application is being dispatched.

since	1.5
deprecated	3.2

Modifies a property of the object, creating it if it does not already exist.

set(string $key, mixed $value = null) : mixed

inherited

since	1.0

Arguments

$key: stringThe name of the property.
$value: mixedThe value of the property to set (optional).

Response

mixedPrevious value of the property

Sets the configuration for the application.

setConfiguration(\Joomla\Registry\Registry $config) : \Joomla\Application\AbstractApplication

inherited

since	1.0

Arguments

$config: \Joomla\Registry\RegistryA registry object holding the configuration.

Response

\Joomla\Application\AbstractApplicationReturns itself to support chaining.

Set the logger.

setLogger(\Psr\Log\LoggerInterface $logger) : \Joomla\Application\AbstractApplication

inherited

since	1.0

Arguments

$logger: \Psr\Log\LoggerInterfaceThe logger.

Response

\Joomla\Application\AbstractApplicationReturns itself to support chaining.

Sets the value of a user state variable.

setUserState(string $key, string $value) : mixed

deprecated

since	1.5
deprecated	3.2

Arguments

$key: stringThe path of the state.
$value: stringThe value of the variable.

Response

mixedThe previous state, if one existed.

This method transliterates a string into a URL safe string or returns a URL safe UTF-8 string based on the global configuration

stringURLSafe(string $string) : string

static deprecated

since	1.6
deprecated	3.2 Use JApplicationHelper::stringURLSafe instead

Arguments

$string: stringString to process

Response

stringProcessed string

Calls all handlers associated with an event group.

triggerEvent(string $event, array $args = null) : array

inherited

since	3.0.0

Arguments

$event: stringThe event name.
$args: arrayAn array of arguments (optional).

Response

arrayAn array of results from each function call, or null if no dispatcher is defined.

The client identifier.

deprecated

since	1.5
deprecated	3.2

Type(s)

integer

The application message queue.

deprecated

since	1.5
deprecated	3.2

Type(s)

array

The name of the application.

deprecated

since	1.5
deprecated	3.2

Type(s)

array

The scope of the application.

deprecated

since	1.5
deprecated	3.2

Type(s)

string

The time the request was made.

deprecated

since	1.5
deprecated	3.2

Type(s)

string

The time the request was made as Unix timestamp.

deprecated

since	1.6
deprecated	3.2

Type(s)

integer

The application client object.

deprecated

since	3.0
deprecated	3.2

Type(s)

\JApplicationWebClient

JApplication instances container.

static deprecated

since	2.5
deprecated	3.2

Type(s)

array<mixed,\JApplication>

The application dispatcher object.

inherited

since	3.0.0

Type(s)

\JEventDispatcher

The application identity object.

inherited

since	3.0.0

Type(s)

\JUser

The application configuration object.

inherited

since	1.0

Type(s)

\Joomla\Registry\Registry

The application input object.

inherited

since	1.0

Type(s)

\Joomla\Input\Input

A logger.

inherited

since	1.0

Type(s)

\Psr\Log\LoggerInterface

The application input object.

inherited

The application input object

Type(s)

\JInput

since	1.5
deprecated	3.2 Use CMSApplication instead unless specified otherwise
package	Joomla.Legacy

JApplication

Methods

__construct

Arguments

__toString

Response

_createConfiguration

Arguments

Response

_createSession

Arguments

Response

afterSessionStart

checkSession

close

Arguments

dispatch

Arguments

doExecute

Response

enqueueMessage

Arguments

execute

get

Arguments

Response

getCfg

Arguments

Response

getClientId

Response

getHash

Arguments

Response

getIdentity

Response

getInstance

Arguments

Response

getLogger

Response

getMenu

Arguments

Response

getMessageQueue

Response

getName

Response

getPathway

Arguments

Response

getRouter

Arguments

Response

getTemplate

Arguments

Response

getUserState

Arguments

Response

getUserStateFromRequest

Arguments

Response

initialise

isAdmin

Response

isClient

Arguments

Response

isSite

Response

isSSLConnection

Response

isWinOs

Response

loadDispatcher

Arguments

Response

loadIdentity

Arguments