Docs For Class JApplicationCms

Description

Joomla! CMS Application class

since: 3.2

Located in /libraries/cms/application/cms.php (line 19)

JApplicationBase
   |
   --JApplicationWeb
      |
      --JApplicationCms

Direct descendents

Class	Description
InstallationApplicationWeb	Joomla! Installation Application class
JApplicationAdministrator	Joomla! Administrator Application class
JApplicationSite	Joomla! Site Application class

Variable Summary

static array $instances

array $docOptions

JProfiler $profiler

string $scope

object $template

boolean $useStrongEncryption

integer $_clientId

array $_messageQueue

array $_name

Method Summary

static JApplicationCms getInstance ([string $name = null])

JApplicationCms __construct ([JInput $input = null], [JRegistry $config = null], [JApplicationWebClient $client = null])

void afterSessionStart ()

void checkSession ()

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

void execute ()

mixed getCfg (string $varname, [string $default = null])

integer getClientId ()

Variables

static array $instances = array() (line 35)

Application instances container.

since: 3.2
access: protected

array $docOptions = array() (line 27)

Array of options for the JDocument object

since: 3.2
access: protected

JProfiler $profiler = null (line 78)

The profiler instance

since: 3.2
access: protected

string $scope = null (line 43)

The scope of the application.

since: 3.2
access: public

object $template = null (line 86)

Currently active template

since: 3.2
access: protected

boolean $useStrongEncryption = false (line 95)

Indicates that strong encryption should be used.

since: 3.2
access: protected

integer $_clientId = null (line 52)

The client identifier.

deprecated: 4.0 Will be renamed $clientId
since: 3.2
access: protected

array $_messageQueue = array() (line 61)

The application message queue.

deprecated: 4.0 Will be renamed $messageQueue
since: 3.2
access: protected

array $_name = null (line 70)

The name of the application.

deprecated: 4.0 Will be renamed $name
since: 3.2
access: protected

Inherited Variables

Inherited from JApplicationWeb

JApplicationWeb::$charSet
JApplicationWeb::$client
JApplicationWeb::$config
JApplicationWeb::$document
JApplicationWeb::$instance
JApplicationWeb::$language
JApplicationWeb::$mimeType
JApplicationWeb::$modifiedDate
JApplicationWeb::$response
JApplicationWeb::$session

Inherited from JApplicationBase

JApplicationBase::$dispatcher
JApplicationBase::$identity
JApplicationBase::$input

Methods

static getInstance (line 329)

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

This method must be invoked as: $web = JApplicationCms::getInstance();

throws: RuntimeException
since: 3.2
access: public

static JApplicationCms getInstance ([string $name = null])

string $name: The name (optional) of the JApplicationCms class to instantiate.

Redefinition of:

JApplicationWeb::getInstance(): Returns a reference to the global JApplicationWeb object, only creating it if it doesn't already exist.

Constructor __construct (line 112)

Class constructor.

since: 3.2
access: public

JApplicationCms __construct ([JInput $input = null], [JRegistry $config = null], [JApplicationWebClient $client = null])

mixed $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.
mixed $config: An optional argument to provide dependency injection for the application's config object. If the argument is a JRegistry object that object will become the application's config object, otherwise a default config object is created.
mixed $client: An optional argument to provide dependency injection for the application's client object. If the argument is a JApplicationWebClient object that object will become the application's client object, otherwise a default client object is created.

Redefinition of:

JApplicationWeb::__construct(): Class constructor.

Redefined in descendants as:

InstallationApplicationWeb::__construct() : Class constructor.
JApplicationAdministrator::__construct() : Class constructor.
JApplicationSite::__construct() : Class constructor.

afterSessionStart (line 151)

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

since: 3.2
access: public

void afterSessionStart ()

Redefinition of:

JApplicationWeb::afterSessionStart(): After the session has been started we need to populate it with some default values.

checkSession (line 172)

Checks the user session.

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

since: 3.2
access: public

void checkSession ()

enqueueMessage (line 235)

Enqueue a system message.

since: 3.2
access: public

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

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

execute (line 261)

Execute the application.

since: 3.2
access: public

void execute ()

Redefinition of:

JApplicationWeb::execute(): Execute the application.

getCfg (line 300)

Gets a configuration value.

return: The user state.
deprecated: 4.0 Use get() instead
since: 3.2
access: public

mixed getCfg (string $varname, [string $default = null])

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

getClientId (line 312)

Gets the client id of the current running application.

return: A client identifier.
since: 3.2
access: public

integer getClientId ()

Inherited Methods

Inherited From JApplicationWeb

JApplicationWeb::__construct()
JApplicationWeb::afterSessionStart()
JApplicationWeb::allowCache()
JApplicationWeb::appendBody()
JApplicationWeb::checkConnectionAlive()
JApplicationWeb::checkHeadersSent()
JApplicationWeb::clearHeaders()
JApplicationWeb::compress()
JApplicationWeb::detectRequestUri()
JApplicationWeb::doExecute()
JApplicationWeb::execute()
JApplicationWeb::fetchConfigurationData()
JApplicationWeb::flushAssets()
JApplicationWeb::get()
JApplicationWeb::getBody()
JApplicationWeb::getDocument()
JApplicationWeb::getHeaders()
JApplicationWeb::getInstance()
JApplicationWeb::getLanguage()
JApplicationWeb::getSession()
JApplicationWeb::header()
JApplicationWeb::initialise()
JApplicationWeb::isSSLConnection()
JApplicationWeb::loadConfiguration()
JApplicationWeb::loadDocument()
JApplicationWeb::loadLanguage()
JApplicationWeb::loadSession()
JApplicationWeb::loadSystemUris()
JApplicationWeb::prependBody()
JApplicationWeb::redirect()
JApplicationWeb::render()
JApplicationWeb::respond()
JApplicationWeb::sendHeaders()
JApplicationWeb::set()
JApplicationWeb::setBody()
JApplicationWeb::setHeader()

Inherited From JApplicationBase

JApplicationBase::close()
JApplicationBase::getIdentity()
JApplicationBase::loadDispatcher()
JApplicationBase::loadIdentity()
JApplicationBase::registerEvent()
JApplicationBase::triggerEvent()