PHPXRef 0.7.1 : Joomla 2.5.4 DE : Detail view of installer.php

Joomla base installer class

Constructor

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

return: object An installer object

getOverwrite() X-Ref

Get the allow overwrite switch

return: boolean Allow overwrite switch

isOverwrite() X-Ref

Get the allow overwrite switch

return: boolean Allow overwrite switch

setOverwrite($state = false) X-Ref

Set the allow overwrite switch

param: boolean $state Overwrite switch state
return: boolean True it state is set, false if it is not

getRedirectURL() X-Ref

Get the redirect location

return: string Redirect location (or null)

setRedirectURL($newurl) X-Ref

Set the redirect location

param: string $newurl New redirect location
return: void

getUpgrade() X-Ref

Get the upgrade switch

return: boolean

isUpgrade() X-Ref

Get the upgrade switch

return: boolean

setUpgrade($state = false) X-Ref

Set the upgrade switch

param: boolean $state Upgrade switch state
return: boolean True if upgrade, false otherwise

getManifest() X-Ref

Get the installation manifest object

return: object Manifest object

getPath($name, $default = null) X-Ref

Get an installer path by name

param: string  $name     Path name
param: string  $default  Default value
return: string  Path

setPath($name, $value) X-Ref

Sets an installer path by name

param: string $name Path name
param: string $value Path
return: void

pushStep($step) X-Ref

Pushes a step onto the installer stack for rolling back steps

param: array $step Installer step
return: void

abort($msg = null, $type = null) X-Ref

Installation abort method

param: string  $msg   Abort message from the installer
param: string  $type  Package type if defined
return: boolean  True if successful

install($path = null) X-Ref

Package installation method

param: string $path Path to package source folder
return: boolean True if successful

discover_install($eid = null) X-Ref

Discovered package installation method

param: integer $eid Extension ID
return: boolean True if successful

discover() X-Ref

Extension discover method
Asks each adapter to find extensions

return: array JExtension

update($path = null) X-Ref

Package update method

param: string $path Path to package source folder
return: boolean True if successful

uninstall($type, $identifier, $cid = 0) X-Ref

Package uninstallation method

param: string   $type        Package type
param: mixed    $identifier  Package identifier for adapter
param: integer  $cid         Application ID; deprecated in 1.6
return: boolean  True if successful

refreshManifestCache($eid) X-Ref

Refreshes the manifest cache stored in #__extensions

param: integer $eid Extension ID
return: mixed void on success, false on error @todo missing return value ?

setupInstall() X-Ref

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

return: boolean True on success

parseQueries($element) X-Ref

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

param: JXMLElement $element The XML node to process
return: mixed Number of queries processed or False on error

parseSQLFiles($element) X-Ref

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

param: object $element The XML node to process
return: mixed Number of queries processed or False on error

setSchemaVersion($schema, $eid) X-Ref

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

param: JXMLElement $schema Schema Tag
param: integer $eid Extension ID
return: void

parseSchemaUpdates($schema, $eid) X-Ref

Method to process the updates for an item

param: JXMLElement  $schema  The XML node to process
param: integer      $eid     Extension Identifier
return: boolean      Result of the operations

parseFiles($element, $cid = 0, $oldFiles = null, $oldMD5 = null) X-Ref

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

param: JXMLElement  $element   The XML node to process
param: integer      $cid       Application ID of application to install to
param: array        $oldFiles  List of old files (JXMLElement's)
param: array        $oldMD5    List of old MD5 sums (indexed by filename with value as MD5)
return: boolean      True on success

parseLanguages($element, $cid = 0) X-Ref

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

param: JXMLElement  $element  The XML node to process
param: integer      $cid      Application ID of application to install to
return: boolean  True on success

parseMedia($element, $cid = 0) X-Ref

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

param: JXMLElement  $element  The XML node to process
param: integer      $cid      Application ID of application to install to
return: boolean     True on success

getParams() X-Ref

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

return: string INI string of parameter values

copyFiles($files, $overwrite = null) X-Ref

Copyfiles

Copy files from source directory to the target directory

param: array    $files      Array with filenames
param: boolean  $overwrite  True if existing files can be replaced
return: boolean  True on success

removeFiles($element, $cid = 0) X-Ref

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

param: object   $element  The XML node to process
param: integer  $cid      Application ID of application to remove from
return: boolean  True on success

copyManifest($cid = 1) X-Ref

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

param: integer $cid Where to copy the installfile [optional: defaults to 1 (admin)]
return: boolean True on success, False on error

findManifest() X-Ref

Tries to find the package manifest file

return: boolean True on success, False on error

isManifest($file) X-Ref

Is the XML file a valid Joomla installation manifest file.

param: string $file An xmlfile path to check
return: mixed A JXMLElement, or null if the file failed to parse

generateManifestCache() X-Ref

Generates a manifest cache

return: string serialised manifest data

cleanDiscoveredExtension($type, $element, $folder = '', $client = 0) X-Ref

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

param: string   $type     The type of extension (component, etc)
param: string   $element  Unique element identifier (e.g. com_content)
param: string   $folder   The folder of the extension (plugins; e.g. system)
param: integer  $client   The client application (administrator or site)
return: object    Result of query

findDeletedFiles($old_files, $new_files) X-Ref

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

param: array  $old_files  An array of JXMLElement objects that are the old files
param: array  $new_files  An array of JXMLElement objects that are the new files
return: array  An array with the delete files and folders in findDeletedFiles[files] and findDeletedFiles[folders] respectively

loadMD5Sum($filename) X-Ref

Loads an MD5SUMS file into an associative array

param: string $filename Filename to load
return: array Associative array with filenames as the index and the MD5 as the value

Copyright:	Copyright (C) 2005 - 2012 Open Source Matters, Inc. All rights reserved.
License:	GNU General Public License version 2 or later; see LICENSE
File Size:	2107 lines (49 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

PHP Cross Reference of Joomla 2.5.4 DE

/libraries/joomla/installer/ -> installer.php (summary)

Defines 1 class