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

Fonctions membres publiques

 __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 ()
 

Champs de données

 $manifest = null
 

Fonctions membres protégées

 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

 $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
 

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( Installer  $parent,
\JDatabaseDriver  $db,
array  $options = array() 
)

Constructor

Paramètres
Installer$parentParent object
\JDatabaseDriver$dbDatabase object
array$optionsConfiguration Options
Depuis
3.4

Références $db, $options, extension, et Table\getInstance().

Documentation des fonctions membres

◆ canUninstallPackageChild()

canUninstallPackageChild (   $packageId)
protected

Check if a package extension allows its child extensions to be uninstalled individually

Paramètres
integer$packageIdThe extension ID of the package to check
Renvoie
boolean
Depuis
3.7.0
Note
This method defaults to true to emulate the behavior of 3.6 and earlier which did not support this lookup

Références $manifest, Table\getInstance(), JPATH_MANIFESTS, 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.

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

◆ copyBaseFiles()

copyBaseFiles ( )
abstractprotected

Method to copy the extension's base files from the <files> tag(s) and the manifest file

Renvoie
void
Depuis
3.4
Exceptions

◆ createExtensionRoot()

createExtensionRoot ( )
protected

Method to create the extension root path if necessary

Renvoie
void
Depuis
3.4
Exceptions

Références JFolder\create(), et parent.

◆ discover_install()

discover_install ( )

Generic discover_install method for extensions

Renvoie
boolean True on success
Depuis
3.4

Références $description, extension, name, et parent.

◆ doDatabaseTransactions()

doDatabaseTransactions ( )
protected

Method to handle database transactions for the installer

Renvoie
boolean True on success
Depuis
3.4
Exceptions

Références $route, et parent.

◆ doLoadLanguage()

doLoadLanguage (   $extension,
  $source,
  $base = JPATH_ADMINISTRATOR 
)
protected

Load language files

Paramètres
string$extensionThe name of the extension
string$sourcePath to the extension
string$baseBase path for the extension language
Renvoie
void
Depuis
3.4

Références $base, $extension, $lang, et null.

◆ getDiscoverInstallSupported()

getDiscoverInstallSupported ( )

Checks if the adapter supports discover_install

Renvoie
boolean
Depuis
3.4

◆ 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

◆ getManifest()

getManifest ( )

Get the manifest object.

Renvoie
Manifest object
Depuis
3.4

Références $manifest.

◆ getName()

getName ( )

Get the filtered component name from the manifest

Renvoie
string The filtered name
Depuis
3.4

Références $name.

◆ getRoute()

getRoute ( )

Get the install route being followed

Renvoie
string The install route
Depuis
3.4

Références $route.

◆ getScriptClassName()

getScriptClassName ( )
protected

Get the class name for the install adapter script.

Renvoie
string The class name.
Depuis
3.4

Références $className.

◆ install()

install ( )

Generic install method for extensions

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

Références $description, extension, name, et parent.

◆ parseOptionalTags()

parseOptionalTags ( )
protected

Method to parse optional tags in the manifest

Renvoie
void
Depuis
3.1

◆ parseQueries()

parseQueries ( )
protected

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

Renvoie
void
Depuis
3.4
Exceptions

Références elseif, et parent.

◆ prepareDiscoverInstall()

prepareDiscoverInstall ( )

Prepares the adapter for a discover_install task

Renvoie
void
Depuis
3.4

◆ setManifest()

setManifest (   $manifest)

Set the manifest object.

Paramètres
object$manifestThe manifest object
Renvoie
InstallerAdapter Instance of this class to support chaining
Depuis
3.4

Références $manifest.

◆ setRoute()

setRoute (   $route)

Set the install route being followed

Paramètres
string$routeThe install route being followed
Renvoie
InstallerAdapter Instance of this class to support chaining
Depuis
3.4

Références $route.

◆ setupInstallPaths()

setupInstallPaths ( )
abstractprotected

Method to do any prechecks and setup the install paths for the extension

Renvoie
void
Depuis
3.4

◆ setupScriptfile()

setupScriptfile ( )
protected

Setup the manifest script file for those adapters that use it.

Renvoie
void
Depuis
3.4

Références parent, et JLoader\register().

◆ setupUpdates()

setupUpdates ( )
protected

Method to setup the update routine for the adapter

Renvoie
void
Depuis
3.4

◆ storeExtension()

storeExtension ( )
abstractprotected

Method to store the extension to the database

Renvoie
void
Depuis
3.4
Exceptions

◆ triggerManifestScript()

triggerManifestScript (   $method)
protected

Executes a custom install script method

Paramètres
string$methodThe install method to execute
Renvoie
boolean True on success
Depuis
3.4
Exceptions

Références parent.

◆ update()

update ( )

Generic update method for extensions

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

Références parent.

Documentation des champs

◆ $currentExtensionId

$currentExtensionId = null
protected

◆ $element

$element = null
protected

◆ $extension

$extension = null
protected

◆ $extensionMessage

$extensionMessage = ''
protected

◆ $manifest

$manifest = null

◆ $manifest_script

$manifest_script = null
protected

◆ $name

$name = null
protected

◆ $route

$route = 'install'
protected

◆ $supportsDiscoverInstall

$supportsDiscoverInstall = true
protected

◆ $type

$type
protected

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