Class JFactory

Joomla Platform Factory class.

Abstract
Package: Joomla\Platform
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 11.1
Located at joomla/factory.php

Methods summary

`public static JApplicationCms`	# `getApplication( mixed $id = null, array $config = array(), string $prefix = 'J' )` Get an application object. Get an application object. Returns the global `JApplicationCms` object, only creating it if it doesn't already exist. Parameters `$id` `mixed` - $id A client identifier or name. `$config` `array` - $config An optional associative array of configuration settings. `$prefix` `string` - $prefix Application prefix Returns `JApplicationCms` - object Throws `Exception` Since 11.1 See `JApplication`
`public static Joomla\Registry\Registry`	# `getConfig( string $file = null, string $type = 'PHP', string $namespace = '' )` Get a configuration object Get a configuration object Returns the global JConfig object, only creating it if it doesn't already exist. Parameters `$file` `string` - $file The path to the configuration file `$type` `string` - $type The type of the configuration file `$namespace` `string` - $namespace The namespace of the configuration file Returns `Joomla\Registry\Registry` Since 11.1 See `Joomla\Registry\Registry`
`public static JSession`	# `getSession( array $options = array() )` Get a session object. Get a session object. Returns the global `JSession` object, only creating it if it doesn't already exist. Parameters `$options` `array` - $options An array containing session options Returns `JSession` - object Since 11.1 See `JSession`
`public static JLanguage`	# `getLanguage( )` Get a language object. Get a language object. Returns the global `JLanguage` object, only creating it if it doesn't already exist. Returns `JLanguage` - object Since 11.1 See `JLanguage`
`public static JDocument`	# `getDocument( )` Get a document object. Get a document object. Returns the global `JDocument` object, only creating it if it doesn't already exist. Returns `JDocument` - object Since 11.1 See `JDocument`
`public static JUser`	# `getUser( integer $id = null )` Get a user object. Get a user object. Returns the global `JUser` object, only creating it if it doesn't already exist. Parameters `$id` `integer` - $id The user to load - Can be an integer or string - If string, it is converted to ID automatically. Returns `JUser` - object Since 11.1 See `JUser`
`public static JCacheController`	# `getCache( string $group = '', string $handler = 'callback', string $storage = null )` Get a cache object Get a cache object Returns the global `JCacheController` object Parameters `$group` `string` - $group The cache group name `$handler` `string` - $handler The handler to use `$storage` `string` - $storage The storage method Returns `JCacheController` - object Since 11.1 See `JCache`
`public static JAccess`	# `getAcl( )` Get an authorization object Get an authorization object Returns the global `JAccess` object, only creating it if it doesn't already exist. Deprecated 13.3 (Platform) & 4.0 (CMS) - Use JAccess directly. Returns `JAccess` - object
`public static JDatabaseDriver`	# `getDbo( )` Get a database object. Get a database object. Returns the global `JDatabaseDriver` object, only creating it if it doesn't already exist. Returns `JDatabaseDriver` Since 11.1 See `JDatabaseDriver`
`public static JMail`	# `getMailer( )` Get a mailer object. Get a mailer object. Returns the global `JMail` object, only creating it if it doesn't already exist. Returns `JMail` - object Since 11.1 See `JMail`
`public static mixed`	# `getFeedParser( string $url, integer $cache_time = 0 )` Get a parsed XML Feed Source Get a parsed XML Feed Source Deprecated 4.0 Use directly JFeedFactory or supply SimplePie instead. Mehod will be proxied to JFeedFactory beginning in 3.2 Parameters `$url` `string` - $url Url for feed source. `$cache_time` `integer` - $cache_time Time to cache feed for (using internal cache mechanism). Returns `mixed` - SimplePie parsed object on success, false on failure. Throws `BadMethodCallException` Since 11.1
`public static mixed`	# `getXml( string $data, boolean $isFile = true )` Reads a XML file. Reads a XML file. Deprecated 13.3 (Platform) & 4.0 (CMS) - Use SimpleXML directly. Parameters `$data` `string` - $data Full path and file name. `$isFile` `boolean` - $isFile true to load a file or false to load a string. Returns `mixed` - JXMLElement or SimpleXMLElement on success or false on error. Since 11.1 See `JXMLElement` Note When JXMLElement is not present a SimpleXMLElement will be returned.
`public static JEditor`	# `getEditor( string $editor = null )` Get an editor object. Get an editor object. Deprecated 12.3 (Platform) & 4.0 (CMS) - Use JEditor directly Parameters `$editor` `string` - $editor The editor to load, depends on the editor plugins that are installed Returns `JEditor` - instance of JEditor Throws `BadMethodCallException` Since 11.1
`public static JUri`	# `getUri( string $uri = 'SERVER' )` Return a reference to the `JUri` object Return a reference to the `JUri` object Deprecated 13.3 (Platform) & 4.0 (CMS) - Use JUri directly. Parameters `$uri` `string` - $uri Uri name. Returns `JUri` - object Since 11.1 See `JUri`
`public static JDate`	# `getDate( mixed $time = 'now', mixed $tzOffset = null )` Return the `JDate` object Return the `JDate` object Parameters `$time` `mixed` - $time The initial time for the JDate object `$tzOffset` `mixed` - $tzOffset The timezone offset. Returns `JDate` - object Since 11.1 See `JDate`
`protected static Joomla\Registry\Registry`	# `createConfig( string $file, string $type = 'PHP', string $namespace = '' )` Create a configuration object Create a configuration object Parameters `$file` `string` - $file The path to the configuration file. `$type` `string` - $type The type of the configuration file. `$namespace` `string` - $namespace The namespace of the configuration file. Returns `Joomla\Registry\Registry` Since 11.1 See `Joomla\Registry\Registry`
`protected static JSession`	# `createSession( array $options = array() )` Create a session object Create a session object Parameters `$options` `array` - $options An array containing session options Returns `JSession` - object Since 11.1
`protected static JDatabaseDriver`	# `createDbo( )` Create an database object Create an database object Returns `JDatabaseDriver` Since 11.1 See `JDatabaseDriver`
`protected static JMail`	# `createMailer( )` Create a mailer object Create a mailer object Returns `JMail` - object Since 11.1 See `JMail`
`protected static JLanguage`	# `createLanguage( )` Create a language object Create a language object Returns `JLanguage` - object Since 11.1 See `JLanguage`
`protected static JDocument`	# `createDocument( )` Create a document object Create a document object Returns `JDocument` - object Since 11.1 See `JDocument`
`public static JStream`	# `getStream( boolean $use_prefix = true, boolean $use_network = true, string $ua = null, boolean $uamask = false )` Creates a new stream object with appropriate prefix Creates a new stream object with appropriate prefix Parameters `$use_prefix` `boolean` - $use_prefix Prefix the connections for writing `$use_network` `boolean` - $use_network Use network if available for writing; use false to disable (e.g. FTP, SCP) `$ua` `string` - $ua UA User agent to use `$uamask` `boolean` - $uamask User agent masking (prefix Mozilla) Returns `JStream` Since 11.1 See `JStream`

Magic methods summary

Properties summary

`public static JApplicationCms`	`$application`	# Global application object Global application object Since 11.1
`public static JCache`	`$cache`	# Global cache object Global cache object Since 11.1
`public static JConfig`	`$config`	# Global configuraiton object Global configuraiton object Since 11.1
`public static array`	`$dates`	# Container for JDate instances Container for JDate instances Since 11.3
`public static JSession`	`$session`	# Global session object Global session object Since 11.1
`public static JLanguage`	`$language`	# Global language object Global language object Since 11.1
`public static JDocument`	`$document`	# Global document object Global document object Since 11.1
`public static JAccess`	`$acl`	# Global ACL object Global ACL object Deprecated 13.3 (Platform) & 4.0 (CMS) Since 11.1
`public static JDatabaseDriver`	`$database`	# Global database object Global database object Since 11.1
`public static JMail`	`$mailer`	# Global mailer object Global mailer object Since 11.1

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JFactory

Methods summary

Parameters

Returns

Throws

Since

See

Parameters

Returns

Since

See

Parameters

Returns

Since

See

Returns

Since

See

Returns

Since

See

Parameters

Returns

Since

See

Parameters

Returns

Since

See

Deprecated

Returns

Returns

Since

See

Returns

Since

See

Deprecated

Parameters

Returns

Throws

Since

Deprecated

Parameters

Returns

Since

See

Note

Deprecated

Parameters

Returns

Throws

Since

Deprecated

Parameters

Returns

Since

See

Parameters

Returns

Since

See

Parameters

Returns

Since

See

Parameters

Returns

Since

Returns

Since

See

Returns

Since