[ Index ]

PHP Cross Reference of Joomla 1.5.25

title

Body

[close]

/includes/ -> application.php (summary)

(no description)

Copyright: Copyright (C) 2005 - 2010 Open Source Matters. All rights reserved.
License: GNU/GPL, see LICENSE.php
Version: $Id: application.php 14401 2010-01-26 14:10:00Z louis $
File Size: 377 lines (9 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

JSite:: (14 methods):
  __construct()
  initialise()
  route()
  dispatch()
  render()
  login()
  authorize()
  getParams()
  getPageParameters()
  getTemplate()
  setTemplate()
  getMenu()
  getPathWay()
  getRouter()


Class: JSite  - X-Ref

Joomla! Application class

Provide many supporting API functions

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

param: array An optional associative array of configuration settings.

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


route()   X-Ref
Route the application


dispatch($component)   X-Ref
Dispatch the application


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
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 appliaction parameters

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

getTemplate()   X-Ref
Get the template

return: string The template name

setTemplate( $template )   X-Ref
Overrides the default template that would be used

param: string The template name

getMenu()   X-Ref
Return a reference to the JPathway object.

return: object JPathway.

getPathWay()   X-Ref
Return a reference to the JPathway object.

return: object JPathway.

getRouter()   X-Ref
Return a reference to the JRouter object.

return: JRouter.



Generated: Mon Nov 14 16:47:20 2011 Cross-referenced by PHPXref 0.7.1