Class JInstallerAdapter

Abstract adapter for the installer.

JObject

JInstallerAdapter

Direct known subclasses

JInstallerAdapterComponent, JInstallerAdapterFile, JInstallerAdapterLanguage, JInstallerAdapterLibrary, JInstallerAdapterModule, JInstallerAdapterPackage, JInstallerAdapterPlugin, JInstallerAdapterTemplate

Indirect known subclasses

JInstallerComponent, JInstallerFile, JInstallerLanguage, JInstallerLibrary, JInstallerModule, JInstallerPackage, JInstallerPlugin, JInstallerTemplate

Abstract
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.4
Note: As of 4.0, this class will no longer extend from JAdapterInstance
Located at cms/installer/adapter.php

Methods summary

`public`	# `__construct( JInstaller $parent, JDatabaseDriver $db, array $options = array() )` Constructor Constructor Parameters `$parent` `JInstaller` - $parent Parent object `$db` `JDatabaseDriver` - $db Database object `$options` `array` - $options Configuration Options Since 3.4 Overrides `JAdapterInstance::__construct`
`protected boolean`	# `canUninstallPackageChild( integer $packageId )` Check if a package extension allows its child extensions to be uninstalled individually Check if a package extension allows its child extensions to be uninstalled individually Parameters `$packageId` `integer` - $packageId The extension ID of the package to check Returns `boolean` Since 3.7.0 Note This method defaults to true to emulate the behavior of 3.6 and earlier which did not support this lookup
`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
`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
`abstract 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
`public boolean`	# `discover_install( )` Generic discover_install method for extensions Generic discover_install method for extensions Returns `boolean` - True on success Since 3.4
`protected boolean`	# `doDatabaseTransactions( )` Method to handle database transactions for the installer Method to handle database transactions for the installer Returns `boolean` - True on success Throws `RuntimeException` Since 3.4
`protected`	# `doLoadLanguage( string $extension, string $source, string $base = JPATH_ADMINISTRATOR )` Load language files Load language files Parameters `$extension` `string` - $extension The name of the extension `$source` `string` - $source Path to the extension `$base` `string` - $base Base path for the extension language Since 3.4
`public boolean`	# `getDiscoverInstallSupported( )` Checks if the adapter supports discover_install Checks if the adapter supports discover_install Returns `boolean` 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
`public SimpleXMLElement`	# `getManifest( )` Get the manifest object. Get the manifest object. Returns `SimpleXMLElement` - Manifest object Since 3.4
`public string`	# `getName( )` Get the filtered component name from the manifest Get the filtered component name from the manifest Returns `string` - The filtered name Since 3.4
`public string`	# `getRoute( )` Get the install route being followed Get the install route being followed Returns `string` - The install route Since 3.4
`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
`public boolean\|integer`	# `install( )` Generic install method for extensions Generic install method for extensions Returns `boolean\|integer` - The extension ID on success, boolean false on failure Since 3.4
`protected`	# `parseQueries( )` Method to parse the queries specified in the `<sql>` tags Method to parse the queries specified in the `<sql>` tags Throws `RuntimeException` Since 3.4
`protected`	# `parseOptionalTags( )` Method to parse optional tags in the manifest Method to parse optional tags in the manifest Since 3.1
`public`	# `prepareDiscoverInstall( )` Prepares the adapter for a discover_install task Prepares the adapter for a discover_install task Since 3.4
`public JInstallerAdapter`	# `setManifest( object $manifest )` Set the manifest object. Set the manifest object. Parameters `$manifest` `object` - $manifest The manifest object Returns `JInstallerAdapter` - Instance of this class to support chaining Since 3.4
`public JInstallerAdapter`	# `setRoute( string $route )` Set the install route being followed Set the install route being followed Parameters `$route` `string` - $route The install route being followed Returns `JInstallerAdapter` - Instance of this class to support chaining Since 3.4
`abstract 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 Since 3.4
`protected`	# `setupScriptfile( )` Setup the manifest script file for those adapters that use it. Setup the manifest script file for those adapters that use it. Since 3.4
`protected`	# `setupUpdates( )` Method to setup the update routine for the adapter Method to setup the update routine for the adapter Since 3.4
`abstract 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
`public boolean\|integer`	# `update( )` Generic update method for extensions Generic update method for extensions Returns `boolean\|integer` - The extension ID on success, boolean false on failure Since 3.4

Methods inherited from JAdapterInstance

getParent()

Methods inherited from JObject

__toString(), def(), get(), getError(), getErrors(), getProperties(), set(), setError(), setProperties()

Magic methods summary

`public JInstaller`	# `getParent( )` Retrieves the parent object. Retrieves the parent object. Returns `JInstaller`

Properties summary

`protected integer`	`$currentExtensionId`	# ID for the currently installed extension if present ID for the currently installed extension if present Since 3.4
`protected string`	`$element`	# The unique identifier for the extension (e.g. mod_login) The unique identifier for the extension (e.g. mod_login) Since 3.4
`protected JTableExtension`	`$extension`	# JTableExtension object. JTableExtension object. Since 3.4
`protected string`	`$extensionMessage`	# Messages rendered by custom scripts Messages rendered by custom scripts Since 3.4
`public string`	`$manifest`	# Copy of the XML manifest file. Copy of the XML manifest file. Making this object public allows extensions to customize the manifest in custom scripts. Since 3.4
`protected string`	`$manifest_script`	# A path to the PHP file that the scriptfile declaration in the manifest refers to. A path to the PHP file that the scriptfile declaration in the manifest refers to. Since 3.4
`protected string`	`$name`	# Name of the extension Name of the extension Since 3.4
`protected string`	`$route`	# Install function routing Install function routing Since 3.4
`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
`protected string`	`$type`	# The type of adapter in use The type of adapter in use Since 3.4

Properties inherited from JAdapterInstance

$db, $parent

Properties inherited from JObject

$_errors

Magic properties

`public read-only JInstaller`	`$parent`		# Parent object Parent object

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JInstallerAdapter

Direct known subclasses

Indirect known subclasses

Methods summary

Parameters

Since

Overrides

Parameters

Returns

Since

Note

Throws

Since

Throws

Since

Throws

Since

Throws

Since

Returns

Since

Returns

Throws

Since

Parameters

Since

Returns

Since

Parameters

Returns

Since

Returns

Since

Returns

Since

Returns

Since

Returns

Since

Returns

Since

Throws

Since

Since

Since

Parameters

Returns

Since

Parameters

Returns

Since

Since

Since

Since

Throws

Since

Parameters

Returns

Throws

Since

Returns

Since

Methods inherited from JAdapterInstance

Methods inherited from JObject

Magic methods summary

Returns

Properties summary

Since

Since

Since

Since

Since

Since

Since