Joomla! API

Constructor

__construct( basepath = __DIR__,  classprefix = 'JoomlaCMSInstallerAdapter',  adapterfolder = 'Adapter') :

since	3.1

Arguments

basepath: stringBase Path of the adapters
classprefix: stringClass prefix of adapters
adapterfolder: stringName of folder to append to base path

Response

mixed

Installation abort method

abort( msg = null,  type = null) :

since	3.1

Arguments

msg: stringAbort message from the installer
type: stringPackage type if defined

Response

boolTrue if successful

Cleans up discovered extensions if they're being installed some other way

cleanDiscoveredExtension( type,  element,  folder = '',  client) :

since	3.1

Arguments

type: stringThe type of extension (component, etc)
element: stringUnique element identifier (e.g. com_content)
folder: stringThe folder of the extension (plugins; e.g. system)
client: intThe client application (administrator or site)

Response

objectResult of query

Copyfiles

copyFiles(mixed||string|int files,  overwrite = null) :

Copy files from source directory to the target directory

since	3.1

Arguments

files: array<string|int, mixed>Array with filenames
overwrite: boolTrue if existing files can be replaced

Response

boolTrue on success

Copies the installation manifest file to the extension folder in the given client

copyManifest( cid = 1) :

since	3.1

Arguments

cid: intWhere to copy the installfile [optional: defaults to 1 (admin)]

Response

boolTrue on success, False on error

Sets a default value if not already assigned

def( property,  default = null) :

inherited deprecated

since	1.7.0
deprecated	4.3.0 will be removed in 7.0 Defining dynamic properties should not be used anymore

Arguments

property: stringThe name of the property.
default: mixedThe default value.

Response

mixed

Extension discover method

discover() : \Joomla\CMS\Installer\InstallerExtension||string|int

Asks each adapter to find extensions

since	3.1

Response

array<string|int, InstallerExtension>

Discovered package installation method

discover_install( eid = null) :

since	3.1

Arguments

eid: intExtension ID

Response

boolTrue if successful

Compares two "files" entries to find deleted files/folders

findDeletedFiles(mixed||string|int oldFiles, mixed||string|int newFiles) : mixed||string|int

since	3.1

Arguments

oldFiles: array<string|int, mixed>An array of \SimpleXMLElement objects that are the old files
newFiles: array<string|int, mixed>An array of \SimpleXMLElement objects that are the new files

Response

array<string|int, mixed>An array with the delete files and folders in findDeletedFiles[files] and findDeletedFiles[folders] respectively

Tries to find the package manifest file

findManifest() :

since	3.1

Response

boolTrue on success, False on error

Generates a manifest cache

generateManifestCache() :

since	3.1

Response

stringserialised manifest data

Returns a property of the object or the default value if the property is not set.

get( property,  default = null) :

inherited deprecated

since	1.7.0
see	CMSObject::getProperties()
deprecated	4.3.0 will be removed in 7.0 Create a proper getter function for the property

Arguments

property: stringThe name of the property.
default: mixedThe default value.

Response

mixedThe value of the property.

Get an install adapter instance

getAdapter( name, mixed||string|int options = []) : \Joomla\CMS\Installer\InstallerAdapter

throws	`InvalidArgumentException`
since	6.0.0

Arguments

name: stringAdapter name
options: array<string|int, mixed>Adapter options

Response

InstallerAdapter

Gets a list of available install adapters.

getAdapters(mixed||string|int options = [], mixed||string|int custom = []) : string||string|int

since	3.4

Arguments

options: array<string|int, mixed>An array of options to inject into the adapter
custom: array<string|int, mixed>Array of custom install adapters

Response

array<string|int, string>An array of the class names of available install adapters.

Get the most recent error message.

getError( i = null,  toString = true) :

inherited deprecated

since	1.7.0
deprecated	3.1.4 will be removed in 7.0 Will be removed without replacement Catch thrown Exceptions instead of getError

Arguments

i: intOption error index.
toString: boolIndicates if Exception objects should return their error message.

Response

stringError message

Return all errors, if any.

getErrors() : mixed||string|int

inherited deprecated

since	1.7.0
deprecated	3.1.4 will be removed in 7.0 Will be removed without replacement Catch thrown Exceptions instead of getErrors

Response

array<string|int, mixed>Array of error messages.

Returns the global Installer object, only creating it if it doesn't already exist.

getInstance( basepath = __DIR__,  classprefix = 'JoomlaCMSInstallerAdapter',  adapterfolder = 'Adapter') : \Joomla\CMS\Installer\Installer

static

since	3.1

Arguments

basepath: stringBase Path of the adapters
classprefix: stringClass prefix of adapters
adapterfolder: stringName of folder to append to base path

Response

InstallerAn installer object

Get the installation manifest object

getManifest() : \SimpleXMLElement

since	3.1

Response

SimpleXMLElementManifest object

Method to parse the parameters of an extension, build the JSON string for its default parameters, and return the JSON string.

getParams() :

since	3.1
note	This method must always return a JSON compliant string

Response

stringJSON string of parameter values

Get an installer path by name

getPath( name,  default = null) :

since	3.1

Arguments

name: stringPath name
default: stringDefault value

Response

stringPath

Returns an associative array of object properties.

getProperties( public = true) : mixed||string|int

inherited deprecated

since	1.7.0
see	CMSObject::get()
deprecated	4.3.0 will be removed in 7.0 Create a proper getter function for the property

Arguments

public: boolIf true, returns only the public properties.

Response

array<string|int, mixed>

Get the redirect location

getRedirectUrl() :

since	3.1

Response

stringRedirect location (or null)

Package installation method

install( path = null) :

since	3.1

Arguments

path: stringPath to package source folder

Response

boolTrue if successful

Is the XML file a valid Joomla installation manifest file.

isManifest( file) : \SimpleXMLElement|null

since	3.1

Arguments

file: stringAn xmlfile path to check

Response

SimpleXMLElement|nullA \SimpleXMLElement, or null if the file failed to parse

Get the allow overwrite switch

isOverwrite() :

since	3.1

Response

boolAllow overwrite switch

Get whether this installer is uninstalling extensions which are part of a package

isPackageUninstall() :

since	3.7.0

Response

bool

Get the upgrade switch

isUpgrade() :

since	3.1

Response

bool

Method to load an adapter instance

loadAdapter( adapter, mixed||string|int options = []) : \Joomla\CMS\Installer\InstallerAdapter

deprecated

throws	`InvalidArgumentException`
since	3.4
deprecated	6.0.0 will be removed in 7.0 Use getAdapter() instead

Arguments

adapter: stringAdapter name
options: array<string|int, mixed>Adapter options

Response

InstallerAdapter

Discover all adapters in the adapterfolder path

loadAdapters() :

since	6.0.0

Response

void

Loads an MD5SUMS file into an associative array

loadMD5Sum( filename) : mixed||string|int

since	3.1

Arguments

filename: stringFilename to load

Response

array<string|int, mixed>Associative array with filenames as the index and the MD5 as the value

Method to parse through a files element of the installation manifest and take appropriate action.

parseFiles(\SimpleXMLElement element,  cid, mixed||string|int oldFiles = null, mixed||string|int oldMD5 = null) :

since	3.1

Arguments

element: SimpleXMLElementThe XML node to process
cid: intApplication ID of application to install to
oldFiles: array<string|int, mixed>List of old files (SimpleXMLElement's)
oldMD5: array<string|int, mixed>List of old MD5 sums (indexed by filename with value as MD5)

Response

boolTrue on success

Method to parse through a languages element of the installation manifest and take appropriate action.

parseLanguages(\SimpleXMLElement element,  cid) :

since	3.1

Arguments

element: SimpleXMLElementThe XML node to process
cid: intApplication ID of application to install to

Response

boolTrue on success

Method to parse through a media element of the installation manifest and take appropriate action.

parseMedia(\SimpleXMLElement element,  cid) :

since	3.1

Arguments

element: SimpleXMLElementThe XML node to process
cid: intApplication ID of application to install to

Response

boolTrue on success

Backward compatible method to parse through a queries element of the installation manifest file and take appropriate action.

parseQueries(\SimpleXMLElement element) :

since	3.1

Arguments

element: SimpleXMLElementThe XML node to process

Response

mixedNumber of queries processed or False on error

Method to process the updates for an item

parseSchemaUpdates(\SimpleXMLElement schema,  eid) : bool|int

since	3.1

Arguments

schema: SimpleXMLElementThe XML node to process
eid: intExtension Identifier

Response

bool|intNumber of SQL updates executed; false on failure.

Method to extract the name of a discreet installation sql file from the installation manifest file.

parseSQLFiles( element) :

since	3.1

Arguments

element: objectThe XML node to process

Response

mixedNumber of queries processed or False on error

Parse a XML install manifest file.

parseXMLInstallFile( path) : mixed||string|int

static

XML Root tag should be 'install' except for languages which use meta file.

since	3.0.0

Arguments

path: stringFull path to XML file.

Response

array<string|int, mixed>XML metadata.

Pushes a step onto the installer stack for rolling back steps

pushStep(mixed||string|int step) :

since	3.1

Arguments

step: array<string|int, mixed>Installer step

Response

void

Refreshes the manifest cache stored in #__extensions

refreshManifestCache( eid) :

since	3.1

Arguments

eid: intExtension ID

Response

bool

Method to parse through a files element of the installation manifest and remove the files that were installed

removeFiles( element,  cid) :

since	3.1

Arguments

element: objectThe XML node to process
cid: intApplication ID of application to remove from

Response

boolTrue on success

Modifies a property of the object, creating it if it does not already exist.

set( property,  value = null) :

inherited deprecated

since	1.7.0
deprecated	4.3.0 will be removed in 7.0 Create a proper setter function for the property

Arguments

property: stringThe name of the property.
value: mixedThe value of the property to set.

Response

mixedPrevious value of the property.

Set an adapter by name

setAdapter( name, \Joomla\CMS\Installer\InstallerAdapter|string adapter) :

since	6.0.0

Arguments

name: stringAdapter name
adapter: InstallerAdapter|stringAdapter object or class name

Response

boolTrue if successful

Add an error message.

setError( error) :

inherited deprecated

since	1.7.0
deprecated	3.1.4 will be removed in 7.0 Will be removed without replacement Throw an Exception instead of using setError

Arguments

error: stringError message.

Response

void

Set the allow overwrite switch

setOverwrite( state = false) :

since	3.1

Arguments

state: boolOverwrite switch state

Response

boolTrue it state is set, false if it is not

Set whether this installer is uninstalling extensions which are part of a package

setPackageUninstall( uninstall) :

since	3.7.0

Arguments

uninstall: boolTrue if a package triggered the uninstall, false otherwise

Response

void

Sets an installer path by name

setPath( name,  value) :

since	3.1

Arguments

name: stringPath name
value: stringPath

Response

void

Set the object properties based on a named array/hash.

setProperties( properties) :

inherited deprecated

since	1.7.0
see	CMSObject::set()
deprecated	4.3.0 will be removed in 7.0 Create a proper setter function for the property

Arguments

properties: mixedEither an associative array or another object.

Response

bool

Set the redirect location

setRedirectUrl( newurl) :

since	3.1

Arguments

newurl: stringNew redirect location

Response

void

Set the schema version for an extension by looking at its latest update

setSchemaVersion(\SimpleXMLElement schema,  eid) :

since	3.1

Arguments

schema: SimpleXMLElementSchema Tag
eid: intExtension ID

Response

void

Set the upgrade switch

setUpgrade( state = false) :

since	3.1

Arguments

state: boolUpgrade switch state

Response

boolTrue if upgrade, false otherwise

Prepare for installation: this method sets the installation directory, finds and checks the installation file and verifies the installation type.

setupInstall( route = 'install',  returnAdapter = false) : bool|\Joomla\CMS\Installer\InstallerAdapter

since	3.1

Arguments

route: stringThe install route being followed
returnAdapter: boolFlag to return the instantiated adapter

Response

bool|InstallerAdapterInstallerAdapter object if explicitly requested otherwise boolean

If true then subclasses should throw exceptions rather than use getError and setError.

setUseExceptions( value) :

inherited deprecated

since	5.4.0
deprecated	7.0

Arguments

value: boolThe value to set for the field.

Response

void

If true then subclasses should throw exceptions rather than use getError and setError.

shouldUseExceptions() :

inherited deprecated

since	5.4.0
deprecated	7.0

Response

bool

Splits a string of multiple queries into an array of individual queries.

splitSql(string|null sql) : mixed||string|int

static

This is different than DatabaseDriver::splitSql. It supports the special CAN FAIL comment marker which indicates that a SQL statement could fail without raising an error during the installation.

since	4.2.0

Arguments

sql: string|nullInput SQL string with which to split into individual queries.

Response

array<string|int, mixed>

Package uninstallation method

uninstall( type,  identifier) :

since	3.1

Arguments

type: stringPackage type
identifier: mixedPackage identifier for adapter

Response

boolTrue if successful

Package update method

update( path = null) :

since	3.1

Arguments

path: stringPath to package source folder

Response

boolTrue if successful

Update the schema table with the latest version

updateSchemaTable( eid,  version,  update = false) :

since	4.2.0

Arguments

eid: intExtension ID.
version: stringLatest schema version ID.
update: boolShould I run an update against an existing record or insert a new one?

Response

void

A comment marker to indicate that an update SQL query may fail without triggering an update error.

Value	'/ CAN FAIL /'
since	4.2.0

The length of the CAN_FAIL_MARKER string

Value	16
since	4.2.0

An array of error messages or Exception objects.

inherited deprecated

since	1.7.0
deprecated	3.1.4 JError has been deprecated

Type(s)

array<string|int, mixed>

Use exceptions rather than getError/setError.

inherited deprecated

since	5.4.0
deprecated	7.0

Type(s)

bool

Array of installer adapters

since	6.0.0

Type(s)

array<string|int, string>|array<string|int, InstallerAdapter>

Adapter Class Prefix

since	6.0.0

Type(s)

string

Base Path for the installer adapters

since	6.0.0

Type(s)

string

Array of paths needed by the installer

since	3.1

Type(s)

array<string|int, mixed>

True if package is an upgrade

since	3.1

Type(s)

bool

The manifest trigger class

since	3.1

Type(s)

object

True if existing files can be overwritten

since	3.0.0

Type(s)

bool

Stack of installation steps

Used for installation rollback

since	3.1

Type(s)

array<string|int, mixed>

Extension Table Entry

since	3.1

Type(s)

Extension

The output from the install/uninstall scripts

since	3.1

Type(s)

string

The installation manifest XML object

since	3.1

Type(s)

object

The extension message that appears

since	3.1

Type(s)

string

The redirect URL if this extension (can be null if no redirect)

since	3.1

Type(s)

string

Flag if the uninstall process was triggered by uninstalling a package

since	3.7.0

Type(s)

bool

Backup extra_query during update_sites rebuild

since	3.9.26

Type(s)

string

JInstaller instances container.

static

since	3.4

Type(s)

array<string|int, Installer>

Installer

Methods

__construct

Arguments

Response

abort

Arguments

Response

cleanDiscoveredExtension

Arguments

Response

copyFiles

Arguments

Response

copyManifest

Arguments

Response

def

Arguments

Response

discover

Response

discover_install

Arguments

Response

findDeletedFiles

Arguments

Response

findManifest

Response

generateManifestCache

Response

get

Arguments

Response

getAdapter

Arguments

Response

getAdapters

Arguments

Response

getError

Arguments

Response

getErrors

Response

getInstance

Arguments

Response

getManifest

Response

getParams

Response

getPath

Arguments

Response

getProperties

Arguments

Response

getRedirectUrl

Response

install

Arguments

Response

isManifest

Arguments

Response

isOverwrite

Response

isPackageUninstall

Response

isUpgrade

Response

loadAdapter

Arguments

Response

loadAdapters

Response

loadMD5Sum

Arguments