Docs For Class JInstallerAdapterFile

Description

File installer

since: 3.1

Located in /libraries/cms/installer/adapter/file.php (line 22)

JObject
   |
   --JAdapterInstance
      |
      --JInstallerAdapterFile

Direct descendents

Class	Description
JInstallerFile	Deprecated class placeholder. You should use JInstallerAdapterFile instead.

Variable Summary

string $route

object $scriptElement

Method Summary

boolean extensionExistsInSystem ([string $extension = null])

boolean install ()

void loadLanguage (string $path)

boolean populateFilesAndFolderList ()

boolean refreshManifestCache ()

boolean uninstall (string $id)

boolean update ()

Variables

string $route = 'install' (line 30)

Install function routing

since: 3.1
access: protected

object $scriptElement = null (line 38)

<scriptfile> element of the extension manifest

since: 3.1
access: protected

Inherited Variables

Inherited from JAdapterInstance

JAdapterInstance::$db
JAdapterInstance::$parent

Inherited from JObject

JObject::$_errors

Methods

extensionExistsInSystem (line 654)

Function used to check if extension is already installed

return: True if extension exists
since: 3.1
access: protected

boolean extensionExistsInSystem ([string $extension = null])

string $extension: The element name of the extension to install

install (line 66)

Custom install method

return: True on success
since: 3.1
access: public

boolean install ()

loadLanguage (line 49)

Custom loadLanguage method

since: 3.1
access: public

void loadLanguage (string $path)

string $path: The path on which to find language files.

populateFilesAndFolderList (line 695)

Function used to populate files and folder list

return: none
since: 3.1
access: protected

boolean populateFilesAndFolderList ()

refreshManifestCache (line 791)

Refreshes the extension table cache

return: result of operation, true if updated, false on failure
since: 3.1
access: public

boolean refreshManifestCache ()

uninstall (line 460)

Custom uninstall method

return: True on success
since: 3.1
access: public

boolean uninstall (string $id)

string $id: The id of the file to uninstall

update (line 440)

Custom update method

return: True on success
since: 3.1
access: public

boolean update ()

Inherited Methods

Inherited From JAdapterInstance

JAdapterInstance::__construct()
JAdapterInstance::getParent()

Inherited From JObject

JObject::__construct()
JObject::def()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::__toString()