Docs For Class JInstallerAdapterComponent

Description

Component installer

since: 3.1

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

JObject
   |
   --JAdapterInstance
      |
      --JInstallerAdapterComponent

Direct descendents

Class	Description
JInstallerComponent	Deprecated class placeholder. You should use JInstallerAdapterComponent instead.

Variable Summary

string $element

string $install_script

string $manifest

string $manifest_script

string $name

array $oldAdminFiles

array $oldFiles

Method Summary

array discover ()

mixed discover_install ()

boolean install ()

void loadLanguage ([string $path = null])

boolean refreshManifestCache ()

mixed uninstall (integer $id)

boolean update ()

boolean _buildAdminMenus ()

boolean _removeAdminMenus (object &$row)

boolean _rollback_menu (array $step)

Variables

string $element = null (line 46)

The unique identifier for the extension (e.g. mod_login)

since: 3.1
access: protected

string $install_script = null (line 86)

For legacy installations this is a path to the PHP file that the scriptfile declaration in the manifest refers to.

since: 3.1
access: protected

string $manifest = null (line 30)

Copy of the XML manifest file

since: 3.1
access: protected

string $manifest_script = null (line 77)

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

since: 3.1
access: protected

string $name = null (line 38)

Name of the extension

since: 3.1
access: protected

array $oldAdminFiles = null (line 57)

The list of current files fo the Joomla! CMS administrator that are installed and is read from the manifest on disk in the update area to handle doing a diff and deleting files that are in the old files list and not in the new files list.

since: 3.1
access: protected

array $oldFiles = null (line 68)

The list of current files that are installed and is read from the manifest on disk in the update area to handle doing a diff and deleting files that are in the old files list and not in the new files list.

since: 3.1
access: protected

Inherited Variables

Inherited from JAdapterInstance

JAdapterInstance::$db
JAdapterInstance::$parent

Inherited from JObject

JObject::$_errors

Methods

discover (line 1544)

Discover unregistered extensions.

return: A list of extensions.
since: 3.1
access: public

array discover ()

discover_install (line 1599)

Install unregistered extensions that have been discovered.

since: 3.1
access: public

mixed discover_install ()

install (line 158)

Custom install method for components

return: True on success
since: 3.1
access: public

boolean install ()

loadLanguage (line 97)

Custom loadLanguage method

since: 3.1
access: public

void loadLanguage ([string $path = null])

string $path: The path language files are on.

refreshManifestCache (line 1856)

Refreshes the extension table cache

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

boolean refreshManifestCache ()

uninstall (line 967)

Custom uninstall method for components

return: Return value for uninstall method in component uninstall file
since: 3.1
access: public

mixed uninstall (integer $id)

integer $id: The unique extension id of the component to uninstall

update (line 566)

Custom update method for components

return: True on success
since: 3.1
access: public

boolean update ()

_buildAdminMenus (line 1207)

Method to build menu database entries for a component

return: True if successful
since: 3.1
access: protected

boolean _buildAdminMenus ()

_removeAdminMenus (line 1485)

Method to remove admin menu references to a component

return: True if successful.
since: 3.1
access: protected

boolean _removeAdminMenus (object &$row)

object &$row: Component table object.

_rollback_menu (line 1532)

Custom rollback method

Roll back the component menu item

return: True on success
since: 3.1
access: protected

boolean _rollback_menu (array $step)

array $step: 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()