Class JSite

Description

Joomla! Application class

Provide many supporting API functions

Located in /includes/application.php (line 20)

JObject
   |
   --JApplication
      |
      --JSite
Variable Summary
Method Summary
static JRouter getRouter ([string $name = null], [array $options = array()])
JSite __construct ([array $config = array()])
void authorise ( $itemid)
void authorize ( $itemid)
void dispatch ([string $component = null])
boolean getDetectBrowser ()
boolean getLanguageFilter ()
object JMenu. getMenu ([string $name = null], [array $options = array()])
object The getPageParameters ([string $option = null])
object The getParams ([string $option = null])
object JPathway. getPathway ([string $name = null], [array $options = array()])
string getTemplate ([ $params = false])
void initialise ([array $options = array()])
void login (array $credentials, [array $options = array()])
none; redirect (string $url, [string $msg = ''], [string $msgType = 'message'], [boolean $moved = false], [boolean $persistMsg = true])
void render ()
void route ()
boolean setDetectBrowser ([ $state = false])
boolean setLanguageFilter ([ $state = false])
void setTemplate (string $template, [mixed $styleParams = null])
Variables
object $template = null (line 26)

Currently active template

  • access: private
mixed $_detect_browser = false (line 36)

Option to detect language by the browser

  • access: private
mixed $_language_filter = false (line 31)

Option to filter by language

  • access: private

Inherited Variables

Inherited from JApplication

JApplication::$input
JApplication::$instances
JApplication::$requestTime
JApplication::$scope
JApplication::$startTime
JApplication::$_clientId
JApplication::$_messageQueue
JApplication::$_name

Inherited from JObject

JObject::$_errors
Methods
static method getRouter (line 568)

Return a reference to the JRouter object.

  • since: 1.5
  • access: public
static JRouter getRouter ([string $name = null], [array $options = array()])
  • string $name: The name of the application.
  • array $options: An optional associative array of configuration settings.

Redefinition of:
JApplication::getRouter()
Returns the application JRouter object.
Constructor __construct (line 44)

Class constructor

  • access: public
JSite __construct ([array $config = array()])
  • array $config: An optional associative array of configuration settings. Recognized key values include 'clientId' (this list is not meant to be comprehensive).

Redefinition of:
JApplication::__construct()
Class constructor.
authorise (line 310)

Check if the user can access the application

  • access: public
void authorise ( $itemid)
  • $itemid
authorize (line 301)
  • deprecated: 1.6 Use the authorise method instead.
  • access: public
void authorize ( $itemid)
  • $itemid
dispatch (line 146)

Dispatch the application

  • access: public
void dispatch ([string $component = null])
  • string $component

Redefinition of:
JApplication::dispatch()
Dispatch the application.
getDetectBrowser (line 605)

Return the current state of the detect browser option.

  • since: 1.6
  • access: public
boolean getDetectBrowser ()
getLanguageFilter (line 582)

Return the current state of the language filter.

  • since: 1.6
  • access: public
boolean getLanguageFilter ()
getMenu (line 536)

Return a reference to the JPathway object.

  • since: 1.5
  • access: public
object JMenu. getMenu ([string $name = null], [array $options = array()])
  • string $name: The name of the application/client.
  • array $options: An optional associative array of configuration settings.

Redefinition of:
JApplication::getMenu()
Returns the application JPathway object.
getPageParameters (line 407)

Get the application parameters

  • return: parameters object
  • since: 1.5
  • access: public
object The getPageParameters ([string $option = null])
  • string $option: The component option
getParams (line 343)

Get the appliaction parameters

  • return: parameters object
  • since: 1.5
  • access: public
object The getParams ([string $option = null])
  • string $option: The component option
getPathway (line 552)

Return a reference to the JPathway object.

  • since: 1.5
  • access: public
object JPathway. getPathway ([string $name = null], [array $options = array()])
  • string $name: The name of the application.
  • array $options: An optional associative array of configuration settings.

Redefinition of:
JApplication::getPathway()
Returns the application JPathway object.
getTemplate (line 418)

Get the template

  • return: The template name
  • since: 1.0
  • access: public
string getTemplate ([ $params = false])
  • $params

Redefinition of:
JApplication::getTemplate()
Gets the name of the current template.
initialise (line 55)

Initialise the application.

  • access: public
void initialise ([array $options = array()])
  • array $options

Redefinition of:
JApplication::initialise()
Initialise the application.
login (line 285)

Login authentication function

  • see: JApplication::login
  • access: public
void login (array $credentials, [array $options = array()])
  • array $credentials: Array('username' => string, 'password' => string)
  • array $options: Array('remember' => boolean)

Redefinition of:
JApplication::login()
Login authentication function.
redirect (line 641)

Redirect to another URL.

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.

none; redirect (string $url, [string $msg = ''], [string $msgType = 'message'], [boolean $moved = false], [boolean $persistMsg = true])
  • string $url: The URL to redirect to. Can only be http/https URL
  • string $msg: An optional message to display on redirect.
  • string $msgType: An optional message type.
  • boolean $moved: True if the page is 301 Permanently Moved, otherwise 303 See Other is assumed.
  • boolean $persistMsg: True if the enqueued messages are passed to the redirection, false else.

Redefinition of:
JApplication::redirect()
Redirect to another URL.
render (line 215)

Display the application.

  • access: public
void render ()

Redefinition of:
JApplication::render()
Render the application.
route (line 133)

Route the application.

  • access: public
void route ()

Redefinition of:
JApplication::route()
Route the application.
setDetectBrowser (line 616)

Set the current state of the detect browser option.

  • return: The old state
  • since: 1.6
  • access: public
boolean setDetectBrowser ([ $state = false])
  • $state
setLanguageFilter (line 593)

Set the current state of the language filter.

  • return: The old state
  • since: 1.6
  • access: public
boolean setLanguageFilter ([ $state = false])
  • $state
setTemplate (line 513)

Overrides the default template that would be used

  • access: public
void setTemplate (string $template, [mixed $styleParams = null])
  • string $template: The template name
  • mixed $styleParams: The template style parameters

Inherited Methods

Inherited From JApplication

JApplication::__construct()
JApplication::checkSession()
JApplication::close()
JApplication::dispatch()
JApplication::enqueueMessage()
JApplication::getCfg()
JApplication::getClientId()
JApplication::getHash()
JApplication::getInstance()
JApplication::getMenu()
JApplication::getMessageQueue()
JApplication::getName()
JApplication::getPathway()
JApplication::getRouter()
JApplication::getTemplate()
JApplication::getUserState()
JApplication::getUserStateFromRequest()
JApplication::initialise()
JApplication::isAdmin()
JApplication::isSite()
JApplication::isWinOS()
JApplication::login()
JApplication::logout()
JApplication::redirect()
JApplication::registerEvent()
JApplication::render()
JApplication::route()
JApplication::setUserState()
JApplication::stringURLSafe()
JApplication::triggerEvent()
JApplication::_createConfiguration()
JApplication::_createSession()
JApplication::__toString()

Inherited From JObject

JObject::__construct()
JObject::def()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::toString()
JObject::__toString()

Documentation generated on Mon, 25 Jun 2012 13:52:12 -0500 by phpDocumentor 1.4.4