[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/administrator/components/com_installer/src/Helper/ -> InstallerHelper.php (summary)

(no description)

Copyright: (C) 2017 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
File Size: 490 lines (16 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

InstallerHelper:: (11 methods):
  getExtensionTypes()
  getExtensionGroups()
  getClientOptions()
  getStateOptions()
  getPackageOptions()
  getInstallationXML()
  getDownloadKey()
  getExtensionDownloadKey()
  getDownloadKeySupportedSites()
  getDownloadKeyExistsSites()
  getUpdateSitesInformation()


Class: InstallerHelper  - X-Ref

Installer helper.

getExtensionTypes()   X-Ref
Get a list of filter options for the extension types.

return: array  An array of \stdClass objects.

getExtensionGroups()   X-Ref
Get a list of filter options for the extension types.

return: array  An array of \stdClass objects.

getClientOptions()   X-Ref
Get a list of filter options for the application clients.

return: array  An array of \JHtmlOption elements.

getStateOptions()   X-Ref
Get a list of filter options for the application statuses.

return: array  An array of \JHtmlOption elements.

getPackageOptions()   X-Ref
Get a list of filter options for extensions of the "package" type.

return: array

getInstallationXML(string $element,string $type,int $clientId = 1,?string $folder = null)   X-Ref
No description

getDownloadKey(CMSObject $extension)   X-Ref
Get the download key of an extension going through their installation xml

param: CMSObject  $extension  element of an extension
return: array  An array with the prefix, suffix and value of the download key

getExtensionDownloadKey(string $element,string $type,int $clientId = 1,?string $folder = null)   X-Ref
Get the download key of an extension given enough information to locate it in the #__extensions table

param: string       $element   Name of the extension, e.g. com_foo
param: string       $type      The type of the extension, e.g. component
param: int          $clientId  [optional] Joomla client for the extension, see the #__extensions table
param: string|null  $folder    Extension folder, only applies for 'plugin' type
return: array

getDownloadKeySupportedSites($onlyEnabled = false)   X-Ref
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: bool  $onlyEnabled  [optional] Set true to only returned enabled update sites.
return: int[]

getDownloadKeyExistsSites(bool $exists = true, $onlyEnabled = false)   X-Ref
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: bool  $exists       [optional] If true, returns update sites with a valid download key. When false,
param: bool  $onlyEnabled  [optional] Set true to only returned enabled update sites.
return: int[]

getUpdateSitesInformation(bool $onlyEnabled)   X-Ref
Get information about the update sites

param: bool  $onlyEnabled  Only return enabled update sites
return: CMSObject[]  List of update site and linked extension information



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer