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

Fonctions membres publiques

 discover ()
 
 getElement ($element=null)
 
 loadLanguage ($path=null)
 
 prepareDiscoverInstall ()
 
 refreshManifestCache ()
 
- Fonctions membres publiques hérités de InstallerAdapter
 __construct (Installer $parent, DatabaseDriver $db, array $options=array())
 
 discover_install ()
 
 getDiscoverInstallSupported ()
 
 getElement ($element=null)
 
 getManifest ()
 
 getName ()
 
 getParent ()
 
 getRoute ()
 
 install ()
 
 prepareDiscoverInstall ()
 
 setManifest ($manifest)
 
 setRoute ($route)
 
 uninstall ($id)
 
 update ()
 
 __get ($name)
 
- Fonctions membres publiques hérités de ContainerAwareInterface
 setContainer (Container $container)
 
- Fonctions membres publiques hérités de DatabaseAwareInterface
 setDatabase (DatabaseInterface $db)
 

Fonctions membres protégées

 checkExistingExtension ()
 
 copyBaseFiles ()
 
 finaliseInstall ()
 
 parseOptionalTags ()
 
 removeExtensionFiles ()
 
 setupInstallPaths ()
 
 setupUninstall ()
 
 _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)
 
 finaliseInstall ()
 
 finaliseUninstall ()
 
 getScriptClassName ()
 
 parseQueries ()
 
 parseOptionalTags ()
 
 removeExtensionFiles ()
 
 setupInstallPaths ()
 
 setupScriptfile ()
 
 setupUninstall ()
 
 setupUpdates ()
 
 storeExtension ()
 
 triggerManifestScript ($method)
 

Attributs protégés

 $clientId
 
 $scriptElement = null
 
- Attributs protégés hérités de InstallerAdapter
 $changelogurl = null
 
 $currentExtensionId = null
 
 $element = null
 
 $extension = null
 
 $extensionMessage = ''
 
 $manifest_script = null
 
 $name = null
 
 $parent = 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, $moduleId, $query, Joomla\Database\getDatabase(), et ParameterType\INTEGER.

◆ _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, $moduleId, $query, Joomla\Database\getDatabase(), et ParameterType\INTEGER.

◆ checkExistingExtension()

checkExistingExtension ( )
protected

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

Renvoie
void
Depuis
3.4
Exceptions

Références Text\_(), extension, et Text\sprintf().

◆ 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, $this, Text\_(), parent, et Text\sprintf().

◆ discover()

discover ( )

Custom discover method

Renvoie
array Extension list of extensions available
Depuis
3.1

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

◆ finaliseInstall()

finaliseInstall ( )
protected

Method to finalise the installation processing

Renvoie
void
Depuis
3.4
Exceptions

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

◆ getElement()

getElement (   $element = null)

Get the filtered extension element from the manifest

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

◆ 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, Text\_(), Log\add(), ApplicationHelper\getClientInfo(), parent, Installer\parseXMLInstallFile(), et Log\WARNING.

◆ removeExtensionFiles()

removeExtensionFiles ( )
protected

Removes this extension's files

Renvoie
void
Depuis
4.0.0
Exceptions

Références extension, et parent.

◆ 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, Text\_(), ApplicationHelper\getClientInfo(), JPATH_SITE, parent, et Text\sprintf().

◆ setupUninstall()

setupUninstall ( )
protected

Method to do any prechecks and setup the uninstall job

Renvoie
void
Depuis
4.0.0

Références $client, extension, ApplicationHelper\getClientInfo(), JPATH_ADMINISTRATOR, JPATH_SITE, parent, et Text\sprintf().

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 :