Search

Projects

Classes

Methods

⇦ Back to Joomla project (class list)

Class ComponentAdapter - list of methods

Component 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/ComponentAdapter.php
Project: Joomla

Method Summary

protected bool
()

Method to check if the extension is present in the filesystem
Returns
  • bool
Since
  • 3.4
-
  • \RuntimeException
Show source code of this method: checkExtensionInFilesystem 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

protected void
()

Method to create the extension root path if necessary
Returns
  • void
Since
  • 3.4
-
  • \RuntimeException
Show source code of this method: createExtensionRoot 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
(mixed $element = null)

Get the filtered extension element from the manifest
Parameters
  • string $element Optional element name to be converted
Returns
  • string 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 language files are on.
Returns
  • void
Since
  • 3.1
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

protected void
()

Method to parse the queries specified in the `<sql>` tags
Returns
  • void
Since
  • 4.0.0
-
  • \RuntimeException
Show source code of this method: parseQueries Source Code

public void
()

Prepares the adapter for a discover_install task
Returns
  • void
Since
  • 3.4
-
  • \RuntimeException
Show source code of this method: prepareDiscoverInstall 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 setup the update routine for the adapter
Returns
  • void
Since
  • 3.4
Show source code of this method: setupUpdates Source Code

protected void
(mixed $deleteExisting = false)

Method to store the extension to the database
Parameters
  • bool $deleteExisting Should I try to delete existing records of the same component?
Returns
  • void
Since
  • 3.4
-
  • \RuntimeException
Show source code of this method: storeExtension Source Code

protected bool
_buildAdminMenus
(mixed $componentId = null)

Method to build menu database entries for a component
Parameters
  • int|null $componentId The component ID for which I'm building menus
Returns
  • bool True if successful
Since
  • 3.1
Show source code of this method: _buildAdminMenus Source Code

protected bool
_removeAdminMenus
(mixed $id)

Method to remove admin menu references to a component
Parameters
  • int $id The ID of the extension whose admin menus will be removed
Returns
  • bool True if successful.
Since
  • 3.1
-
  • \Exception
Show source code of this method: _removeAdminMenus Source Code

protected bool
_updateSiteMenus
(mixed $componentId = null)

Method to update menu database entries for a component in case the component has been uninstalled before.
Parameters
  • int|null $componentId The component ID.
Returns
  • bool True if successful
Since
  • 3.4.2
Show source code of this method: _updateSiteMenus Source Code

protected bool
_updateMenus
(mixed $componentId, mixed $clientId = null)

Method to update menu database entries for a component in case if the component has been uninstalled before.
Parameters
  • int|null $componentId The component ID.
  • int $clientId The client id
Returns
  • bool True if successful
Since
  • 3.7.0
Show source code of this method: _updateMenus Source Code

protected bool
_rollback_menu
(mixed $step)

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

public array
()

Discover unregistered extensions.
Returns
  • array A list of extensions.
Since
  • 3.1
Show source code of this method: discover 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 bool|int
_createAdminMenuItem
(array &$data, mixed $parentId)

Creates the menu item in the database. If the item already exists it tries to remove it and create it afresh.
Parameters
  • array & $data The menu item data to create
  • int $parentId The parent menu item ID
Returns
  • bool|int Menu item ID on success, false on failure
Since
  • 3.1
-
  • \Exception
Show source code of this method: _createAdminMenuItem Source Code

Properties Summary

protected array
$oldAdminFiles
The list of current files for 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
$oldApiFiles
The list of current files for the Joomla! CMS API 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
  • 4.0.0
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.
Since
  • 3.1
protected string
$manifest_script
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.
Since
  • 3.1

Tags Summary

Since
3.1