| [ Index ] |
PHP Cross Reference of Joomla 1.5.26 DE |
[Source view] [Print] [Project Stats]
(no description)
| Copyright: | Copyright (C) 2005 - 2010 Open Source Matters. All rights reserved. |
| License: | GNU/GPL, see LICENSE.php |
| Version: | $Id: installer.php 14401 2010-01-26 14:10:00Z louis $ |
| File Size: | 1172 lines (30 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
JInstaller:: (26 methods):
__construct()
getInstance()
getOverwrite()
setOverwrite()
getDBO()
getManifest()
getPath()
setPath()
pushStep()
setAdapter()
abort()
install()
update()
uninstall()
setupInstall()
parseQueries()
parseSQLFiles()
parseFiles()
parseLanguages()
parseMedia()
getParams()
copyFiles()
removeFiles()
copyManifest()
_findManifest()
_isManifest()
Class: JInstaller - X-Ref
Joomla base installer class| __construct() X-Ref |
| Constructor |
| getInstance() X-Ref |
| Returns a reference to 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 |
| setOverwrite($state=false) X-Ref |
| Set the allow overwrite switch param: boolean $state Overwrite switch state return: boolean Previous value |
| getDBO() X-Ref |
| Get the database connector object return: object Database connector object |
| 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 |
| setAdapter($name, $adapter = null) X-Ref |
| Set an installer adapter by name param: string $name Adapter name param: object $adapter Installer adapter object return: boolean True if successful |
| 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 |
| 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: int $cid Application ID return: boolean True if successful |
| 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: object $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 param: string $version The database connector to use return: mixed Number of queries processed or False on error |
| parseFiles($element, $cid=0) X-Ref |
| Method to parse through a files element of the installation manifest and take appropriate action. param: object $element The xml node to process param: int $cid Application ID of application to install to 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: object $element The xml node to process param: int $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: object $element The xml node to process param: int $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 it's default parameters, and return the INI string. return: string INI string of parameter values |
| copyFiles($files, $overwrite=null) X-Ref |
| 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: int $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: int $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 JSimpleXML document, or null if the file failed to parse |
| Generated: Wed Mar 28 15:54:07 2012 | Cross-referenced by PHPXref 0.7.1 |