Class JInstallerAdapterPackage

Package installer

JObject

JAdapterInstance

JInstallerAdapter

JInstallerAdapterPackage

Direct known subclasses

JInstallerPackage

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/package.php

Methods summary

`protected`	# `checkExtensionInFilesystem( )` Method to check if the extension is present in the filesystem, flags the route as update if so Method to check if the extension is present in the filesystem, flags the route as update if so Throws `RuntimeException` Since 3.4 Overrides `JInstallerAdapter::checkExtensionInFilesystem`
`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`
`public`	# `loadLanguage( string $path )` Load language from a path Load language from a path Parameters `$path` `string` - $path The path of the language. Since 3.1
`public`	# `onExtensionAfterInstall( JInstaller $installer, integer\|boolean $eid )` Handler for the `onExtensionAfterInstall` event Handler for the `onExtensionAfterInstall` event Parameters `$installer` `JInstaller` - $installer JInstaller instance managing the extension's installation `$eid` `integer\|boolean` - $eid The extension ID of the installed extension on success, boolean false on install failure Since 3.7.0
`protected`	# `parseOptionalTags( )` Method to parse optional tags in the manifest Method to parse optional tags in the manifest Since 3.4 Overrides `JInstallerAdapter::parseOptionalTags`
`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
`protected boolean`	# `triggerManifestScript( string $method )` Executes a custom install script method Executes a custom install script method Parameters `$method` `string` - $method The install method to execute Returns `boolean` - True on success Throws `RuntimeException` Since 3.4 Overrides `JInstallerAdapter::triggerManifestScript`
`public boolean`	# `uninstall( integer $id )` Custom uninstall method Custom uninstall method Parameters `$id` `integer` - $id The id of the package to uninstall. Returns `boolean` - True on success Since 3.1
`protected integer`	# `_getExtensionId( string $type, string $id, integer $client, string $group )` Gets the extension id. Gets the extension id. Parameters `$type` `string` - $type The extension type. `$id` `string` - $id The name of the extension (the element field). `$client` `integer` - $client The application id (0: Joomla CMS site; 1: Joomla CMS administrator). `$group` `string` - $group The extension group (mainly for plugins). Returns `integer` 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 array`	`$installedIds`	# An array of extension IDs for each installed extension An array of extension IDs for each installed extension Since 3.7.0
`protected array`	`$results`	# The results of each installed extensions The results of each installed extensions Since 3.1
`protected boolean`	`$supportsDiscoverInstall`	# Flag if the adapter supports discover installs Flag if the adapter supports discover installs Adapters should override this and set to false if discover install is unsupported Since 3.4

Properties inherited from JInstallerAdapter

$currentExtensionId, $element, $extension, $extensionMessage, $manifest, $manifest_script, $name, $route, $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 JInstallerAdapterPackage

Direct known subclasses

Methods summary

Throws

Since

Overrides

Throws

Since

Throws

Since

Overrides

Throws

Since

Parameters

Returns

Since

Overrides

Parameters

Since

Parameters

Since

Since

Overrides

Throws

Since

Throws

Since

Parameters

Returns

Throws

Since

Overrides

Parameters

Returns

Since

Parameters

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

Since

Properties inherited from JInstallerAdapter

Properties inherited from JAdapterInstance

Properties inherited from JObject

Magic properties inherited from JInstallerAdapter