Docs For Class JInstallerAdapterModule

Description

Module installer

since: 3.1

Located in /libraries/cms/installer/adapter/module.php (line 22)

JObject
   |
   --JAdapterInstance
      |
      --JInstallerAdapterModule

Direct descendents

Class	Description
JInstallerModule	Deprecated class placeholder. You should use JInstallerAdapterModule instead.

Variable Summary

string $element

SimpleXMLElement $manifest

string $manifest_script

string $name

string $route

object $scriptElement

Method Summary

array discover ()

mixed discover_install ()

boolean install ()

void loadLanguage ([string $path = null])

boolean refreshManifestCache ()

boolean uninstall (integer $id)

boolean update ()

boolean _rollback_menu (array $arg)

boolean _rollback_module (array $arg)

Variables

string $element = null (line 63)

Extension element

since: 3.1
access: protected

SimpleXMLElement $manifest = null (line 38)

The installation manifest XML object

since: 3.1
access: protected

string $manifest_script = null (line 47)

A path to the PHP file that the scriptfile declaration in the manifest refers to.

since: 3.1
access: protected

string $name = null (line 55)

Extension name

since: 3.1
access: protected

string $route = 'Install' (line 30)

Install function routing

since: 3.1
access: protected

object $scriptElement = null (line 71)

<scriptfile> element of the extension manifest

since: 3.1
access: protected

Inherited Variables

Inherited from JAdapterInstance

JAdapterInstance::$db
JAdapterInstance::$parent

Inherited from JObject

JObject::$_errors

Methods

discover (line 614)

Custom discover method

return: JExtension list of extensions available
since: 3.1
access: public

array discover ()

discover_install (line 662)

Custom discover_install method

return: Extension ID on success, boolean false on failure
since: 3.1
access: public

mixed discover_install ()

install (line 139)

Custom install method

return: True on success
since: 3.1
access: public

boolean install ()

loadLanguage (line 82)

Custom loadLanguage method

since: 3.1
access: public

void loadLanguage ([string $path = null])

string $path: The path where we find language files

refreshManifestCache (line 709)

Refreshes the extension table cache

return: Result of operation, true if updated, false on failure.
since: 3.1
access: public

boolean refreshManifestCache ()

uninstall (line 740)

Custom uninstall method

return: True on success
since: 3.1
access: public

boolean uninstall (integer $id)

integer $id: The id of the module to uninstall

update (line 594)

Custom update method

This is really a shell for the install system

return: True on success.
since: 3.1
access: public

boolean update ()

_rollback_menu (line 952)

Custom rollback method

Roll back the menu item

return: True on success
since: 3.1
access: protected

boolean _rollback_menu (array $arg)

array $arg: Installation step to rollback

_rollback_module (line 981)

Custom rollback method

Roll back the module item

return: True on success
since: 3.1
access: protected

boolean _rollback_module (array $arg)

array $arg: Installation step to rollback

Inherited Methods

Inherited From JAdapterInstance

JAdapterInstance::__construct()
JAdapterInstance::getParent()

Inherited From JObject

JObject::__construct()
JObject::def()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::__toString()