Class JInstallerAdapterComponent

Component installer

JObject

JAdapterInstance

JInstallerAdapter

JInstallerAdapterComponent

Direct known subclasses

JInstallerComponent

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

Methods summary

`protected boolean`	# `checkExtensionInFilesystem( )` Method to check if the extension is present in the filesystem Method to check if the extension is present in the filesystem Returns `boolean` 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 = null )` Custom loadLanguage method Custom loadLanguage method Parameters `$path` `string` - $path The path language files are on. 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 Throws `RuntimeException` 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`	# `setupUpdates( )` Method to setup the update routine for the adapter Method to setup the update routine for the adapter Since 3.4 Overrides `JInstallerAdapter::setupUpdates`
`protected`	# `storeExtension( boolean $deleteExisting = false )` Method to store the extension to the database Method to store the extension to the database Parameters `$deleteExisting` `boolean` - $deleteExisting Should I try to delete existing records of the same component? Throws `RuntimeException` Since 3.4
`public boolean`	# `uninstall( integer $id )` Custom uninstall method for components Custom uninstall method for components Parameters `$id` `integer` - $id The unique extension id of the component to uninstall Returns `boolean` - True on success Since 3.1
`protected boolean`	# `_buildAdminMenus( integer\|null $component_id = null )` Method to build menu database entries for a component Method to build menu database entries for a component Parameters `$component_id` `integer\|null` - $component_id The component ID for which I'm building menus Returns `boolean` - True if successful Since 3.1
`protected boolean`	# `_removeAdminMenus( integer $id )` Method to remove admin menu references to a component Method to remove admin menu references to a component Parameters `$id` `integer` - $id The ID of the extension whose admin menus will be removed Returns `boolean` - True if successful. Since 3.1
`protected boolean`	# `_updateSiteMenus( integer\|null $component_id = null )` Method to update menu database entries for a component in case the component has been uninstalled before. NOTE: This will not update admin menus. Use _updateMenus() instead to update admin menus ase well. Method to update menu database entries for a component in case the component has been uninstalled before. NOTE: This will not update admin menus. Use _updateMenus() instead to update admin menus ase well. Parameters `$component_id` `integer\|null` - $component_id The component ID. Returns `boolean` - True if successful Since 3.4.2
`protected boolean`	# `_updateMenus( integer\|null $component_id, integer $clientId = null )` Method to update menu database entries for a component in case if the component has been uninstalled before. Method to update menu database entries for a component in case if the component has been uninstalled before. Parameters `$component_id` `integer\|null` - $component_id The component ID. `$clientId` `integer` - $clientId The client id Returns `boolean` - True if successful Since 3.7.0
`protected boolean`	# `_rollback_menu( array $step )` Custom rollback method Roll back the component menu item Custom rollback method Roll back the component menu item Parameters `$step` `array` - $step Installation step to rollback. Returns `boolean` - True on success Since 3.1
`public array`	# `discover( )` Discover unregistered extensions. Discover unregistered extensions. Returns `array` - A list of extensions. 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
`protected boolean\|integer`	# `_createAdminMenuItem( array & $data, integer $parentId )` Creates the menu item in the database. If the item already exists it tries to remove it and create it afresh. Creates the menu item in the database. If the item already exists it tries to remove it and create it afresh. Parameters `$data` `array` - &$data The menu item data to create `$parentId` `integer` - $parentId The parent menu item ID Returns `boolean\|integer` - Menu item ID on success, false on failure

Magic methods summary

Magic methods inherited from JInstallerAdapter

getParent()

Properties summary

`protected array`	`$oldAdminFiles`	# The list of current files fo the Joomla! CMS administrator that are installed and is read from the manifest on disk in the update area to handle doing a diff and deleting files that are in the old files list and not in the new files list. The list of current files fo the Joomla! CMS administrator that are installed and is read from the manifest on disk in the update area to handle doing a diff and deleting files that are in the old files list and not in the new files list. Since 3.1
`protected array`	`$oldFiles`	# The list of current files that are installed and is read from the manifest on disk in the update area to handle doing a diff and deleting files that are in the old files list and not in the new files list. The list of current files that are installed and is read from the manifest on disk in the update area to handle doing a diff and deleting files that are in the old files list and not in the new files list. Since 3.1
`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.1
`protected string`	`$install_script`	# For legacy installations this is a path to the PHP file that the scriptfile declaration in the manifest refers to. For legacy installations this is a path to the PHP file that the scriptfile declaration in the manifest refers to. Since 3.1

Properties inherited from JInstallerAdapter

$currentExtensionId, $element, $extension, $extensionMessage, $manifest, $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 JInstallerAdapterComponent

Direct known subclasses

Methods summary

Returns

Throws

Since

Overrides

Throws

Since

Throws

Since

Overrides

Throws

Since

Parameters

Returns

Since

Overrides

Parameters

Since

Since

Overrides

Throws

Since

Overrides

Throws

Since

Since

Overrides

Parameters

Throws

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Returns

Since

Returns

Since

Parameters

Returns

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

Since

Properties inherited from JInstallerAdapter

Properties inherited from JAdapterInstance

Properties inherited from JObject

Magic properties inherited from JInstallerAdapter