Class JInstallerAdapterFile

File installer

JObject

JAdapterInstance

JInstallerAdapter

JInstallerAdapterFile

Direct known subclasses

JInstallerFile

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

Methods summary

`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`	# `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 )` Custom loadLanguage method Custom loadLanguage method Parameters `$path` `string` - $path The path on which 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`
`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`	# `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( string $id )` Custom uninstall method Custom uninstall method Parameters `$id` `string` - $id The id of the file to uninstall Returns `boolean` - True on success Since 3.1
`protected boolean`	# `extensionExistsInSystem( string $extension = null )` Function used to check if extension is already installed Function used to check if extension is already installed Parameters `$extension` `string` - $extension The element name of the extension to install Returns `boolean` - True if extension exists Since 3.1
`protected boolean`	# `populateFilesAndFolderList( )` Function used to populate files and folder list Function used to populate files and folder list Returns `boolean` - none 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 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 JInstallerAdapterFile

Direct known subclasses

Methods summary

Throws

Since

Throws

Since

Parameters

Returns

Since

Overrides

Parameters

Since

Since

Overrides

Since

Throws

Since

Parameters

Returns

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