[ Index ]

PHP Cross Reference of Joomla 2.5.4 DE

title

Body

[close]

/includes/ -> application.php (summary)

(no description)

Copyright: Copyright (C) 2005 - 2012 Open Source Matters, Inc. All rights reserved.
License: GNU General Public License version 2 or later; see LICENSE.txt
File Size: 649 lines (17 kb)
Included or required: 5 times
Referenced: 0 times
Includes or requires: 0 files

Defines 20 functions

  __construct()
  initialise()
  route()
  dispatch()
  render()
  login()
  authorize()
  authorise()
  getParams()
  getPageParameters()
  getTemplate()
  setTemplate()
  getMenu()
  getPathway()
  getRouter()
  getLanguageFilter()
  setLanguageFilter()
  getDetectBrowser()
  setDetectBrowser()
  redirect()

Functions
Functions that are not part of a class:

__construct($config = array()   X-Ref
Class constructor

param: array An optional associative array of configuration settings.

initialise($options = array()   X-Ref
Initialise the application.

param: array

route()   X-Ref
Route the application.


dispatch($component = null)   X-Ref
Dispatch the application

param: string

render()   X-Ref
Display the application.


login($credentials, $options = array()   X-Ref
Login authentication function

param: array    Array('username' => string, 'password' => string)
param: array    Array('remember' => boolean)

authorize($itemid)   X-Ref


authorise($itemid)   X-Ref
Check if the user can access the application


getParams($option = null)   X-Ref
Get the appliaction parameters

param: string    The component option
return: object    The parameters object

getPageParameters($option = null)   X-Ref
Get the application parameters

param: string    The component option
return: object    The parameters object

getTemplate($params = false)   X-Ref
Get the template

return: string The template name

setTemplate($template, $styleParams=null)   X-Ref
Overrides the default template that would be used

param: string    The template name
param: mixed        The template style parameters

getMenu($name = null, $options = array()   X-Ref
Return a reference to the JPathway object.

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

getPathway($name = null, $options = array()   X-Ref
Return a reference to the JPathway object.

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

getRouter($name = null, array $options = array()   X-Ref
Return a reference to the JRouter object.

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

getLanguageFilter()   X-Ref
Return the current state of the language filter.

return: boolean

setLanguageFilter($state=false)   X-Ref
Set the current state of the language filter.

return: boolean    The old state

getDetectBrowser()   X-Ref
Return the current state of the detect browser option.

return: boolean

setDetectBrowser($state=false)   X-Ref
Set the current state of the detect browser option.

return: boolean    The old state

redirect($url, $msg='', $msgType='message', $moved = false, $persistMsg = true)   X-Ref
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.

param: string    The URL to redirect to. Can only be http/https URL
param: string    An optional message to display on redirect.
param: string  An optional message type.
param: boolean    True if the page is 301 Permanently Moved, otherwise 303 See Other is assumed.
param: boolean    True if the enqueued messages are passed to the redirection, false else.
return: none; calls exit().



Generated: Tue Apr 3 11:40:28 2012 Cross-referenced by PHPXref 0.7.1