Joomla! API

Download
Launch

ComponentAdapter

Extends InstallerAdapter

Component installer

since

3.1
package

Joomla CMS

Methods

__construct

Constructor

__construct(\Joomla\CMS\Installer\Installer parent, \JDatabaseDriver db, array options = array()) : mixed
inherited
since

3.4

Arguments

parent

\Joomla\CMS\Installer\InstallerParent object

db

\JDatabaseDriverDatabase object

options

arrayConfiguration Options

Response

mixed

_buildAdminMenus

Method to build menu database entries for a component

_buildAdminMenus(int|null componentId = null) : bool
since

3.1

Arguments

componentId

int|nullThe component ID for which I'm building menus

Response

boolTrue if successful

_createAdminMenuItem

Creates the menu item in the database. If the item already exists it tries to remove it and create it afresh.

_createAdminMenuItem(array &data, int parentId) : bool|int

Arguments

data

arrayThe menu item data to create

parentId

intThe parent menu item ID

Response

bool|intMenu item ID on success, false on failure

_removeAdminMenus

Method to remove admin menu references to a component

_removeAdminMenus(int id) : bool
since

3.1

Arguments

id

intThe ID of the extension whose admin menus will be removed

Response

boolTrue if successful.

_rollback_menu

Custom rollback method

  • Roll back the component menu item
_rollback_menu(array step) : bool
since

3.1

Arguments

step

arrayInstallation step to rollback.

Response

boolTrue on success

_updateMenus

Method to update menu database entries for a component in case if the component has been uninstalled before.

_updateMenus(int|null componentId, int clientId = null) : bool
since

3.7.0

Arguments

componentId

int|nullThe component ID.

clientId

intThe client id

Response

boolTrue if successful

_updateSiteMenus

Method to update menu database entries for a component in case the component has been uninstalled before.

_updateSiteMenus(int|null componentId = null) : bool

NOTE: This will not update admin menus. Use _updateMenus() instead to update admin menus ase well.

since

3.4.2

Arguments

componentId

int|nullThe component ID.

Response

boolTrue if successful

canUninstallPackageChild

Check if a package extension allows its child extensions to be uninstalled individually

canUninstallPackageChild(int packageId) : bool
inherited
since

3.7.0
note

This method defaults to true to emulate the behavior of 3.6 and earlier which did not support this lookup

Arguments

packageId

intThe extension ID of the package to check

Response

bool

checkExistingExtension

Method to check if the extension is already present in the database

checkExistingExtension() : void
inherited
since

3.4
throws

\RuntimeException

checkExtensionInFilesystem

Method to check if the extension is present in the filesystem, flags the route as update if so

checkExtensionInFilesystem() : void
inherited
since

3.4
throws

\RuntimeException

copyBaseFiles

Method to copy the extension's base files from the <files> tag(s) and the manifest file

copyBaseFiles() : void
inherited abstract
since

3.4
throws

\RuntimeException

createExtensionRoot

Method to create the extension root path if necessary

createExtensionRoot() : void
inherited
since

3.4
throws

\RuntimeException

discover

Discover unregistered extensions.

discover() : array
since

3.1

Response

arrayA list of extensions.

discover_install

Generic discover_install method for extensions

discover_install() : bool
inherited
since

3.4

Response

boolTrue on success

doDatabaseTransactions

Method to handle database transactions for the installer

doDatabaseTransactions() : bool
inherited
since

3.4
throws

\RuntimeException

Response

boolTrue on success

doLoadLanguage

Load language files

doLoadLanguage(string extension, string source, string base = JPATH_ADMINISTRATOR) : void
inherited
since

3.4

Arguments

extension

stringThe name of the extension

source

stringPath to the extension

base

stringBase path for the extension language

finaliseInstall

Method to finalise the installation processing

finaliseInstall() : void
since

3.4
throws

\RuntimeException

getDiscoverInstallSupported

Checks if the adapter supports discover_install

getDiscoverInstallSupported() : bool
inherited
since

3.4

Response

bool

getElement

Get the filtered extension element from the manifest

getElement(string element = null) : string
inherited
since

3.4

Arguments

element

stringOptional element name to be converted

Response

stringThe filtered element

getManifest

Get the manifest object.

getManifest() : \SimpleXMLElement
inherited
since

3.4

Response

\SimpleXMLElementManifest object

getName

Get the filtered component name from the manifest

getName() : string
inherited
since

3.4

Response

stringThe filtered name

getParent

getParent() : \Joomla\CMS\Installer\Installer
inherited

Retrieves the parent object.

Response

\Joomla\CMS\Installer\Installer

getRoute

Get the install route being followed

getRoute() : string
inherited
since

3.4

Response

stringThe install route

getScriptClassName

Get the class name for the install adapter script.

getScriptClassName() : string
inherited
since

3.4

Response

stringThe class name.

install

Generic install method for extensions

install() : bool|int
inherited
since

3.4

Response

bool|intThe extension ID on success, boolean false on failure

loadLanguage

Custom loadLanguage method

loadLanguage(string path = null) : void
since

3.1

Arguments

path

stringThe path language files are on.

parseOptionalTags

Method to parse optional tags in the manifest

parseOptionalTags() : void
inherited
since

3.1

parseQueries

Method to parse the queries specified in the <sql> tags

parseQueries() : void
inherited
since

3.4
throws

\RuntimeException

prepareDiscoverInstall

Prepares the adapter for a discover_install task

prepareDiscoverInstall() : void
inherited
since

3.4

refreshManifestCache

Refreshes the extension table cache

refreshManifestCache() : bool
since

3.1

Response

boolResult of operation, true if updated, false on failure

setManifest

Set the manifest object.

setManifest(object manifest) : \Joomla\CMS\Installer\InstallerAdapter
inherited
since

3.4

Arguments

manifest

objectThe manifest object

Response

\Joomla\CMS\Installer\InstallerAdapterInstance of this class to support chaining

setRoute

Set the install route being followed

setRoute(string route) : \Joomla\CMS\Installer\InstallerAdapter
inherited
since

3.4

Arguments

route

stringThe install route being followed

Response

\Joomla\CMS\Installer\InstallerAdapterInstance of this class to support chaining

setupInstallPaths

Method to do any prechecks and setup the install paths for the extension

setupInstallPaths() : void
inherited abstract
since

3.4

setupScriptfile

Setup the manifest script file for those adapters that use it.

setupScriptfile() : void
inherited
since

3.4

setupUpdates

Method to setup the update routine for the adapter

setupUpdates() : void
inherited
since

3.4

storeExtension

Method to store the extension to the database

storeExtension() : void
inherited abstract
since

3.4
throws

\RuntimeException

triggerManifestScript

Executes a custom install script method

triggerManifestScript(string method) : bool
inherited
since

3.4
throws

\RuntimeException

Arguments

method

stringThe install method to execute

Response

boolTrue on success

uninstall

Custom uninstall method for components

uninstall(int id) : bool
since

3.1

Arguments

id

intThe unique extension id of the component to uninstall

Response

boolTrue on success

update

Generic update method for extensions

update() : bool|int
inherited
since

3.4

Response

bool|intThe extension ID on success, boolean false on failure

Properties

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.

since

3.1

Type(s)

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

Type(s)

array

manifest_script

A path to the PHP file that the scriptfile declaration in the manifest refers to.

inherited
since

3.4

Type(s)

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

Type(s)

string

currentExtensionId

ID for the currently installed extension if present

inherited
since

3.4

Type(s)

int

element

The unique identifier for the extension (e.g. mod_login)

inherited
since

3.4

Type(s)

string

extension

Extension object.

inherited
since

3.4

Type(s)

\Joomla\CMS\Table\Extension

extensionMessage

Messages rendered by custom scripts

inherited
since

3.4

Type(s)

string

manifest

Copy of the XML manifest file.

inherited

Making this object public allows extensions to customize the manifest in custom scripts.

since

3.4

Type(s)

string

name

Name of the extension

inherited
since

3.4

Type(s)

string

route

Install function routing

inherited
since

3.4

Type(s)

string

supportsDiscoverInstall

Flag if the adapter supports discover installs

inherited

Adapters should override this and set to false if discover install is unsupported

since

3.4

Type(s)

bool

type

The type of adapter in use

inherited
since

3.4

Type(s)

string

parent

inherited

Parent object

Type(s)

\Joomla\CMS\Installer\Installer
  • \ Joomla
  • \ CMS
  • \ Installer
  • \ Adapter
  • \ ComponentAdapter