API Joomla 1.5.26
Documentation des API du CMS Joomla en version 1.5

Référence de la classe JInstaller

Graphe d'héritage de JInstaller:
Graphe de collaboration de JInstaller:

Liste de tous les membres

Fonctions membres publiques

Fonctions membres publiques statiques

Attributs publics


Documentation des constructeurs et destructeur

JInstaller::__construct ( )

Constructor

protected

Réimplémentée à partir de JObject.

Réimplémentée dans mosInstaller.

Références JFactory::getDBO().

Voici le graphe d'appel pour cette fonction :


Documentation des fonctions membres

JInstaller::_findManifest ( )

Tries to find the package manifest file

private

Renvoie:
boolean True on success, False on error
Depuis:
1.0

Références $file, JText::_(), JFolder::files(), et JError::raiseWarning().

Voici le graphe d'appel pour cette fonction :

& JInstaller::_isManifest ( file)

Is the xml file a valid Joomla installation manifest file

private

Paramètres:
string$fileAn xmlfile path to check
Renvoie:
mixed A JSimpleXML document, or null if the file failed to parse
Depuis:
1.5

Références $file, et JFactory::getXMLParser().

Voici le graphe d'appel pour cette fonction :

JInstaller::abort ( msg = null,
type = null 
)

Installation abort method

public

Paramètres:
string$msgAbort message from the installer
string$typePackage type if defined
Renvoie:
boolean True if successful
Depuis:
1.5

Références $type, JFolder::delete(), JFile::delete(), et JError::raiseWarning().

Voici le graphe d'appel pour cette fonction :

JInstaller::copyFiles ( files,
overwrite = null 
)

Copy files from source directory to the target directory

public

Paramètres:
array$filesarray with filenames
boolean$overwriteTrue if existing files can be replaced
Renvoie:
boolean True on success
Depuis:
1.5

Références $file, JPath::clean(), JFile::copy(), JFolder::copy(), elseif, JError::raiseWarning(), et JText::sprintf().

Voici le graphe d'appel pour cette fonction :

JInstaller::copyManifest ( cid = 1)

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

public

Paramètres:
int$cidWhere to copy the installfile [optional: defaults to 1 (admin)]
Renvoie:
boolean True on success, False on error
Depuis:
1.5

Références $cid, $client, $path, JApplicationHelper::getClientInfo(), et jimport().

Voici le graphe d'appel pour cette fonction :

& JInstaller::getDBO ( )

Get the database connector object

public

Renvoie:
object Database connector object
Depuis:
1.5
& JInstaller::getInstance ( ) [static]

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

Renvoie:
object An installer object
Depuis:
1.5

Référencé par InstallerModelInstall::install(), InstallerModelLanguages::remove(), et InstallerModel::remove().

Voici le graphe d'appel pour cette fonction :

& JInstaller::getManifest ( )

Get the installation manifest object

public

Renvoie:
object Manifest object
Depuis:
1.5
JInstaller::getOverwrite ( )

Get the allow overwrite switch

public

Renvoie:
boolean Allow overwrite switch
Depuis:
1.5
JInstaller::getParams ( )

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

public

Renvoie:
string INI string of parameter values
Depuis:
1.5

Références $name, et $params.

JInstaller::getPath ( name,
default = null 
)

Get an installer path by name

public

Paramètres:
string$namePath name
string$defaultDefault value
Renvoie:
string Path
Depuis:
1.5

Références $name.

JInstaller::install ( path = null)

Package installation method

public

Paramètres:
string$pathPath to package source folder
Renvoie:
boolean True if successful
Depuis:
1.5

Références $config, $path, $type, $version, JText::_(), JFolder::exists(), et JFactory::getConfig().

Voici le graphe d'appel pour cette fonction :

JInstaller::parseFiles ( element,
cid = 0 
)

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

public

Paramètres:
object$elementThe xml node to process
int$cidApplication ID of application to install to
Renvoie:
boolean True on success
Depuis:
1.5

Références $cid, $client, $file, $folder, $path, JText::_(), JFolder::create(), JApplicationHelper::getClientInfo(), jimport(), et JError::raiseWarning().

Voici le graphe d'appel pour cette fonction :

JInstaller::parseLanguages ( element,
cid = 0 
)

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

public

Paramètres:
object$elementThe xml node to process
int$cidApplication ID of application to install to
Renvoie:
boolean True on success
Depuis:
1.5

Références $cid, $client, $file, $folder, $path, JText::_(), JFolder::create(), JFolder::exists(), JApplicationHelper::getClientInfo(), jimport(), et JError::raiseWarning().

Voici le graphe d'appel pour cette fonction :

JInstaller::parseMedia ( element,
cid = 0 
)

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

public

Paramètres:
object$elementThe xml node to process
int$cidApplication ID of application to install to
Renvoie:
boolean True on success
Depuis:
1.5

Références $cid, $client, $file, $folder, $path, JText::_(), JPath::clean(), JFolder::create(), JApplicationHelper::getClientInfo(), jimport(), et JError::raiseWarning().

Voici le graphe d'appel pour cette fonction :

JInstaller::parseQueries ( element)

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

public

Paramètres:
object$elementThe xml node to process
Renvoie:
mixed Number of queries processed or False on error
Depuis:
1.5

Références $db, $query, JText::_(), et JError::raiseWarning().

Voici le graphe d'appel pour cette fonction :

JInstaller::parseSQLFiles ( element)

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

public

Paramètres:
object$elementThe xml node to process
string$versionThe database connector to use
Renvoie:
mixed Number of queries processed or False on error
Depuis:
1.5

Références $db, $file, $query, JText::_(), jimport(), JError::raiseWarning(), et JInstallerHelper::splitSql().

Voici le graphe d'appel pour cette fonction :

JInstaller::pushStep ( step)

Pushes a step onto the installer stack for rolling back steps

public

Paramètres:
array$stepInstaller step
Renvoie:
void
Depuis:
1.5
JInstaller::removeFiles ( element,
cid = 0 
)

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

public

Paramètres:
object$elementThe xml node to process
int$cidApplication ID of application to remove from
Renvoie:
boolean True on success
Depuis:
1.5

Références $cid, $client, $file, $folder, $path, JFile::delete(), JFolder::delete(), JFolder::exists(), JApplicationHelper::getClientInfo(), et jimport().

Voici le graphe d'appel pour cette fonction :

JInstaller::setAdapter ( name,
adapter = null 
)

Set an installer adapter by name

public

Paramètres:
string$nameAdapter name
object$adapterInstaller adapter object
Renvoie:
boolean True if successful
Depuis:
1.5

Références $class, et $name.

JInstaller::setOverwrite ( state = false)

Set the allow overwrite switch

public

Paramètres:
boolean$stateOverwrite switch state
Renvoie:
boolean Previous value
Depuis:
1.5

Références $state.

JInstaller::setPath ( name,
value 
)

Sets an installer path by name

public

Paramètres:
string$namePath name
string$valuePath
Renvoie:
void
Depuis:
1.5

Références $name.

JInstaller::setupInstall ( )

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

public

Renvoie:
boolean True on success
Depuis:
1.0

Références $type.

JInstaller::uninstall ( type,
identifier,
cid = 0 
)

Package uninstallation method

public

Paramètres:
string$typePackage type
mixed$identifierPackage identifier for adapter
int$cidApplication ID
Renvoie:
boolean True if successful
Depuis:
1.5

Références $cid, et $type.

JInstaller::update ( path = null)

Package update method

public

Paramètres:
string$pathPath to package source folder
Renvoie:
boolean True if successful
Depuis:
1.5

Références $config, $path, $type, $version, JText::_(), JFolder::exists(), et JFactory::getConfig().

Voici le graphe d'appel pour cette fonction :


Documentation des données membres

JInstaller::$_adapters = array()
JInstaller::$_db = null
JInstaller::$_manifest = null
JInstaller::$_overwrite = false
JInstaller::$_paths = array()
JInstaller::$_stepStack = array()
JInstaller::$message = null

La documentation de cette classe a été générée à partir du fichier suivant :