Fonctions membres publiques statiques
static	getApplication ()

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

static	getContainer ()

static	getSession (array $options=array())

static	getLanguage ()

static	getDocument ()

static	getUser ($id=null)

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

static	getDbo ()

static	getMailer ()

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

static	getStream ($usePrefix=true, $useNetwork=true, $userAgentSuffix='Joomla', $maskUserAgent=false)

Attributs publics statiques
static	$application = null

static	$cache = null

static	$config = null

static	$container = null

static	$dates = array()

static	$session = null

static	$language = null

static	$document = null

static	$database = null

static	$mailer = null

Fonctions membres protégées statiques
static	createConfig ($file, $type='PHP', $namespace='')

static	createContainer ()

static	createDbo ()

static	createMailer ()

static	createLanguage ()

static	createDocument ()

Description détaillée

Joomla Platform Factory class.

Depuis: 1.7.0

Documentation des fonctions membres

◆ createConfig()

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

staticprotected

Create a configuration object

Paramètres

string	$file	The path to the configuration file.
string	$type	The type of the configuration file.
string	$namespace	The namespace of the configuration file.

Renvoie: Registry

Voir également: Registry

Depuis: 1.7.0

Obsolète:: 5.0 Use the configuration object within the application.

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

◆ createContainer()

static createContainer ( )

staticprotected

Create a container object

Renvoie: Container

Depuis: 4.0.0

Références $container.

◆ createDbo()

static createDbo ( )

staticprotected

Create a database object

Renvoie: DatabaseDriver

Voir également: DatabaseDriver

Depuis: 1.7.0

Obsolète:: 5.0 Use the database service in the DI container

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

◆ createDocument()

createDocument ( )

staticprotected

Create a document object

Renvoie: Document object

Voir également: Document

Depuis: 1.7.0

Obsolète:: 5.0 Load the document service from the dependency injection container or via $app->getDocument()

Creates a new Document object for the requested format.

Paramètres

string	$type	The document type to instantiate
array	$attributes	Array of attributes

Renvoie: Document

Depuis: 4.0.0

Références $attributes, $input, $lang, $type, $version, class, et Joomla\DI\getContainer().

◆ createLanguage()

static createLanguage ( )

staticprotected

Create a language object

Renvoie: Language object

Voir également: Language

Depuis: 1.7.0

Obsolète:: 5.0 Load the language service from the dependency injection container or via $app->getLanguage()

Références $lang, class, et Joomla\DI\getContainer().

◆ createMailer()

static createMailer ( )

staticprotected

Create a mailer object

Renvoie: Mail object

Voir également: Mail

Depuis: 1.7.0

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

◆ getApplication()

static getApplication ( )

static

Get the global application object. When the global application doesn't exist, an exception is thrown.

Renvoie: CMSApplicationInterface object

Depuis: 1.7.0

Exceptions

Exemples:: C:/laragon/www/_install/Joomla_422-Stable-Full_Package_French_v1/libraries/src/HTML/HTMLHelper.php.

◆ getCache()

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

static

Get a cache object

Returns the global CacheController object

Paramètres

string	$group	The cache group name
string	$handler	The handler to use
string	$storage	The storage method

Renvoie: object

Voir également: Cache

Depuis: 1.7.0

Obsolète:: 5.0 Use the cache controller factory instead

Références $hash, $options, class, et Joomla\DI\getContainer().

Référencé par MessagesModel\addPostInstallationMessage(), MessagesModel\archiveMessage(), LanguageAdapter\discover_install(), LanguageAdapter\finaliseUninstall(), MessagesModel\hideMessages(), CacheModel\purge(), MessagesModel\republishMessage(), MessagesModel\resetMessages(), ApplicationModel\save(), Filter\select(), MessagesModel\unpublishMessage(), et LanguageAdapter\update().

◆ 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@since1.7.0\xrefitemdeprecated163.

If there is an application object, fetch the configuration from there. Check it's not null because LanguagesModel can make it null and if it's null we would want to re-init it from configuration.php.

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

◆ getContainer()

static getContainer ( )

static

Get a container object

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

This method is only suggested for use in code whose responsibility is to create new services and needs to be able to resolve the dependencies, and should therefore only be used when the container is not accessible by other means. Valid uses of this method include:

A static getInstance() method calling a factory service from the container, see Joomla\CMS\Toolbar\Toolbar::getInstance() as an example
An application front controller loading and executing the Joomla application class, see the cli/joomla.php file as an example
Retrieving optional constructor dependencies when not injected into a class during a transitional period to retain backward compatibility, in this case a deprecation notice should also be emitted to notify developers of changes needed in their code

This method is not suggested for use as a one-for-one replacement of static calls, such as replacing calls to Factory::getDbo() with calls to ‘Factory::getContainer()->get('db’)`, code should be refactored to support dependency injection instead of making this change.

Renvoie: Container

Depuis: 4.0.0

Exemples:: C:/laragon/www/_install/Joomla_422-Stable-Full_Package_French_v1/libraries/src/HTML/HTMLHelper.php.

Références $container.

Référencé par SitePathway\__construct(), CredentialRepository\__construct(), SiteRouter\__construct(), SiteMenu\__construct(), Editor\__construct(), Toolbar\__construct(), Authentication\__construct(), CliApplication\__construct(), Indexer\__construct(), Task\__construct(), Query\__construct(), Document\__construct(), Categories\_load(), MethodsController\assertLoggedInUser(), MethodController\assertLoggedInUser(), Uri\base(), Mfa\canAddEditMethod(), Mfa\canDeleteMethod(), FieldModel\checkDefaultValue(), MVCFactory\createModel(), MVCFactory\createTable(), ExecRuleHelper\dateTimeToSql(), MfaTable\delete(), MethodController\delete(), AbstractView\dispatchEvent(), BaseDatabaseModel\dispatchEvent(), MethodsController\display(), CredentialRepository\formatDate(), MethodsModel\formatRelative(), Joomla\CMS\Cache\getCacheControllerFactory(), SysinfoModel\getExtensions(), ContactModel\getForm(), Pathway\getInstance(), CacheController\getInstance(), Cache\getInstance(), Router\getInstance(), AbstractMenu\getInstance(), Toolbar\getInstance(), Installer\getInstance(), BaseController\getInstance(), User\getInstance(), Table\getInstance(), Language\getInstance(), CMSApplication\getInstance(), Form\getInstance(), MenusHelper\getMenuItems(), MethodsModel\getMethods(), FinderHelper\getQuery(), CaptiveModel\getRecords(), AbstractRenderer\getRenderer(), HTMLHelper\getServiceRegistry(), Joomla\Plugin\System\Webauthn\PluginTraits\getUserFromData(), UserHelper\hashPassword(), Route\link(), AbstractRenderer\loadDocument(), Form\loadField(), Joomla\CMS\MVC\Model\loadForm(), BackupcodesModel\regenerateBackupCodes(), Email\sendCode(), InstallerAdapter\setupScriptfile(), FormModel\validate(), FormField\validate(), et Credentials\verifyAttestation().

◆ getDate()

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

static

Return the Date object

Paramètres

mixed	$time	The initial time for the Date object
mixed	$tzOffset	The timezone offset.

Renvoie: Date object

Voir également: Date

Depuis: 1.7.0

Exemples:: C:/laragon/www/_install/Joomla_422-Stable-Full_Package_French_v1/libraries/src/HTML/HTMLHelper.php.

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

Référencé par Response\__construct(), BannerTable\__construct(), Task\acquireLock(), PlgSampledataMultilang\addArticle(), PlgSampledataMultilang\addCategory(), ActionlogModel\addLog(), LinksModel\batchProcess(), User\bind(), ContactModel\buildContactExtendedData(), TagTable\check(), NewsfeedTable\check(), FilterTable\check(), CoreContent\check(), BannerTable\check(), GroupTable\check(), TaskTable\check(), FieldTable\check(), Category\check(), User\check(), Content\check(), Table\checkOut(), ResetModel\checkResetLimit(), BannerModel\click(), TemplateModel\createTemplateOverride(), HTMLHelper\date(), TasksListCommand\doExecute(), LinkModel\duplicateUrls(), Icon\edit(), Query\explained(), CalendarField\filter(), ContactTable\generateAlias(), AssociationHelper\getAssociations(), PlgSystemTasknotification\getDataFromTask(), LocalAdapter\getDate(), WorkflowModel\getForm(), CalendarField\getInput(), NewsfeedModel\getItem(), ArticleModel\getItem(), ContactModel\getItem(), TagsPopularHelper\getList(), TagsSimilarHelper\getList(), ArticlesArchiveHelper\getList(), BannersModel\getListQuery(), FeaturedModel\getListQuery(), TasksModel\getListQuery(), SearchModel\getListQuery(), PrivacyStatusHelper\getNumberUrgentRequests(), RequestsModel\getNumberUrgentRequests(), Indexer\getState(), TagsHelper\getTagItemsQuery(), TaskModel\getTask(), ArchiveModel\getYears(), BannersModel\impress(), Indexer\index(), ExecRuleHelper\nextExec(), PlgSystemActionLogs\onAfterRespond(), PlgContentPagenavigation\onContentBeforeDisplay(), NewsfeedModel\prepareTable(), BannerModel\prepareTable(), ArticleModel\prepareTable(), ContactModel\prepareTable(), Query\processDates(), Query\processString(), WorkflowModel\publish(), Table\publish(), MessagesModel\purge(), RssRenderer\render(), PublishedButton\render(), AtomRenderer\render(), FeaturedButton\render(), MessageModel\save(), TaskModel\save(), WorkflowModel\setDefault(), User\setLastVisit(), ConsentTable\store(), NoteTable\store(), RequestTable\store(), ContentHistory\store(), ContactTable\store(), FilterTable\store(), LinkTable\store(), TaskTable\store(), NewsfeedTable\store(), TagTable\store(), Menu\store(), WorkflowTable\store(), CoreContent\store(), Category\store(), Content\store(), et CalendarRule\test().

◆ getDbo()

static getDbo ( )

static

Get a database object.

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

Renvoie: DatabaseDriver

Voir également: DatabaseDriver

Depuis: 1.7.0

Obsolète:: 5.0 Load the database service from the dependency injection container

Exemples:: C:/laragon/www/_install/Joomla_422-Stable-Full_Package_French_v1/libraries/src/HTML/HTMLHelper.php.

Références Joomla\DI\getContainer(), et Symfony\Contracts\Service\has().

Référencé par AdapterInstance\__construct(), Adapter\__construct(), BaseDatabaseModel\__construct(), UCMType\__construct(), DatabaseLogger\__construct(), CMSPlugin\__construct(), Workflow\__construct(), ExtensionAdapter\_endElement(), Update\_endElement(), UserHelper\activateUser(), Helper\addContentType(), Taxonomy\addMap(), UserHelper\addUserToGroup(), Access\assetgroups(), AdministratorService\association(), Menus\association(), HTMLHelper\calendar(), ContentHelper\canDeleteState(), Category\categories(), Access\cleanAssetKey(), TagsHelper\convertPathsToNames(), NewsfeedsHelper\countItems(), ContentHelper\countRelations(), NewsfeedsHelper\countTagItems(), MailTemplate\createTemplate(), Versioning\delete(), UCMContent\delete(), MailTemplate\deleteTemplate(), HtmlView\display(), Users\editor(), PluginsHelper\elementOptions(), WorkflowStage\existing(), ContentLanguage\existing(), PluginsHelper\folderOptions(), ListHelper\genericordering(), Versioning\get(), ModulesModel\getActivePositions(), ConfigHelper\getAllComponents(), Access\getAssetId(), Access\getAssetName(), Access\getAssetRules(), FieldsHelper\getAssignedCategoriesIds(), FieldsHelper\getAssignedCategoriesTitles(), AssociationsHelper\getAssociationHtmlList(), CategoriesHelper\getAssociations(), AssociationHelper\getAssociations(), Associations\getAssociations(), User\getAuthorisedCategories(), Access\getAuthorisedViewLevels(), Taxonomy\getBranchTitles(), BannersHelper\getClientOptions(), Helper\getCommonWords(), DebugHelper\getComponents(), MultilangstatusHelper\getContacts(), MultilangstatusHelper\getContentlangs(), ExtensionHelper\getCoreExtensionIds(), PrivacyDashboardHelper\getData(), MultilangstatusHelper\getDefaultHomeModule(), AssociationsHelper\getEnabledExtensions(), InstallerHelper\getExtensionDownloadKey(), InstallerHelper\getExtensionGroups(), ExtensionHelper\getExtensionRecord(), InstallerHelper\getExtensionTypes(), FieldsHelper\getFieldsPluginId(), Access\getGroupsByUser(), Access\getGroupTitle(), MultilangstatusHelper\getHomes(), Table\getInstance(), InstallerScript\getInstances(), InstallerScript\getItemArray(), TagsHelper\getItemTags(), MultilangstatusHelper\getLangswitchers(), CMSHelper\getLanguageId(), StatsHelper\getList(), TagsPopularHelper\getList(), ArticlesArchiveHelper\getList(), TagsSimilarHelper\getList(), ArticlesCategoryHelper\getList(), ContenthistoryHelper\getLookupValue(), MenusHelper\getMenuLinks(), MenusHelper\getMenuTypes(), MultilangstatusHelper\getModule(), ModulesHelper\getModules(), Taxonomy\getNodeByTitle(), PrivacyStatusHelper\getNumberUrgentRequests(), WhosonlineHelper\getOnlineCount(), WhosonlineHelper\getOnlineUserNames(), ModulesHelper\getPositions(), UCMContent\getPrimaryKey(), PrivacyHelper\getPrivacyConsentPluginId(), QueryHelper\getQueryDate(), RedirectHelper\getRedirectPluginId(), PrivacyStatusHelper\getRequestFormPublished(), Multilanguage\getSiteHomePages(), Updater\getSitesWithUpdates(), Indexer\getState(), MultilangstatusHelper\getStatus(), TagsHelper\getTagIds(), TagsHelper\getTagItemsQuery(), TagsHelper\getTagNames(), Taxonomy\getTaxonomy(), MailTemplate\getTemplate(), TemplatesHelper\getTemplateOptions(), ModulesHelper\getTemplates(), TagsHelper\getTypes(), InstallerHelper\getUpdateSitesInformation(), UserHelper\getUserId(), UsersLatestHelper\getUsers(), Access\getUsersByGroup(), UsersHelper\getVisibleByGroups(), Table\isCheckedOut(), Multilanguage\isEnabled(), Access\level(), Menu\linkOptions(), UserGroupsHelper\load(), ActionlogsHelper\loadActionLogPluginsLanguage(), UserGroupsHelper\loadAll(), LanguageHelper\loadPluginLanguage(), MenusHelper\loadXml(), FinderHelper\logSearch(), Menu\menuItems(), Menu\menus(), ContentHelper\onPrepareForm(), Category\options(), Tag\options(), QueryHelper\orderbySecondary(), Menu\ordering(), ModuleController\orderPosition(), Modules\positionList(), Access\preloadComponents(), Access\preloadPermissions(), Taxonomy\removeMaps(), Taxonomy\removeOrphanMaps(), Taxonomy\removeOrphanNodes(), PublishedButton\render(), MenusHelper\resolveAlias(), MenusController\resync(), LibraryHelper\saveParams(), TagsHelper\searchTags(), InstallerScript\setParams(), UserHelper\setUserGroups(), Taxonomy\storeNode(), TagsHelper\tagDeleteInstances(), Tag\tags(), Users\templatestyle(), Date\toSql(), UserGroupsHelper\total(), TagsHelper\unTagItem(), Updater\updateLastCheckTimestamp(), MailTemplate\updateTemplate(), User\userlist(), et ListHelper\users().

◆ getDocument()

static getDocument ( )

static

Get a document object.

Returns the global Joomla\CMS\Document\Documentobject,onlycreatingitifitdoesn'talreadyexist.@returnDocumentobject@seeDocument@since1.7.0\xrefitemdeprecated166.

Références $document.

Référencé par FormBehavior\ajaxchosen(), Tag\ajaxfield(), Bootstrap\alert(), Bootstrap\button(), Bootstrap\carousel(), Email\cloak(), Bootstrap\collapse(), Behavior\combobox(), AdministratorApplication\dispatch(), ApiApplication\dispatch(), CategoryFeedView\display(), DraggableList\draggable(), Bootstrap\dropdown(), SearchTools\form(), Behavior\formvalidator(), Select\genericlist(), FiltersField\getInput(), ModulepositionField\getInput(), CalendarField\getLayoutData(), Cache\getWorkarounds(), Behavior\highlighter(), Dropdown\init(), Bootstrap\loadCss(), WebApplication\loadDocument(), Bootstrap\modal(), Behavior\multiselect(), Bootstrap\offcanvas(), Bootstrap\popover(), PopupButton\renderButton(), Text\script(), Bootstrap\scrollspy(), Cache\setWorkarounds(), Bootstrap\startAccordion(), UiTab\startTabSet(), Bootstrap\tab(), ToolbarHelper\title(), Bootstrap\toast(), Jquery\token(), et Bootstrap\tooltip().

◆ getLanguage()

static getLanguage ( )

static

Get a language object.

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

Renvoie: Language object

Voir également: Language

Depuis: 1.7.0

Obsolète:: 5.0 Load the language service from the dependency injection container or via $app->getLanguage()

Exemples:: C:/laragon/www/_install/Joomla_422-Stable-Full_Package_French_v1/libraries/src/HTML/HTMLHelper.php.

Références $language.

◆ getMailer()

static getMailer ( )

static

Get a mailer object.

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

Renvoie: Mail object

Voir également: Mail

Depuis: 1.7.0

Référencé par MailTemplate\__construct(), Email\sendCode(), et ApplicationModel\sendTestMail().

◆ 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 $options An array containing session options

Renvoie: Session object

Voir également: Session

Depuis: 1.7.0

Obsolète:: 5.0 Load the session service from the dependency injection container or via $app->getSession()

Référencé par UserHelper\addUserToGroup(), DatabaseHelper\checkRemoteDbHost(), ConfigurationModel\createConfiguration(), DatabaseModel\createDatabase(), ConfigurationModel\generateRandUserId(), ClientHelper\getCredentials(), PrefixField\getInput(), SetupModel\getOptions(), DatabaseModel\getOptions(), ChecksModel\getOptions(), LanguagesModel\getOptions(), Indexer\getState(), ClientHelper\hasCredentials(), ConfigurationModel\resetRandUserId(), Indexer\resetState(), ClientHelper\setCredentials(), Indexer\setState(), UserHelper\setUserGroups(), SetupModel\storeOptions(), ContactController\submit(), et DatabaseHelper\validateConnectionParameters().

◆ getStream()

static getStream	(	$usePrefix = `true`,
		$useNetwork = `true`,
		$userAgentSuffix = `'Joomla'`,
		$maskUserAgent = `false`
	)

static

Creates a new stream object with appropriate prefix

Paramètres

boolean	$usePrefix	Prefix the connections for writing
boolean	$useNetwork	Use network if available for writing; use false to disable (e.g. FTP, SCP)
string	$userAgentSuffix	String to append to user agent
boolean	$maskUserAgent	User agent masking (prefix Mozilla)

Renvoie: Stream

Voir également: Stream

Depuis: 1.7.0

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

Référencé par File\append(), Folder\copy(), File\copy(), File\move(), Folder\move(), File\upload(), et File\write().

◆ 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 $id The user to load - Can be an integer or string - If string, it is converted to ID automatically.

Renvoie: User object

Voir également: User

Depuis: 1.7.0

Obsolète:: 5.0 Load the user service from the dependency injection container or via $app->getIdentity()

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

Documentation des champs

◆ $application

Joomla CMS $application = null

static

Référencé par Application\register().

◆ $cache

$cache = null

static

◆ $config

$config = null

static

Référencé par InstallationApplication\__construct().

◆ $container

$container = null

static

◆ $database

$database = null

static

Référencé par ConfigurationModel\setup().

◆ $dates

$dates = array()

static

◆ $document

$document = null

static

Référencé par AdministratorApplication\dispatch(), SiteApplication\dispatch(), InstallationApplication\dispatch(), ApiApplication\dispatch(), et InstallationApplication\loadDocument().

◆ $language

$language = null

static

Référencé par CMSApplication\initialiseApp(), AbstractRenderer\loadDocument(), InstalledController\setDefault(), et InstalledController\switchAdminLanguage().

◆ $mailer

$mailer = null

static

◆ $session

$session = null

static

La documentation de cette classe a été générée à partir des fichiers suivants :

Fonctions membres publiques statiques

Attributs publics statiques

Fonctions membres protégées statiques

Description détaillée

Documentation des fonctions membres

◆ createConfig()

◆ createContainer()

◆ createDbo()

◆ createDocument()

◆ createLanguage()

◆ createMailer()

◆ getApplication()

◆ getCache()

◆ getConfig()

◆ getContainer()

◆ getDate()

◆ getDbo()

◆ getDocument()

◆ getLanguage()

◆ getMailer()

◆ getSession()

◆ getStream()

◆ getUser()

Documentation des champs

◆ $application

◆ $cache

◆ $config

◆ $container

◆ $database

◆ $dates

◆ $document

◆ $language

◆ $mailer

◆ $session