Class: JInstallerComponent

Source Location: /libraries/joomla/installer/adapters/component.php

Class JInstallerComponent

Class Overview

Component installer

Located in /libraries/joomla/installer/adapters/component.php [line 20]

JObject
   |
   --JAdapterInstance
      |
      --JInstallerComponent

Author(s):

Information Tags:

Since:

1.5

Properties

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From JAdapterInstance

JAdapterInstance::$db

JAdapterInstance::$parent

Inherited From JObject

JObject::$_errors

Inherited From JAdapterInstance

JAdapterInstance::__construct()

Constructor

Inherited From JObject

JObject::__construct()

Class constructor, overridden in descendant classes.

JObject::def()

Sets a default value if not alreay assigned

JObject::get()

Returns a property of the object or the default value if the property is not set.

JObject::getError()

Get the most recent error message.

JObject::getErrors()

Return all errors, if any.

JObject::getProperties()

Returns an associative array of object properties.

JObject::set()

Modifies a property of the object, creating it if it does not already exist.

JObject::setError()

Add an error message.

JObject::setProperties()

Set the object properties based on a named array/hash.

JObject::toString()

JObject::__toString()

Magic method to convert the object to a string gracefully.

[ Top ]

Property Summary

mixed	$adminElement
mixed	$element
mixed	$installElement
mixed	$install_script
mixed	$manifest
mixed	$manifest_script
mixed	$name
mixed	$oldAdminFiles
mixed	$oldFiles
mixed	$scriptElement
mixed	$uninstallElement

[ Top ]

Method Summary

void	discover()
void	discover_install()
boolean	install()	Custom install method for components
void	refreshManifestCache()
mixed	uninstall()	Custom uninstall method for components
boolean	update()	Custom update method for components
boolean	_buildAdminMenus()	Method to build menu database entries for a component
boolean	_removeAdminMenus()	Method to remove admin menu references to a component
boolean	_rollback_menu()	Custom rollback method Roll back the component menu item

[ Top ]

Properties

mixed $adminElement = null [line 26]

API Tags:

Access:

protected

[ Top ]

mixed $element = null [line 24]

API Tags:

Access:

protected

[ Top ]

mixed $installElement = null [line 27]

API Tags:

Access:

protected

[ Top ]

mixed $install_script = null [line 32]

API Tags:

Access:

protected

[ Top ]

mixed $manifest = null [line 22]

API Tags:

Access:

protected

[ Top ]

mixed $manifest_script = null [line 31]

API Tags:

Access:

protected

[ Top ]

mixed $name = null [line 23]

API Tags:

Access:

protected

[ Top ]

mixed $oldAdminFiles = null [line 29]

API Tags:

Access:

protected

[ Top ]

mixed $oldFiles = null [line 30]

API Tags:

Access:

protected

[ Top ]

mixed $scriptElement = null [line 25]

API Tags:

Access:

protected

[ Top ]

mixed $uninstallElement = null [line 28]

API Tags:

Access:

protected

[ Top ]

Methods

discover [line 1324]

void discover(
)

[ Top ]

discover_install [line 1358]

void discover_install(
)

[ Top ]

install [line 41]

boolean install(
)

Custom install method for components

API Tags:

Return:	True on success
Access:	public

Information Tags:

Since:

1.5

[ Top ]

refreshManifestCache [line 1581]

void refreshManifestCache(
)

API Tags:

Access:

public

[ Top ]

uninstall [line 805]

mixed uninstall(
int
$id 
)

Custom uninstall method for components

Parameters:

int

$id:

The unique extension id of the component to uninstall

API Tags:

Return:	Return value for uninstall method in component uninstall file
Access:	public

Information Tags:

Since:

1.0

[ Top ]

update [line 423]

boolean update(
)

Custom update method for components

API Tags:

Return:	True on success
Access:	public

Information Tags:

Since:

1.5

[ Top ]

_buildAdminMenus [line 1029]

boolean _buildAdminMenus(
)

Method to build menu database entries for a component

API Tags:

Return:	True if successful
Access:	protected

Information Tags:

Since:

1.5

[ Top ]

_removeAdminMenus [line 1274]

boolean _removeAdminMenus(

&$row, object
$component 
)

Method to remove admin menu references to a component

Parameters:

object	$component:	Component table object
	&$row:

API Tags:

Return:	True if successful
Access:	protected

Information Tags:

Since:

1.5

[ Top ]

_rollback_menu [line 1306]

boolean _rollback_menu(
array
$arg 
)

Custom rollback method

Roll back the component menu item

Parameters:

array

$arg:

Installation step to rollback

API Tags:

Return:	True on success
Access:	protected

Information Tags:

Since:

1.5

[ Top ]

The site fititnt.org is not affiliated with or endorsed by the Joomla! Project or Open Source Matters. If you are looking for official documentation, visit api.joomla.org and docs.joomla.org.

Documentation generated on Mon, 26 Oct 2009 23:06:56 -0200 by phpDocumentor 1.4.3

Visit fititnt.org, and look for some extension or more Joomla Framework info	Joomla-Framework Installer

[ class tree: Joomla-Framework ] [ index: Joomla-Framework ] [ all elements ]