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 PackageAdapter
+ Graphe d'héritage de PackageAdapter:

Fonctions membres publiques

 getElement ($element=null)
 
 loadLanguage ($path)
 
 onExtensionAfterInstall (Installer $installer, $eid)
 
 uninstall ($id)
 
 refreshManifestCache ()
 
- Fonctions membres publiques hérités de InstallerAdapter
 __construct (Installer $parent, \JDatabaseDriver $db, array $options=array())
 
 discover_install ()
 
 getDiscoverInstallSupported ()
 
 getElement ($element=null)
 
 getManifest ()
 
 getName ()
 
 getRoute ()
 
 install ()
 
 prepareDiscoverInstall ()
 
 setManifest ($manifest)
 
 setRoute ($route)
 
 update ()
 
- Fonctions membres publiques hérités de JAdapterInstance
 __construct (JAdapter $parent, JDatabaseDriver $db, array $options=array())
 
 getParent ()
 

Fonctions membres protégées

 checkExtensionInFilesystem ()
 
 copyBaseFiles ()
 
 createExtensionRoot ()
 
 parseOptionalTags ()
 
 setupInstallPaths ()
 
 storeExtension ()
 
 triggerManifestScript ($method)
 
 _getExtensionId ($type, $id, $client, $group)
 
- Fonctions membres protégées hérités de InstallerAdapter
 canUninstallPackageChild ($packageId)
 
 checkExistingExtension ()
 
 checkExtensionInFilesystem ()
 
 copyBaseFiles ()
 
 createExtensionRoot ()
 
 doDatabaseTransactions ()
 
 doLoadLanguage ($extension, $source, $base=JPATH_ADMINISTRATOR)
 
 getScriptClassName ()
 
 parseQueries ()
 
 parseOptionalTags ()
 
 setupInstallPaths ()
 
 setupScriptfile ()
 
 setupUpdates ()
 
 storeExtension ()
 
 triggerManifestScript ($method)
 

Attributs protégés

 $installedIds = array()
 
 $results = array()
 
 $supportsDiscoverInstall = false
 
- Attributs protégés hérités de InstallerAdapter
 $currentExtensionId = null
 
 $element = null
 
 $extension = null
 
 $extensionMessage = ''
 
 $manifest_script = null
 
 $name = null
 
 $route = 'install'
 
 $supportsDiscoverInstall = true
 
 $type
 
- Attributs protégés hérités de JAdapterInstance
 $parent = null
 
 $db = null
 

Attributs privés statiques

static $eventRegistered = false
 

Membres hérités additionnels

- Champs de données hérités de InstallerAdapter
 $manifest = null
 

Description détaillée

Package installer

Depuis
3.1

Documentation des fonctions membres

◆ _getExtensionId()

_getExtensionId (   $type,
  $id,
  $client,
  $group 
)
protected

Gets the extension id.

Paramètres
string$typeThe extension type.
string$idThe name of the extension (the element field).
integer$clientThe application id (0: Joomla CMS site; 1: Joomla CMS administrator).
string$groupThe extension group (mainly for plugins).
Renvoie
integer
Depuis
3.1

Références $client, $db, $id, $query, $type, ApplicationHelper\getClientInfo(), et parent.

◆ checkExtensionInFilesystem()

checkExtensionInFilesystem ( )
protected

Method to check if the extension is present in the filesystem, flags the route as update if so

Renvoie
void
Depuis
3.4
Exceptions

Références elseif, JPATH_MANIFESTS, et parent.

◆ copyBaseFiles()

copyBaseFiles ( )
protected

Method to copy the extension's base files from the <files> tag(s) and the manifest file

Renvoie
void
Depuis
3.4
Exceptions

Références $file, $folder, InstallerHelper\detectType(), JEventDispatcher\getInstance(), Installer\install(), parent, et InstallerHelper\unpack().

◆ createExtensionRoot()

createExtensionRoot ( )
protected

Method to create the extension root path if necessary

Renvoie
void
Depuis
3.4
Exceptions

◆ getElement()

getElement (   $element = null)

Get the filtered extension element from the manifest

Paramètres
string$elementOptional element name to be converted
Renvoie
string The filtered element
Depuis
3.4

◆ loadLanguage()

loadLanguage (   $path)

Load language from a path

Paramètres
string$pathThe path of the language.
Renvoie
void
Depuis
3.1

Références $path.

◆ onExtensionAfterInstall()

onExtensionAfterInstall ( Installer  $installer,
  $eid 
)

Handler for the onExtensionAfterInstall event

Paramètres
Installer$installerInstaller instance managing the extension's installation
integer | boolean$eidThe extension ID of the installed extension on success, boolean false on install failure
Renvoie
void
Depuis
3.7.0

◆ parseOptionalTags()

parseOptionalTags ( )
protected

Method to parse optional tags in the manifest

Renvoie
void
Depuis
3.4

Références parent.

◆ refreshManifestCache()

refreshManifestCache ( )

Refreshes the extension table cache

Renvoie
boolean Result of operation, true if updated, false on failure
Depuis
3.1

Références JPATH_MANIFESTS, json_encode, parent, et Installer\parseXMLInstallFile().

◆ setupInstallPaths()

setupInstallPaths ( )
protected

Method to do any prechecks and setup the install paths for the extension

Renvoie
void
Depuis
3.4
Exceptions

Références JPATH_MANIFESTS, et parent.

◆ storeExtension()

storeExtension ( )
protected

Method to store the extension to the database

Renvoie
void
Depuis
3.4
Exceptions

Références $name, extension, name, et parent.

◆ triggerManifestScript()

triggerManifestScript (   $method)
protected

Executes a custom install script method

Paramètres
string$methodThe install method to execute
Renvoie
boolean True on success
Depuis
3.4

Références parent.

◆ uninstall()

uninstall (   $id)

Custom uninstall method

Paramètres
integer$idThe id of the package to uninstall.
Renvoie
boolean True on success
Depuis
3.1

Références $client, $extension, $folder, $id, $manifest, $row, JFile\delete(), JFolder\delete(), JFolder\exists(), ApplicationHelper\getClientInfo(), Table\getInstance(), if, JPATH_MANIFESTS, null, parent, JLoader\register(), et Installer\setPackageUninstall().

Documentation des champs

◆ $eventRegistered

$eventRegistered = false
staticprivate

◆ $installedIds

$installedIds = array()
protected

◆ $results

$results = array()
protected

◆ $supportsDiscoverInstall

$supportsDiscoverInstall = false
protected

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