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

Fonctions membres publiques

 getElement ($element=null)
 
 loadLanguage ($path=null)
 
 prepareDiscoverInstall ()
 
 uninstall ($id)
 
 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 publiques hérités de JAdapterInstance
 __construct (JAdapter $parent, JDatabaseDriver $db, array $options=array())
 
 getParent ()
 

Fonctions membres protégées

 checkExistingExtension ()
 
 copyBaseFiles ()
 
 createExtensionRoot ()
 
 getScriptClassName ()
 
 parseOptionalTags ()
 
 setupInstallPaths ()
 
 storeExtension ()
 
- 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

 $scriptElement = null
 
 $oldFiles = 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
 
- Attributs protégés hérités de JAdapterInstance
 $parent = null
 
 $db = null
 

Membres hérités additionnels

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

Description détaillée

Plugin installer

Depuis
3.1

Documentation des fonctions membres

◆ 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.

◆ createExtensionRoot()

createExtensionRoot ( )
protected

Method to create the extension root path if necessary

Renvoie
void
Depuis
3.4
Exceptions

Références parent, et Installer\setPath().

◆ discover()

discover ( )

Custom discover method

Renvoie
array Extension) list of extensions available
Depuis
3.1

Références $extension, $file, $folder, $results, JFolder\files(), JFolder\folders(), Table\getInstance(), JPATH_SITE, json_encode, Installer\parseXMLInstallFile(), et JFile\stripExt().

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

◆ getScriptClassName()

getScriptClassName ( )
protected

Get the class name for the install adapter script.

Renvoie
string The class name.
Depuis
3.4

◆ loadLanguage()

loadLanguage (   $path = null)

Custom loadLanguage method

Paramètres
string$pathThe path where to find language files.
Renvoie
void
Depuis
3.1

Références $extension, $file, $folder, $name, $path, JPATH_ADMINISTRATOR, JPATH_PLUGINS, 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 $basePath, $client, extension, 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 JPATH_PLUGINS, et parent.

◆ storeExtension()

storeExtension ( )
protected

Method to store the extension to the database

Renvoie
void
Depuis
3.4
Exceptions

Références $name, extension, json_encode, name, parent, et Installer\parseXMLInstallFile().

◆ uninstall()

uninstall (   $id)

Custom uninstall method

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

Installer Trigger Loading

Références $db, $id, $query, $row, JFolder\delete(), Table\getInstance(), JPATH_PLUGINS, null, parent, et JLoader\register().

Documentation des champs

◆ $oldFiles

$oldFiles = null
protected

◆ $scriptElement

$scriptElement = null
protected

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