Docs For Class JInstallerComponent

Description

Component installer

author: Louis Landry <[email protected]>
since: 1.1

Located in /installer/installer/component.php (line 21)

JObject
   |
   --JInstaller
      |
      --JInstallerComponent

Method Summary

boolean install (string $p_fromdir)

mixed uninstall (mixed $id, [int $client = null], int $cid, string $option)

int _createParentMenu (string $_menuname, string $_comname, [string $_image = "js/ThemeOffice/component.png"])

boolean _rollback_menu (array $arg)

Variables

Inherited Variables

Inherited from JInstaller

JInstaller::$i_allowOverwrite
JInstaller::$i_db
JInstaller::$i_description
JInstaller::$i_extensionAdminDir
JInstaller::$i_extensionDir
JInstaller::$i_extensionName
JInstaller::$i_extensionSpecial
JInstaller::$i_hasInstallScript
JInstaller::$i_installDir
JInstaller::$i_installFile
JInstaller::$i_installScript
JInstaller::$i_installType
JInstaller::$i_message
JInstaller::$i_stepStack
JInstaller::$i_xmldoc

Methods

install (line 31)

Custom install method for components

return: True on success
since: 1.0
access: public

boolean install (string $p_fromdir)

string $p_fromdir: Directory from which to install the component

Redefinition of:

JInstaller::install()

Abstract install method

override in child class

uninstall (line 363)

Custom uninstall method for components

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

mixed uninstall (mixed $id, [int $client = null], int $cid, string $option)

int $cid: The id of the component to uninstall
string $option: The URL option
int $client: The client id

Redefinition of:

JInstaller::uninstall()

Abstract uninstall method

override in child class

_createParentMenu (line 543)

Method to create a menu entry for a component

return: Id of the created menu entry
since: 1.0
access: private

int _createParentMenu (string $_menuname, string $_comname, [string $_image = "js/ThemeOffice/component.png"])

string $_menuname: Menu name
string $_comname: Component name
string $_image: Image file

_rollback_menu (line 516)

Custom rollback method

Roll back the component menu item

return: True on success
since: 1.1
access: private

boolean _rollback_menu (array $arg)

array $arg: Installation step to rollback

Inherited Methods

Inherited From JInstaller

JInstaller::__construct()
JInstaller::getInstance()
JInstaller::install()
JInstaller::preInstallCheck()
JInstaller::uninstall()
JInstaller::update()
JInstaller::_copyFiles()
JInstaller::_copyInstallFile()
JInstaller::_findInstallFile()
JInstaller::_getParams()
JInstaller::_isPackageFile()
JInstaller::_mapClient()
JInstaller::_parseBackwardQueries()
JInstaller::_parseFiles()
JInstaller::_parseQueries()
JInstaller::_readInstallFile()
JInstaller::_removeFiles()
JInstaller::_rollback()

Inherited From JObject

JObject::__construct()
JObject::JObject()
JObject::get()
JObject::set()
JObject::toString()
JObject::__destruct()