Class JInstallerAdapterPlugin

Plugin installer

JObject

JAdapterInstance

JInstallerAdapter

JInstallerAdapterPlugin

Direct known subclasses

JInstallerPlugin

Package: Joomla\Libraries\Installer
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt
Since: 3.1
Located at cms/installer/adapter/plugin.php

Methods summary

`protected`	# `checkExistingExtension( )` Method to check if the extension is already present in the database Method to check if the extension is already present in the database Throws `RuntimeException` Since 3.4 Overrides `JInstallerAdapter::checkExistingExtension`
`protected`	# `copyBaseFiles( )` Method to copy the extension's base files from the `<files>` tag(s) and the manifest file Method to copy the extension's base files from the `<files>` tag(s) and the manifest file Throws `RuntimeException` Since 3.4
`protected`	# `createExtensionRoot( )` Method to create the extension root path if necessary Method to create the extension root path if necessary Throws `RuntimeException` Since 3.4 Overrides `JInstallerAdapter::createExtensionRoot`
`protected`	# `finaliseInstall( )` Method to finalise the installation processing Method to finalise the installation processing Throws `RuntimeException` Since 3.4
`public string`	# `getElement( string $element = null )` Get the filtered extension element from the manifest Get the filtered extension element from the manifest Parameters `$element` `string` - $element Optional element name to be converted Returns `string` - The filtered element Since 3.4 Overrides `JInstallerAdapter::getElement`
`protected string`	# `getScriptClassName( )` Get the class name for the install adapter script. Get the class name for the install adapter script. Returns `string` - The class name. Since 3.4 Overrides `JInstallerAdapter::getScriptClassName`
`public`	# `loadLanguage( string $path = null )` Custom loadLanguage method Custom loadLanguage method Parameters `$path` `string` - $path The path where to find language files. Since 3.1
`protected`	# `parseOptionalTags( )` Method to parse optional tags in the manifest Method to parse optional tags in the manifest Since 3.4 Overrides `JInstallerAdapter::parseOptionalTags`
`public`	# `prepareDiscoverInstall( )` Prepares the adapter for a discover_install task Prepares the adapter for a discover_install task Since 3.4 Overrides `JInstallerAdapter::prepareDiscoverInstall`
`protected`	# `setupInstallPaths( )` Method to do any prechecks and setup the install paths for the extension Method to do any prechecks and setup the install paths for the extension Throws `RuntimeException` Since 3.4
`protected`	# `storeExtension( )` Method to store the extension to the database Method to store the extension to the database Throws `RuntimeException` Since 3.4
`public boolean`	# `uninstall( integer $id )` Custom uninstall method Custom uninstall method Parameters `$id` `integer` - $id The id of the plugin to uninstall Returns `boolean` - True on success Since 3.1
`public array`	# `discover( )` Custom discover method Custom discover method Returns `array` - JExtension) list of extensions available Since 3.1
`public boolean`	# `refreshManifestCache( )` Refreshes the extension table cache. Refreshes the extension table cache. Returns `boolean` - Result of operation, true if updated, false on failure. Since 3.1

Magic methods summary

Magic methods inherited from JInstallerAdapter

getParent()

Properties summary

`protected object`	`$scriptElement`	# `<scriptfile>` element of the extension manifest `<scriptfile>` element of the extension manifest Since 3.1
`protected object`	`$oldFiles`	# `<files>` element of the old extension manifest `<files>` element of the old extension manifest Since 3.1

Properties inherited from JInstallerAdapter

$currentExtensionId, $element, $extension, $extensionMessage, $manifest, $manifest_script, $name, $route, $supportsDiscoverInstall, $type

Properties inherited from JAdapterInstance

$db, $parent

Properties inherited from JObject

$_errors

Magic properties inherited from JInstallerAdapter

$parent

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JInstallerAdapterPlugin

Direct known subclasses

Methods summary

Throws

Since

Overrides

Throws

Since

Throws

Since

Overrides

Throws

Since

Parameters

Returns

Since

Overrides

Returns

Since

Overrides

Parameters

Since

Since

Overrides

Since

Overrides

Throws

Since

Throws

Since

Parameters

Returns

Since

Returns

Since

Returns

Since

Methods inherited from JInstallerAdapter

Methods inherited from JAdapterInstance

Methods inherited from JObject

Magic methods summary

Magic methods inherited from JInstallerAdapter

Properties summary

Since

Since

Properties inherited from JInstallerAdapter

Properties inherited from JAdapterInstance

Properties inherited from JObject

Magic properties inherited from JInstallerAdapter