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

Fonctions membres publiques

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

 checkExtensionInFilesystem ()
 
 copyBaseFiles ()
 
 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)
 

Membres hérités additionnels

- Champs de données hérités de InstallerAdapter
 $manifest = 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
 

Description détaillée

Library installer

Depuis
3.1

Documentation des fonctions membres

◆ 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 extension, Table\getInstance(), null, parent, et Installer\setPackageUninstall().

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

◆ discover()

discover ( )

Custom discover method

Renvoie
array Extension list of extensions available
Depuis
3.1

Références $extension, $file, $results, JFolder\files(), Table\getInstance(), JPATH_MANIFESTS, 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 JPath\clean(), et parent.

◆ 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, $path, 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 extension, JPATH_MANIFESTS, 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 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 DIRECTORY_SEPARATOR, 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, parent, et Installer\parseXMLInstallFile().

◆ uninstall()

uninstall (   $id)

Custom uninstall method

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

Références $files, $id, $manifest, $row, JFile\delete(), JFolder\delete(), JFolder\exists(), JFolder\files(), Table\getInstance(), JPATH_MANIFESTS, et parent.

◆ update()

update ( )

Custom update method

Renvoie
boolean|integer The extension ID on success, boolean false on failure
Depuis
3.1

Références $db, $name, $query, extension, Table\getInstance(), null, et parent.


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