Joomla CMS  3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
Tout Structures de données Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe ModuleAdapter
+ Graphe d'héritage de ModuleAdapter:

Fonctions membres publiques

 getElement ($element=null)
 
 loadLanguage ($path=null)
 
 prepareDiscoverInstall ()
 
 discover ()
 
 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 protégées

 checkExistingExtension ()
 
 copyBaseFiles ()
 
 finaliseInstall ()
 
 parseOptionalTags ()
 
 setupInstallPaths ()
 
 _rollback_menu ($arg)
 
 _rollback_module ($arg)
 
- 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

 $clientId
 
 $scriptElement = null
 
- 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
 

Membres hérités additionnels

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

Description détaillée

Module installer

Depuis
3.1

Documentation des fonctions membres

◆ _rollback_menu()

_rollback_menu (   $arg)
protected

Custom rollback method

  • Roll back the menu item
Paramètres
array$argInstallation step to rollback
Renvoie
boolean True on success
Depuis
3.1

Références $db, $query, et parent.

◆ _rollback_module()

_rollback_module (   $arg)
protected

Custom rollback method

  • Roll back the module item
Paramètres
array$argInstallation step to rollback
Renvoie
boolean True on success
Depuis
3.1

Références $db, $query, et parent.

◆ checkExistingExtension()

checkExistingExtension ( )
protected

Method to check if the extension is already present in the database

Renvoie
void
Depuis
3.4
Exceptions

Références extension.

◆ 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 $path, et parent.

◆ discover()

discover ( )

Custom discover method

Renvoie
array Extension list of extensions available
Depuis
3.1

Références $extension, $module, $results, ApplicationHelper\getClientInfo(), Table\getInstance(), JPATH_ADMINISTRATOR, JPATH_SITE, json_encode, et Installer\parseXMLInstallFile().

◆ finaliseInstall()

finaliseInstall ( )
protected

Method to finalise the installation processing

Renvoie
void
Depuis
3.4
Exceptions

Références Table\getInstance(), et parent.

◆ 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

Références $file.

◆ loadLanguage()

loadLanguage (   $path = null)

Custom loadLanguage method

Paramètres
string$pathThe path where we find language files
Renvoie
void
Depuis
3.4

Références $client, $extension, $folder, $path, JPATH_ADMINISTRATOR, JPATH_SITE, et parent.

◆ parseOptionalTags()

parseOptionalTags ( )
protected

Method to parse optional tags in the manifest

Renvoie
void
Depuis
3.4

Références parent.

◆ prepareDiscoverInstall()

prepareDiscoverInstall ( )

Prepares the adapter for a discover_install task

Renvoie
void
Depuis
3.4

Références $client, ApplicationHelper\getClientInfo(), et 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 $client, ApplicationHelper\getClientInfo(), 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 $basePath, $client, ApplicationHelper\getClientInfo(), JPATH_SITE, et parent.

Documentation des champs

◆ $clientId

$clientId
protected

◆ $scriptElement

$scriptElement = null
protected

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