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

Fonctions membres publiques

 getElement ($element=null)
 
 loadLanguage ($path=null)
 
 discover ()
 
 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

 checkExtensionInFilesystem ()
 
 copyBaseFiles ()
 
 createExtensionRoot ()
 
 finaliseUninstall ()
 
 parseOptionalTags ()
 
 parseQueries ()
 
 removeExtensionFiles ()
 
 setupInstallPaths ()
 
 setupUninstall ()
 
 setupUpdates ()
 
 _buildAdminMenus ($componentId=null)
 
 _updateSiteMenus ($componentId=null)
 
 _updateMenus ($componentId, $clientId=null)
 
 _rollback_menu ($step)
 
- 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

 $oldAdminFiles = null
 
 $oldApiFiles = null
 
 $oldFiles = null
 
 $manifest_script = null
 
 $install_script = 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

Component installer

Depuis
3.1

Documentation des fonctions membres

◆ _buildAdminMenus()

_buildAdminMenus (   $componentId = null)
protected

Method to build menu database entries for a component

Paramètres
int | null$componentIdThe component ID for which I'm building menus
Renvoie
boolean True if successful
Depuis
3.1

Références $data, $db, $option, $params, $query, Joomla\Database\getDatabase(), et parent.

◆ _rollback_menu()

_rollback_menu (   $step)
protected

Custom rollback method

  • Roll back the component menu item
Paramètres
array$stepInstallation step to rollback.
Renvoie
boolean True on success
Exceptions

Références $step.

◆ _updateMenus()

_updateMenus (   $componentId,
  $clientId = null 
)
protected

Method to update menu database entries for a component in case if the component has been uninstalled before.

Paramètres
int | null$componentIdThe component ID.
int$clientIdThe client id
Renvoie
boolean True if successful
Depuis
3.7.0

Références $clientId, $db, $link, $option, $query, Joomla\Database\getDatabase(), et ParameterType\INTEGER.

◆ _updateSiteMenus()

_updateSiteMenus (   $componentId = null)
protected

Method to update menu database entries for a component in case the component has been uninstalled before. NOTE: This will not update admin menus. Use _updateMenus() instead to update admin menus ase well.

Paramètres
int | null$componentIdThe component ID.
Renvoie
boolean True if successful
Depuis
3.4.2

◆ checkExtensionInFilesystem()

checkExtensionInFilesystem ( )
protected

Method to check if the extension is present in the filesystem

Renvoie
boolean
Depuis
3.4
Exceptions

Références elseif, parent, 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, $result, $this, Text\_(), parent, et Text\sprintf().

◆ createExtensionRoot()

createExtensionRoot ( )
protected

Method to create the extension root path if necessary

Renvoie
void
Depuis
3.4
Exceptions

Références Text\_(), Folder\create(), parent, et Text\sprintf().

◆ discover()

discover ( )

Discover unregistered extensions.

Renvoie
array A list of extensions.
Depuis
3.1

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

◆ finaliseUninstall()

finaliseUninstall ( )
protected

Method to finalise the uninstallation processing

Renvoie
boolean
Depuis
4.0.0
Exceptions

Références $db, $query, $this, Text\_(), Log\add(), Folder\delete(), extension, Joomla\Database\getDatabase(), Table\getInstance(), ParameterType\INTEGER, parent, et Log\WARNING.

◆ 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 = null)

Custom loadLanguage method

Paramètres
string$pathThe path language files are on.
Renvoie
void
Depuis
3.1

Références $client, $extension, $folder, $path, $this, elseif, JPATH_ADMINISTRATOR, JPATH_API, JPATH_SITE, null, et parent.

◆ parseOptionalTags()

parseOptionalTags ( )
protected

Method to parse optional tags in the manifest

Renvoie
void
Depuis
3.4

Références parent.

◆ parseQueries()

parseQueries ( )
protected

Method to parse the queries specified in the <sql> tags

Renvoie
void
Depuis
4.0.0
Exceptions

Références extension.

◆ 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 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 Text\_(), Path\clean(), JPATH_ADMINISTRATOR, JPATH_API, JPATH_SITE, et parent.

◆ setupUninstall()

setupUninstall ( )
protected

Method to do any prechecks and setup the uninstall job

Renvoie
void
Depuis
4.0.0

Références Text\_(), Path\clean(), Folder\delete(), extension, JPATH_ADMINISTRATOR, JPATH_API, JPATH_SITE, et parent.

◆ setupUpdates()

setupUpdates ( )
protected

Method to setup the update routine for the adapter

Renvoie
void
Depuis
3.4

Références Joomla\Database\getDatabase(), null, et parent.

Documentation des champs

◆ $install_script

$install_script = null
protected

◆ $manifest_script

$manifest_script = null
protected

◆ $oldAdminFiles

$oldAdminFiles = null
protected

◆ $oldApiFiles

$oldApiFiles = null
protected

◆ $oldFiles

$oldFiles = null
protected

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