Class CMSApplication - list of methods

Class constructor.

• \Joomla\CMS\Input\Input $input An optional argument to provide dependency injection for the application's input object. If the argument is a JInput object that object will become the application's input object, otherwise a default input object is created.
• \Joomla\Registry\Registry $config An 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.
• \Joomla\Application\Web\WebClient $client An optional argument to provide dependency injection for the application's client object. If the argument is a WebClient object that object will become the application's client object, otherwise a default client object is created.
• \Joomla\DI\Container $container Dependency injection container.

• 3.2

Checks the user session.

• void

• 3.2

• \RuntimeException

Enqueue a system message.

• string $msg The message to enqueue.
• string $type The message type. Default is message.

• void

• 3.2

Ensure several core system input variables are not arrays.

• void

• 3.9

Execute the application.

• void

• 3.2

Check if the user is required to reset their password.

• string $option The option that manage the password reset
• string $view The view that manage the password reset
• string $layout The layout of the view that manage the password reset
• string $tasks Permitted tasks

• void

• \Exception

Gets a configuration value.

• string $varname The name of the value to get.
• string $default Default value to return

• mixed The user state.

• 3.2

• 5.0

Gets the client id of the current running application.

• int A client identifier.

• 3.2

Returns a reference to the global CmsApplication object, only creating it if it doesn't already exist.

• string $name The name (optional) of the CmsApplication class to instantiate.
• string $prefix The class name prefix of the object.
• \Joomla\DI\Container $container An optional dependency injection container to inject into the application.

• \Joomla\CMS\Application\CmsApplication

• 3.2

• 5.0

• \RuntimeException

Returns the application \JMenu object.

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

• \Joomla\CMS\Menu\AbstractMenu

• 3.2

Get the system message queue.

• bool $clear Clear the messages currently attached to the application object

• array The system message queue.

• 3.2

Gets the name of the current running application.

• string The name of the application.

• 3.2

Returns the application Pathway object.

• \Joomla\CMS\Pathway\Pathway

• 3.2

Returns the application Router object.

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

• \Joomla\CMS\Router\Router

• 3.2

Gets the name of the current template.

• bool $params An optional associative array of configuration settings

• mixed System is the fallback.

• 3.2

Gets a user state.

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

• mixed The user state or null.

• 3.2

Gets the value of a user state variable.

• 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.

• mixed The request user state.

• 3.2

Initialise the application.

• array $options An optional associative array of configuration settings.

• void

• 3.2

Checks if HTTPS is forced in the client configuration.

• int $clientId An optional client id (defaults to current application client).

• bool True if is forced for the client, false otherwise.

• 3.7.3

Check the client interface by name.

• string $identifier String identifier for the application interface

• bool True if this application is of the given type client interface.

• 3.7.0

Load the library language files for the application

• void

• 3.6.3

Login authentication function.

• array $credentials Array('username' => string, 'password' => string)
• array $options Array('remember' => boolean)

• bool|\Exception True on success, false if failed or silent handling is configured, or a \Exception object on authentication error.

• 3.2

Logout authentication function.

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

• bool True on success

• 3.2

Redirect to another URL.

• string $url The URL to redirect to. Can only be http/https URL
• int $status The HTTP 1.1 status code to be provided. 303 is assumed by default.

• void

• 3.2

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

• void

• 3.2

Route the application.

• void

• 3.2

Sets the value of a user state variable.

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

• mixed|void The previous state, if one existed.

• 3.2

Sends all headers prior to returning the string

• bool $compress If true, compress the data

• string

• 3.2

Method to determine a hash for anti-spoofing variable names

• bool $forceNew If true, force a new token to be created

• string Hashed var name

• 4.0.0

Checks for a form token in the request.

• string $method The request method in which to look for the token key.

• bool True if found and valid, false otherwise.

• 4.0.0

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

• bool

• 4.0.0

• 5.0

Checks if 2fa needs to be enforced if so returns true, else returns false

• bool

• 4.0.0

• \Exception

Redirects user to his Two Factor Authentication setup page

• void

• 4.0.0

Checks if otpKey and otep for the user are not empty if any one is empty returns false, else returns true

• bool

• 4.0.0

• \Exception

Setup logging functionality.

• void

• 4.0.0