[ Index ]

PHP Cross Reference of Joomla 2.5.4 DE

title

Body

[close]

/libraries/joomla/ -> factory.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
File Size: 922 lines (20 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 29 functions

  getApplication()
  getConfig()
  getSession()
  getLanguage()
  getDocument()
  getUser()
  getCache()
  getACL()
  getDbo()
  getMailer()
  getFeedParser()
  getXMLParser()
  getXML()
  getEditor()
  getURI()
  getDate()
  _createConfig()
  createConfig()
  _createSession()
  createSession()
  _createDbo()
  createDbo()
  _createMailer()
  createMailer()
  _createLanguage()
  createLanguage()
  _createDocument()
  createDocument()
  getStream()

Functions
Functions that are not part of a class:

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

Returns 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.
param: string  $prefix  Application prefix
return: JApplication object

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

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

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

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

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

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

getLanguage()   X-Ref
Get a language object.

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

return: JLanguage object

getDocument()   X-Ref
Get a document object.

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

return: JDocument object

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

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

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

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

Returns the global {@link JCache} object

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

getACL()   X-Ref
Get an authorization object

Returns the global {@link JACL} object, only creating it
if it doesn't already exist.

return: JACL object

getDbo()   X-Ref
Get a database object.

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

return: JDatabase object

getMailer()   X-Ref
Get a mailer object.

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

return: JMail object

getFeedParser($url, $cache_time = 0)   X-Ref
Get a parsed XML Feed Source

param: string   $url         Url for feed source.
param: integer  $cache_time  Time to cache feed for (using internal cache mechanism).
return: mixed  SimplePie parsed object on success, false on failure.

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

param: string  $type     The type of XML parser needed 'DOM', 'RSS' or 'Simple'
param: array   $options  ['rssUrl'] the rss url to parse when using "RSS", ['cache_time'] with '
return: object  Parsed XML document object

getXML($data, $isFile = true)   X-Ref
Reads a XML file.

param: string   $data    Full path and file name.
param: boolean  $isFile  true to load a file or false to load a string.
return: mixed    JXMLElement on success or false on error.

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: JEditor object

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

param: string  $uri  Uri name.
return: JURI object

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

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

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

param: string  $file       The path to the configuration file.
param: string  $type       The type of the configuration file.
param: string  $namespace  The namespace of the configuration file.
return: JRegistry

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

param: string  $file       The path to the configuration file.
param: string  $type       The type of the configuration file.
param: string  $namespace  The namespace of the configuration file.
return: JRegistry

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

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

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

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

_createDbo()   X-Ref
Create an database object

return: JDatabase object

createDbo()   X-Ref
Create an database object

return: JDatabase object

_createMailer()   X-Ref
Create a mailer object

return: JMail object

createMailer()   X-Ref
Create a mailer object

return: JMail object

_createLanguage()   X-Ref
Create a language object

return: JLanguage object

createLanguage()   X-Ref
Create a language object

return: JLanguage object

_createDocument()   X-Ref
Create a document object

return: JDocument object

createDocument()   X-Ref
Create a document object

return: JDocument object

getStream($use_prefix = true, $use_network = true, $ua = null, $uamask = false)   X-Ref
Creates a new stream object with appropriate prefix

param: boolean  $use_prefix   Prefix the connections for writing
param: boolean  $use_network  Use network if available for writing; use false to disable (e.g. FTP, SCP)
param: string   $ua           UA User agent to use
param: boolean  $uamask       User agent masking (prefix Mozilla)
return: JStream



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