Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe Factory

Fonctions membres publiques statiques

static getApplication ($id=null, array $config=array(), $prefix='J')
 
static getConfig ($file=null, $type='PHP', $namespace='')
 
static getSession (array $options=array())
 
static getLanguage ()
 
static getDocument ()
 
static getUser ($id=null)
 
static getCache ($group='', $handler='callback', $storage=null)
 
static getAcl ()
 
static getDbo ()
 
static getMailer ()
 
static getFeedParser ($url, $cache_time=0)
 
static getXml ($data, $isFile=true)
 
static getEditor ($editor=null)
 
static getUri ($uri='SERVER')
 
static getDate ($time='now', $tzOffset=null)
 
static getStream ($use_prefix=true, $use_network=true, $ua=null, $uamask=false)
 

Attributs publics statiques

static $application = null
 
static $cache = null
 
static $config = null
 
static $dates = array()
 
static $session = null
 
static $language = null
 
static $document = null
 
static $acl = null
 
static $database = null
 
static $mailer = null
 

Fonctions membres protégées statiques

static createConfig ($file, $type='PHP', $namespace='')
 
static createSession (array $options=array())
 
static createDbo ()
 
static createMailer ()
 
static createLanguage ()
 
static createDocument ()
 

Description détaillée

Joomla Platform Factory class.

Depuis
11.1

Documentation des fonctions membres

◆ createConfig()

static createConfig (   $file,
  $type = 'PHP',
  $namespace = '' 
)
staticprotected

Create a configuration object

Paramètres
string$fileThe path to the configuration file.
string$typeThe type of the configuration file.
string$namespaceThe namespace of the configuration file.
Renvoie
Registry
Voir également
Registry
Depuis
11.1

Références $config, $file, $name, et $type.

◆ createDbo()

static createDbo ( )
staticprotected

Create a database object

Renvoie
Voir également
Depuis
11.1

Références $db, $options, $password, $prefix, $user, et JDatabaseDriver\getInstance().

◆ createDocument()

static createDocument ( )
staticprotected

Create a document object

Renvoie
object
Voir également
Depuis
11.1

Références $attributes, $input, $lang, $type, et $version.

◆ createLanguage()

static createLanguage ( )
staticprotected

Create a language object

Renvoie
Language object
Voir également
Language
Depuis
11.1

Références $lang, et Language\getInstance().

◆ createMailer()

static createMailer ( )
staticprotected

Create a mailer object

Renvoie
object
Voir également
Depuis
11.1

Références Log\add(), MailHelper\cleanLine(), Mail\getInstance(), MailHelper\isEmailAddress(), null, et Log\WARNING.

◆ createSession()

static createSession ( array  $options = array())
staticprotected

Create a session object

Paramètres
array$optionsAn array containing session options
Renvoie
Session object
Depuis
11.1

Références $input, $options, et Session\getInstance().

◆ getAcl()

static getAcl ( )
static

Get an authorization object

Returns the global Access object, only creating it if it doesn't already exist.

Renvoie
Access object
Obsolète:
13.3 (Platform) & 4.0 (CMS) - Use JAccess directly.

Références Log\add(), et Log\WARNING.

◆ getApplication()

static getApplication (   $id = null,
array  $config = array(),
  $prefix = 'J' 
)
static

Get an application object.

Returns the global CMSApplication object, only creating it if it doesn't already exist.

Paramètres
mixed$idA client identifier or name.
array$configAn optional associative array of configuration settings.
string$prefixApplication prefix
Renvoie
CMSApplication object
Voir également
JApplication
Depuis
11.1
Exceptions

Références $id, Log\createDelegatedLogger(), et CMSApplication\getInstance().

Référencé par Route\_(), ExtensionAdapter\_endElement(), PlgSystemFields\display(), CollectionAdapter\findUpdate(), ExtensionAdapter\findUpdate(), CMSHelper\getCurrentLanguage(), ContentHelper\getCurrentLanguage(), FrontendlanguageField\getOptions(), TagField\getOptions(), UpdateAdapter\getUpdateSiteResponse(), HTMLHelper\includeRelativeFiles(), Mail\Send(), et CaptchaField\setup().

◆ getCache()

static getCache (   $group = '',
  $handler = 'callback',
  $storage = null 
)
static

Get a cache object

Returns the global CacheController object

Paramètres
string$groupThe cache group name
string$handlerThe handler to use
string$storageThe storage method
Renvoie
object
Voir également
JCache
Depuis
11.1

Références $hash, $options, et Cache\getInstance().

◆ getConfig()

static getConfig (   $file = null,
  $type = 'PHP',
  $namespace = '' 
)
static

Get a configuration object

Returns the global JConfigobject,onlycreatingitifitdoesn'talreadyexist.@paramstring$fileThepathtotheconfigurationfile@paramstring$typeThetypeoftheconfigurationfile@paramstring$namespaceThenamespaceoftheconfigurationfile@returnRegistry@seeRegistry@since11.1

Références $config, $file, $type, JPATH_CONFIGURATION, et null.

Référencé par HTMLHelper\date(), EditorField\getEditor(), HTMLHelper\includeRelativeFiles(), Mail\isSendmail(), Mail\Send(), et Mail\sendMail().

◆ getDate()

static getDate (   $time = 'now',
  $tzOffset = null 
)
static

Return the Date object

Paramètres
mixed$timeThe initial time for the JDate object
mixed$tzOffsetThe timezone offset.
Renvoie
Date object
Voir également
Date
Depuis
11.1

Références $date, $key, et $language.

Référencé par HTMLHelper\date().

◆ getDbo()

◆ getDocument()

static getDocument ( )
static

Get a document object.

Returns the global JDocumentobject,onlycreatingitifitdoesn'talreadyexist.@return\JDocumentobject@see\JDocument@since11.1

Références $document.

Référencé par HTMLHelper\calendar(), ModulepositionField\getInput(), Text\script(), HTMLHelper\script(), et HTMLHelper\stylesheet().

◆ getEditor()

static getEditor (   $editor = null)
static

Get an editor object.

Paramètres
string$editorThe editor to load, depends on the editor plugins that are installed
Renvoie
Editor instance of Editor
Depuis
11.1
Exceptions

Références $editor, Log\add(), Editor\getInstance(), et Log\WARNING.

◆ getFeedParser()

static getFeedParser (   $url,
  $cache_time = 0 
)
static

Get a parsed XML Feed Source

Paramètres
string$urlUrl for feed source.
integer$cache_timeTime to cache feed for (using internal cache mechanism).
Renvoie
mixed SimplePie parsed object on success, false on failure.
Depuis
11.1
Exceptions

Références $url, Log\add(), et Log\WARNING.

◆ getLanguage()

static getLanguage ( )
static

◆ getMailer()

static getMailer ( )
static

Get a mailer object.

Returns the global JMailobject,onlycreatingitifitdoesn'talreadyexist.@return\JMailobject@seeJMail@since11.1

◆ getSession()

static getSession ( array  $options = array())
static

Get a session object.

Returns the global Session object, only creating it if it doesn't already exist.

Paramètres
array$optionsAn array containing session options
Renvoie
Session object
Voir également
Session
Depuis
11.1

Références $options.

Référencé par CMSHelper\getCurrentLanguage(), et ContentHelper\getCurrentLanguage().

◆ getStream()

static getStream (   $use_prefix = true,
  $use_network = true,
  $ua = null,
  $uamask = false 
)
static

Creates a new stream object with appropriate prefix

Paramètres
boolean$use_prefixPrefix the connections for writing
boolean$use_networkUse network if available for writing; use false to disable (e.g. FTP, SCP)
string$uaUA User agent to use
boolean$uamaskUser agent masking (prefix Mozilla)
Renvoie
Voir également
Depuis
11.1

Références $context, $prefix, $version, elseif, JLoader\import(), et JPATH_ROOT.

◆ getUri()

static getUri (   $uri = 'SERVER')
static

Return a reference to the Uri object

Paramètres
string$uriUri name.
Renvoie
Uri object
Voir également
Uri
Depuis
11.1
Obsolète:
13.3 (Platform) & 4.0 (CMS) - Use JUri directly.

Références $uri, Log\add(), Uri\getInstance(), et Log\WARNING.

◆ getUser()

static getUser (   $id = null)
static

Get a user object.

Returns the global User object, only creating it if it doesn't already exist.

Paramètres
integer$idThe user to load - Can be an integer or string - If string, it is converted to ID automatically.
Renvoie
User object
Voir également
User
Depuis
11.1

Références $id, elseif, et User\getInstance().

Référencé par ContentHelper\_getActions(), HTMLHelper\date(), ContentHelper\getActions(), MenuField\getGroups(), UserField\getLayoutData(), FrontendlanguageField\getOptions(), UsergrouplistField\getOptions(), et UserField\setup().

◆ getXml()

static getXml (   $data,
  $isFile = true 
)
static

Reads a XML file.

Paramètres
string$dataFull path and file name.
boolean$isFiletrue to load a file or false to load a string.
Renvoie
mixed JXMLElement or SimpleXMLElement on success or false on error.
Voir également
JXMLElement
Depuis
11.1
Note
When JXMLElement is not present a SimpleXMLElement will be returned.
Obsolète:
13.3 (Platform) & 4.0 (CMS) - Use SimpleXML directly.

Références $class, $data, Log\add(), et Log\WARNING.

Documentation des champs

◆ $acl

$acl = null
static

◆ $application

$application = null
static

◆ $cache

$cache = null
static

◆ $config

$config = null
static

◆ $database

$database = null
static

◆ $dates

$dates = array()
static

◆ $document

$document = null
static

◆ $language

$language = null
static

◆ $mailer

$mailer = null
static

◆ $session

$session = null
static

La documentation de cette classe a été générée à partir du fichier suivant :