Référence de la classe ComponentAdapter

Graphe d'héritage de ComponentAdapter:

Fonctions membres publiques
	getElement ($element=null)
	loadLanguage ($path=null)
	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 protégées
	checkExtensionInFilesystem ()
	copyBaseFiles ()
	createExtensionRoot ()
	parseOptionalTags ()
	setupInstallPaths ()
	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)
	getScriptClassName ()
	parseQueries ()
	parseOptionalTags ()
	setupInstallPaths ()
	setupScriptfile ()
	setupUpdates ()
	storeExtension ()
	triggerManifestScript ($method)

Attributs protégés
	$oldAdminFiles = null
	$oldFiles = null
	$manifest_script = null
	$install_script = 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

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

$componentId

The component ID for which I'm building menus

Renvoie

boolean True if successful

Depuis

3.1

Références $data, $db, $option, $query, et parent.

_rollback_menu()

_rollback_menu (   $step )

protected

Custom rollback method

• Roll back the component menu item

Paramètres

array

$step

Installation step to rollback.

Renvoie

boolean True on success

Depuis

3.1

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	$componentId	The component ID.
int	$clientId	The client id

Renvoie

boolean True if successful

Depuis

3.7.0

Références $clientId, $db, $option, $query, et parent.

_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

$componentId

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

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.

discover()

discover

(

)

Discover unregistered extensions.

Renvoie

array A list of extensions.

Depuis

3.1

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

getElement()

getElement

(

$element = null

)

Get the filtered extension element from the manifest

Paramètres

string

$element

Optional element name to be converted

Renvoie

string The filtered element

Depuis

3.4

loadLanguage()

loadLanguage

(

$path = null

)

Custom loadLanguage method

Paramètres

string

$path

The path language files are on.

Renvoie

void

Depuis

3.1

Références $client, $extension, $folder, $path, elseif, JPATH_ADMINISTRATOR, 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.

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_ADMINISTRATOR, JPATH_SITE, et parent.

setupUpdates()

setupUpdates ( )

protected

Method to setup the update routine for the adapter

Renvoie

void

Depuis

3.4

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

uninstall()

uninstall

(

$id

)

Custom uninstall method for components

Paramètres

integer

$id

The unique extension id of the component to uninstall

Renvoie

boolean True on success

Depuis

3.1

---

Manifest Document Setup Section

---

Installer Trigger Loading and Uninstall

---

Database Processing Section

---

Filesystem Processing Section

Références $asset, $category, $db, $id, $query, extension, Table\getInstance(), JPATH_ADMINISTRATOR, JPATH_SITE, et parent.

Documentation des champs

$install_script

$install_script = null

protected

$manifest_script

$manifest_script = null

protected

$oldAdminFiles

$oldAdminFiles = null

protected

$oldFiles

$oldFiles = null

protected

---

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

• ComponentAdapter.php