API16:JInstaller/uninstall

This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Description

Package uninstallation method

<! removed transcluded page call, red link never existed >

Syntax

uninstall($type, $identifier, $cid=0)

Parameter Name	Default Value	Description
$type		$type Package type
$identifier		$identifier Package identifier for adapter
$cid	0	$cid Application ID; deprecated in 1.6

Returns

boolean True if successful

Defined in

libraries/joomla/installer/installer.php

Importing

jimport( 'joomla.installer.installer' );

Source Body

public function uninstall($type, $identifier, $cid=0)
{
        if (!isset($this->_adapters[$type]) || !is_object($this->_adapters[$type]))
        {
                if (!$this->setAdapter($type)) {
                        return false; // we failed to get the right adapter
                }
        }
        if (is_object($this->_adapters[$type]))
        {
                // We don't load languages here, we get the extension adapter to work it out
                // Fire the onBeforeExtensionUninstall event.
                JPluginHelper::importPlugin('installer');
                $dispatcher =& JDispatcher::getInstance();
                $dispatcher->trigger('onBeforeExtensionUninstall', array('eid' => $identifier));
                // Run the uninstall
                $result = $this->_adapters[$type]->uninstall($identifier);
                // Fire the onAfterExtensionInstall
                $dispatcher->trigger('onAfterExtensionUninstall', array('installer'=>clone $this, 'eid'=> $identifier, 'result' => $result));
                return $result;
        }
        return false;
}

<! removed transcluded page call, red link never existed >

Examples

<CodeExamplesForm />