Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de la classe InstallerHelper
+ Graphe d'héritage de InstallerHelper:

Fonctions membres publiques statiques

static getExtensionTypes ()
 
static getExtensionGroups ()
 
static getClientOptions ()
 
static getStateOptions ()
 
static getInstallationXML (string $element, string $type, int $clientId=1, ?string $folder=null)
 
static getDownloadKey (CMSObject $extension)
 
static getExtensionDownloadKey (string $element, string $type, int $clientId=1, ?string $folder=null)
 
static getDownloadKeySupportedSites ($onlyEnabled=false)
 
static getDownloadKeyExistsSites (bool $exists=true, $onlyEnabled=false)
 

Fonctions membres protégées statiques

static getUpdateSitesInformation (bool $onlyEnabled)
 

Description détaillée

Installer helper.

Depuis
1.6

Documentation des fonctions membres

◆ getClientOptions()

static getClientOptions ( )
static

Get a list of filter options for the application clients.

Renvoie
array An array of elements.
Depuis
3.5

Références $options, Text\_(), et HTMLHelper\_().

Référencé par LocationField\getOptions().

◆ getDownloadKey()

static getDownloadKey ( CMSObject  $extension)
static

Get the download key of an extension going through their installation xml

Paramètres
CMSObject$extensionelement of an extension
Renvoie
array An array with the prefix, suffix and value of the download key
Depuis
4.0.0

Références $extension, $prefix, $suffix, $value, et true.

Référencé par UpdatesiteModel\getItem(), et UpdatesitesModel\getItems().

◆ getDownloadKeyExistsSites()

static getDownloadKeyExistsSites ( bool  $exists = true,
  $onlyEnabled = false 
)
static

Returns a list of update site IDs which are missing download keys. By default this returns all qualifying update sites, even if they are not enabled.

Paramètres
bool$exists[optional] If true, returns update sites with a valid download key. When false, returns update sites with an invalid / missing download key.
bool$onlyEnabled[optional] Set true to only returned enabled update sites.
Renvoie
int[]
Depuis
4.0.0

NOTE: The closures are not inlined because in this case the Joomla Code Style standard produces two mutually exclusive errors, making the file impossible to commit. Using closures in variables makes the code less readable but works around that issue.

Références $extension.

Référencé par UpdatesitesModel\getListQuery().

◆ getDownloadKeySupportedSites()

static getDownloadKeySupportedSites (   $onlyEnabled = false)
static

Returns a list of update site IDs which support download keys. By default this returns all qualifying update sites, even if they are not enabled.

Paramètres
bool$onlyEnabled[optional] Set true to only returned enabled update sites.
Renvoie
int[]
Depuis
4.0.0

NOTE: The closures are not inlined because in this case the Joomla Code Style standard produces two mutually exclusive errors, making the file impossible to commit. Using closures in variables makes the code less readable but works around that issue.

Références $extension.

Référencé par UpdatesitesModel\getListQuery().

◆ getExtensionDownloadKey()

static getExtensionDownloadKey ( string  $element,
string  $type,
int  $clientId = 1,
?string  $folder = null 
)
static

Get the download key of an extension given enough information to locate it in the #__extensions table

Paramètres
string$elementName of the extension, e.g. com_foo
string$typeThe type of the extension, e.g. component
int$clientId[optional] Joomla client for the extension, see the #__extensions table
string | null$folderExtension folder, only applies for 'plugin' type
Renvoie
array
Depuis
4.0.0

Références $clientId, $db, $extension, $folder, $query, $type, Factory\getDbo(), ParameterType\INTEGER, et ParameterType\STRING.

◆ getExtensionGroups()

static getExtensionGroups ( )
static

Get a list of filter options for the extension types.

Renvoie
array An array of objects.
Depuis
3.0

Références $db, $folder, $options, $query, HTMLHelper\_(), et Factory\getDbo().

Référencé par FolderField\getOptions().

◆ getExtensionTypes()

static getExtensionTypes ( )
static

Get a list of filter options for the extension types.

Renvoie
array An array of objects.
Depuis
3.0

Références $db, $options, $query, $type, Text\_(), HTMLHelper\_(), et Factory\getDbo().

Référencé par TypeField\getOptions().

◆ getInstallationXML()

static getInstallationXML ( string  $element,
string  $type,
int  $clientId = 1,
?string  $folder = null 
)
static

Get a list of filter options for the application statuses.

Paramètres
string$elementelement of an extension
string$typetype of an extension
integer$clientIdclient_id of an extension
string$folderfolder of an extension
Renvoie
SimpleXMLElement
Depuis
4.0.0

Références $clientId, $folder, $path, $type, JPATH_ADMINISTRATOR, JPATH_API, JPATH_SITE, et null.

Référencé par DatabaseModel\compareUpdateVersion(), DatabaseModel\fetchSchemaCache(), et DatabaseModel\fixUpdateVersion().

◆ getStateOptions()

static getStateOptions ( )
static

Get a list of filter options for the application statuses.

Renvoie
array An array of elements.
Depuis
3.5

Références $options, Text\_(), et HTMLHelper\_().

Référencé par ExtensionstatusField\getOptions().

◆ getUpdateSitesInformation()

static getUpdateSitesInformation ( bool  $onlyEnabled)
staticprotected

Get information about the update sites

Paramètres
bool$onlyEnabledOnly return enabled update sites
Renvoie
CMSObject[] List of update site and linked extension information
Depuis
4.0.0

Références $db, $enabled, $item, $items, $query, Factory\getDbo(), et ParameterType\INTEGER.


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