Docs For Class JApplicationSite

JApplicationSite

Description

Joomla! Site Application class

since: 3.2

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

JApplicationBase
   |
   --JApplicationWeb
      |
      --JApplicationCms
         |
         --JApplicationSite

Variable Summary

boolean $_detect_browser

boolean $_language_filter

Method Summary

static JRouter getRouter ([string $name = 'site'], [array $options = array()])

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

void authorise (integer $itemid)

void dispatch ([string $component = null])

void doExecute ()

boolean getDetectBrowser ()

boolean getLanguageFilter ()

JMenu getMenu ([string $name = 'site'], [array $options = array()])

object The getPageParameters ([string $option = null])

object The getParams ([string $option = null])

JPathway getPathway ([string $name = 'site'], [array $options = array()])

string getTemplate ([boolean $params = false])

void initialiseApp ([array $options = array()])

boolean login (array $credentials, [array $options = array()])

void render ()

void route ()

boolean setDetectBrowser ([boolean $state = false])

boolean setLanguageFilter ([boolean $state = false])

void setTemplate (string $template, [mixed $styleParams = null])

Variables

boolean $_detect_browser = false (line 37)

Option to detect language by the browser

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

boolean $_language_filter = false (line 28)

Option to filter by language

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

Inherited Variables

Inherited from JApplicationCms

JApplicationCms::$docOptions
JApplicationCms::$instances
JApplicationCms::$profiler
JApplicationCms::$scope
JApplicationCms::$template
JApplicationCms::$useStrongEncryption
JApplicationCms::$_clientId
JApplicationCms::$_messageQueue
JApplicationCms::$_name

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 getRouter (line 373)

Return a reference to the JRouter object.

since: 3.2
access: public

static JRouter getRouter ([string $name = 'site'], [array $options = array()])

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

Constructor __construct (line 54)

Class constructor.

since: 3.2
access: public

JApplicationSite __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:

JApplicationCms::__construct(): Class constructor.

authorise (line 75)

Check if the user can access the application

since: 3.2
access: protected

void authorise (integer $itemid)

integer $itemid: The item ID to check authorisation for

dispatch (line 108)

Dispatch the application

since: 3.2
access: public

void dispatch ([string $component = null])

string $component: The component which is being rendered.

doExecute (line 193)

Method to run the Web application routines.

since: 3.2
access: protected

void doExecute ()

Redefinition of:

JApplicationWeb::doExecute(): Method to run the Web application routines. Most likely you will want to instantiate a controller and execute it, or perform some sort of action that populates a JDocument object so that output can be rendered to the client.

getDetectBrowser (line 221)

Return the current state of the detect browser option.

since: 3.2
access: public

boolean getDetectBrowser ()

getLanguageFilter (line 233)

Return the current state of the language filter.

since: 3.2
access: public

boolean getLanguageFilter ()

getMenu (line 248)

Return a reference to the JMenu object.

return: JMenu object.
since: 3.2
access: public

JMenu getMenu ([string $name = 'site'], [array $options = array()])

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

getPageParameters (line 265)

Get the application parameters

return: parameters object
deprecated: 4.0 Use getParams() instead
since: 3.2
access: public

object The getPageParameters ([string $option = null])

string $option: The component option

getParams (line 279)

Get the application parameters

return: parameters object
since: 3.2
access: public

object The getParams ([string $option = null])

string $option: The component option

getPathway (line 358)

Return a reference to the JPathway object.

return: A JPathway object
since: 3.2
access: public

JPathway getPathway ([string $name = 'site'], [array $options = array()])

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

getTemplate (line 391)

Gets the name of the current template.

return: The name of the template.
since: 3.2
throws: InvalidArgumentException
access: public

string getTemplate ([boolean $params = false])

boolean $params: True to return the template parameters

initialiseApp (line 532)

Initialise the application.

since: 3.2
access: protected

void initialiseApp ([array $options = array()])

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

return: True on success.
since: 3.2
access: public

boolean login (array $credentials, [array $options = array()])

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

render (line 670)

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.

since: 3.2
access: protected

void render ()

Redefinition of:

JApplicationWeb::render(): 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.

route (line 724)

Route the application.

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: 3.2
access: protected

void route ()

setDetectBrowser (line 742)

Set the current state of the detect browser option.

return: The previous state
since: 3.2
access: public

boolean setDetectBrowser ([boolean $state = false])

boolean $state: The new state of the detect browser option

setLanguageFilter (line 759)

Set the current state of the language filter.

return: The previous state
since: 3.2
access: public

boolean setLanguageFilter ([boolean $state = false])

boolean $state: The new state of the language filter

setTemplate (line 777)

Overrides the default template that would be used

since: 3.2
access: public

void setTemplate (string $template, [mixed $styleParams = null])

string $template: The template name
mixed $styleParams: The template style parameters

Inherited Methods

Inherited From JApplicationCms

JApplicationCms::__construct()
JApplicationCms::afterSessionStart()
JApplicationCms::checkSession()
JApplicationCms::enqueueMessage()
JApplicationCms::execute()
JApplicationCms::getCfg()
JApplicationCms::getClientId()
JApplicationCms::getInstance()

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()

Documentation generated on Tue, 19 Nov 2013 15:13:55 +0100 by phpDocumentor 1.4.3