Search

Projects

Classes

Methods

⇦ Back to Joomla project (class list)

Class ModuleAdapter - list of methods

Module installer

Extends

InstallerAdapter
Package: Joomla\CMS\Installer\Adapter
Copyright: (C) 2005 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
Located at: Joomla/Installer/Adapter/ModuleAdapter.php
Project: Joomla

Method Summary

protected void
()

Method to check if the extension is already present in the database
Returns
  • void
Since
  • 3.4
-
  • \RuntimeException
Show source code of this method: checkExistingExtension Source Code

protected void
()

Method to copy the extension's base files from the `<files>` tag(s) and the manifest file
Returns
  • void
Since
  • 3.4
-
  • \RuntimeException
Show source code of this method: copyBaseFiles Source Code

public array
()

Custom discover method
Returns
  • array Extension list of extensions available
Since
  • 3.1
Show source code of this method: discover Source Code

protected void
()

Method to finalise the installation processing
Returns
  • void
Since
  • 3.4
-
  • \RuntimeException
Show source code of this method: finaliseInstall Source Code

protected bool
()

Method to finalise the uninstallation processing
Returns
  • bool
Since
  • 4.0.0
-
  • \RuntimeException
Show source code of this method: finaliseUninstall Source Code

public string|null
(mixed $element = null)

Get the filtered extension element from the manifest
Parameters
  • string $element Optional element name to be converted
Returns
  • string|null The filtered element
Since
  • 3.4
Show source code of this method: getElement Source Code

public void
(mixed $path = null)

Custom loadLanguage method
Parameters
  • string $path The path where we find language files
Returns
  • void
Since
  • 3.4
Show source code of this method: loadLanguage Source Code

protected void
()

Method to parse optional tags in the manifest
Returns
  • void
Since
  • 3.4
Show source code of this method: parseOptionalTags Source Code

public void
()

Prepares the adapter for a discover_install task
Returns
  • void
Since
  • 3.4
Show source code of this method: prepareDiscoverInstall Source Code

public bool
()

Refreshes the extension table cache
Returns
  • bool Result of operation, true if updated, false on failure.
Since
  • 3.1
Show source code of this method: refreshManifestCache Source Code

protected void
()

Removes this extension's files
Returns
  • void
Since
  • 4.0.0
-
  • \RuntimeException
Show source code of this method: removeExtensionFiles Source Code

protected void
()

Method to do any prechecks and setup the install paths for the extension
Returns
  • void
Since
  • 3.4
-
  • \RuntimeException
Show source code of this method: setupInstallPaths Source Code

protected void
()

Method to do any prechecks and setup the uninstall job
Returns
  • void
Since
  • 4.0.0
Show source code of this method: setupUninstall Source Code

protected void
()

Method to store the extension to the database
Returns
  • void
Since
  • 3.4
-
  • \RuntimeException
Show source code of this method: storeExtension Source Code

protected bool
_rollback_menu
(mixed $arg)

Custom rollback method - Roll back the menu item
Parameters
  • array $arg Installation step to rollback
Returns
  • bool True on success
Since
  • 3.1
Show source code of this method: _rollback_menu Source Code

protected bool
_rollback_module
(mixed $arg)

Custom rollback method - Roll back the module item
Parameters
  • array $arg Installation step to rollback
Returns
  • bool True on success
Since
  • 3.1
Show source code of this method: _rollback_module Source Code

Properties Summary

protected int
$clientId
The install client ID
Since
  • 3.4
protected object
$scriptElement
`` element of the extension manifest
Since
  • 3.1

Tags Summary

Since
3.1