[ Index ]

PHP Cross Reference of Joomla 1.5.26 DE

title

Body

[close]

/libraries/joomla/ -> factory.php (summary)

(no description)

Copyright: Copyright (C) 2005 - 2010 Open Source Matters. All rights reserved.
License: GNU/GPL, see LICENSE.php
Version: $Id: factory.php 19176 2010-10-21 03:06:39Z ian $
File Size: 719 lines (17 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

JFactory:: (23 methods):
  getApplication()
  getConfig()
  getSession()
  getLanguage()
  getDocument()
  getUser()
  getCache()
  getACL()
  getTemplate()
  getDBO()
  getMailer()
  getXMLParser()
  getEditor()
  getURI()
  getDate()
  _createConfig()
  _createSession()
  _createACL()
  _createDBO()
  _createMailer()
  _createTemplate()
  _createLanguage()
  _createDocument()


Class: JFactory  - X-Ref

Joomla Framework Factory class

getApplication($id = null, $config = array()   X-Ref
Get a application object

Returns a reference to the global {@link JApplication} object, only creating it
if it doesn't already exist.

param: mixed    $id         A client identifier or name.
param: array    $config     An optional associative array of configuration settings.
return: object JApplication

getConfig($file = null, $type = 'PHP')   X-Ref
Get a configuration object

Returns a reference to the global {@link JRegistry} object, only creating it
if it doesn't already exist.

param: string    The path to the configuration file
param: string    The type of the configuration file
return: object JRegistry

getSession($options = array()   X-Ref
Get a session object

Returns a reference to the global {@link JSession} object, only creating it
if it doesn't already exist.

param: array An array containing session options
return: object JSession

getLanguage()   X-Ref
Get a language object

Returns a reference to the global {@link JLanguage} object, only creating it
if it doesn't already exist.

return: object JLanguage

getDocument()   X-Ref
Get a document object

Returns a reference to the global {@link JDocument} object, only creating it
if it doesn't already exist.

return: object JDocument

getUser($id = null)   X-Ref
Get an user object

Returns a reference to the global {@link JUser} object, only creating it
if it doesn't already exist.

param: int     $id     The user to load - Can be an integer or string - If string, it is converted to ID automatically.
return: object JUser

getCache($group = '', $handler = 'callback', $storage = null)   X-Ref
Get a cache object

Returns a reference to the global {@link JCache} object

param: string The cache group name
param: string The handler to use
param: string The storage method
return: object JCache

getACL( )   X-Ref
Get an authorization object

Returns a reference to the global {@link JAuthorization} object, only creating it
if it doesn't already exist.

return: object JAuthorization

getTemplate( )   X-Ref
Get a template object

Returns a reference to the global {@link JTemplate} object, only creating it
if it doesn't already exist.

return: object JTemplate

getDBO()   X-Ref
Get a database object

Returns a reference to the global {@link JDatabase} object, only creating it
if it doesn't already exist.

return: object JDatabase

getMailer( )   X-Ref
Get a mailer object

Returns a reference to the global {@link JMail} object, only creating it
if it doesn't already exist

return: object JMail

getXMLParser( $type = 'DOM', $options = array()   X-Ref
Get an XML document

param: string The type of xml parser needed 'DOM', 'RSS' or 'Simple'
param: array:
return: object Parsed XML document object

getEditor($editor = null)   X-Ref
Get an editor object

param: string $editor The editor to load, depends on the editor plugins that are installed
return: object JEditor

getURI($uri = 'SERVER')   X-Ref
Return a reference to the {@link JURI} object

return: object JURI

getDate($time = 'now', $tzOffset = 0)   X-Ref
Return a reference to the {@link JDate} object

param: mixed $time The initial time for the JDate object
param: int $tzOffset The timezone offset.
return: object JDate

_createConfig($file, $type = 'PHP')   X-Ref
Create a configuration object

param: string    The path to the configuration file
param: string    The type of the configuration file
return: object JRegistry

_createSession( $options = array()   X-Ref
Create a session object

param: array $options An array containing session options
return: object JSession

_createACL()   X-Ref
Create an ACL object

return: object JAuthorization

_createDBO()   X-Ref
Create an database object

return: object JDatabase

_createMailer()   X-Ref
Create a mailer object

return: object JMail

_createTemplate($files = array()   X-Ref
Create a template object

param: array An array of support template files to load
return: object JTemplate

_createLanguage()   X-Ref
Create a language object

return: object JLanguage

_createDocument()   X-Ref
Create a document object

return: object JDocument



Generated: Wed Mar 28 15:54:07 2012 Cross-referenced by PHPXref 0.7.1