Joomla CMS  2.5.24 (avec JPlatform 11.4 inclus)
Documentation des API du CMS Joomla en version 2.5 et du framework Joomla Platform intégré
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
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

 __construct ()
 getOverwrite ()
 isOverwrite ()
 setOverwrite ($state=false)
 getRedirectURL ()
 setRedirectURL ($newurl)
 getUpgrade ()
 isUpgrade ()
 setUpgrade ($state=false)
 getManifest ()
 getPath ($name, $default=null)
 setPath ($name, $value)
 pushStep ($step)
 abort ($msg=null, $type=null)
 install ($path=null)
 discover_install ($eid=null)
 discover ()
 update ($path=null)
 uninstall ($type, $identifier, $cid=0)
 refreshManifestCache ($eid)
 setupInstall ()
 parseQueries ($element)
 parseSQLFiles ($element)
 setSchemaVersion ($schema, $eid)
 parseSchemaUpdates ($schema, $eid)
 parseFiles ($element, $cid=0, $oldFiles=null, $oldMD5=null)
 parseLanguages ($element, $cid=0)
 parseMedia ($element, $cid=0)
 getParams ()
 copyFiles ($files, $overwrite=null)
 removeFiles ($element, $cid=0)
 copyManifest ($cid=1)
 findManifest ()
 isManifest ($file)
 generateManifestCache ()
 cleanDiscoveredExtension ($type, $element, $folder= '', $client=0)
 findDeletedFiles ($old_files, $new_files)
 loadMD5Sum ($filename)
- Fonctions membres publiques inherited from JAdapter
 __construct ($basepath, $classprefix=null, $adapterfolder=null)
 getDBO ()
 setAdapter ($name, &$adapter=null, $options=array())
 getAdapter ($name, $options=array())
 loadAllAdapters ($options=array())
- Fonctions membres publiques inherited from JObject
 __construct ($properties=null)
 __toString ()
 def ($property, $default=null)
 get ($property, $default=null)
 getProperties ($public=true)
 getError ($i=null, $toString=true)
 getErrors ()
 set ($property, $value=null)
 setProperties ($properties)
 setError ($error)
 toString ()

Fonctions membres publiques statiques

static getInstance ()
static parseXMLInstallFile ($path)

Attributs publics

 $manifestClass = null
 $extension = null
 $message = null
 $manifest = null

Attributs protégés

 $_paths = array()
 $_upgrade = null
 $_overwrite = false
 $_stepStack = array()
 $extension_message = null
 $redirect_url = null
- Attributs protégés inherited from JAdapter
 $_adapters = array()
 $_adapterfolder = 'adapters'
 $_classprefix = 'J'
 $_basepath = null
 $_db
- Attributs protégés inherited from JObject
 $_errors = array()

Attributs protégés statiques

static $instance

Documentation des constructeurs et destructeur

JInstaller::__construct ( )

Constructor

Depuis:
11.1

Documentation des fonctions membres

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

Installation abort method

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

Références $db, $query, $type, JText\_(), JFile\delete(), JFolder\delete(), JFactory\getConfig(), null, JError\raiseError(), et JError\raiseWarning().

+ Voici le graphe d'appel pour cette fonction :

JInstaller::cleanDiscoveredExtension (   $type,
  $element,
  $folder = '',
  $client = 0 
)

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

Paramètres:
string$typeThe type of extension (component, etc)
string$elementUnique element identifier (e.g. com_content)
string$folderThe folder of the extension (plugins; e.g. system)
integer$clientThe client application (administrator or site)
Renvoie:
object Result of query
Depuis:
11.1

Références $client, $folder, $query, et $type.

JInstaller::copyFiles (   $files,
  $overwrite = null 
)

Copyfiles

Copy files from source directory to the target directory

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

Références $file, $files, JPath\clean(), JFolder\copy(), JFile\copy(), elseif, null, 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

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

Références $client, $path, et JApplicationHelper\getClientInfo().

+ Voici le graphe d'appel pour cette fonction :

JInstaller::discover ( )

Extension discover method Asks each adapter to find extensions

Renvoie:
array JExtension
Depuis:
11.1
JInstaller::discover_install (   $eid = null)

Discovered package installation method

Paramètres:
integer$eidExtension ID
Renvoie:
boolean True if successful
Depuis:
11.1

Références $dispatcher, JText\_(), JDispatcher\getInstance(), JTable\getInstance(), JPluginHelper\importPlugin(), et null.

+ Voici le graphe d'appel pour cette fonction :

JInstaller::findDeletedFiles (   $old_files,
  $new_files 
)

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

Paramètres:
array$old_filesAn array of SimpleXMLElement objects that are the old files
array$new_filesAn array of SimpleXMLElement objects that are the new files
Renvoie:
array An array with the delete files and folders in findDeletedFiles[files] and findDeletedFiles[folders] respectively
Depuis:
11.1

Références $file, et $files.

JInstaller::findManifest ( )

Tries to find the package manifest file

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::generateManifestCache ( )

Generates a manifest cache

Renvoie:
string serialised manifest data
Depuis:
11.1

Références JApplicationHelper\parseXMLInstallFile().

+ Voici le graphe d'appel pour cette fonction :

static JInstaller::getInstance ( )
static

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

Renvoie:
object An installer object
Depuis:
11.1

Référencé par InstallerModelDiscover\discover(), InstallerModelDiscover\discover_install(), JoomlaupdateModelDefault\finaliseUpgrade(), JInstallationModelDatabase\initialise(), InstallerModelInstall\install(), InstallerModelLanguages\install(), InstallerModelUpdate\install(), InstallerModelManage\refresh(), et InstallerModelManage\remove().

+ Voici le graphe des appelants de cette fonction :

JInstaller::getManifest ( )

Get the installation manifest object

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

Get the allow overwrite switch

Renvoie:
boolean Allow overwrite switch
Depuis:
11.1
Obsolète:
12.1 Use JInstaller::isOverwrite()

Références JLog\add(), et JLog\WARNING.

+ Voici le graphe d'appel pour cette fonction :

JInstaller::getParams ( )

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

Renvoie:
string INI string of parameter values
Depuis:
11.1

Références $field, $fieldsets, $name, et null.

JInstaller::getPath (   $name,
  $default = null 
)

Get an installer path by name

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

Références $name.

JInstaller::getRedirectURL ( )

Get the redirect location

Renvoie:
string Redirect location (or null)
Depuis:
11.1
JInstaller::getUpgrade ( )

Get the upgrade switch

Renvoie:
boolean
Depuis:
11.1
Obsolète:
12.1 Use JInstaller::isUpgrade()

Références JLog\add(), et JLog\WARNING.

+ Voici le graphe d'appel pour cette fonction :

JInstaller::install (   $path = null)

Package installation method

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

Références $dispatcher, $path, $type, JText\_(), JFolder\exists(), JDispatcher\getInstance(), et JPluginHelper\importPlugin().

Référencé par JInstallerPackage\install().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

JInstaller::isManifest (   $file)

Is the XML file a valid Joomla installation manifest file.

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

Références $file, JFactory\getXML(), et null.

+ Voici le graphe d'appel pour cette fonction :

JInstaller::isOverwrite ( )

Get the allow overwrite switch

Renvoie:
boolean Allow overwrite switch
Depuis:
11.4
JInstaller::isUpgrade ( )

Get the upgrade switch

Renvoie:
boolean
Depuis:
11.4
JInstaller::loadMD5Sum (   $filename)

Loads an MD5SUMS file into an associative array

Paramètres:
string$filenameFilename to load
Renvoie:
array Associative array with filenames as the index and the MD5 as the value
Depuis:
11.1

Références $data, et $row.

JInstaller::parseFiles (   $element,
  $cid = 0,
  $oldFiles = null,
  $oldMD5 = null 
)

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

Paramètres:
SimpleXMLElement$elementThe XML node to process
integer$cidApplication ID of application to install to
array$oldFilesList of old files (SimpleXMLElement's)
array$oldMD5List of old MD5 sums (indexed by filename with value as MD5)
Renvoie:
boolean True on success
Depuis:
11.1

Références $client, $file, $folder, $path, JFolder\create(), JFile\delete(), JFolder\delete(), JApplicationHelper\getClientInfo(), JError\raiseWarning(), et JText\sprintf().

+ 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.

Paramètres:
SimpleXMLElement$elementThe XML node to process
integer$cidApplication ID of application to install to
Renvoie:
boolean True on success
Depuis:
11.1

Références $client, $file, $folder, $path, JFolder\create(), JFolder\exists(), JApplicationHelper\getClientInfo(), JError\raiseWarning(), et JText\sprintf().

+ 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.

Paramètres:
SimpleXMLElement$elementThe XML node to process
integer$cidApplication ID of application to install to
Renvoie:
boolean True on success
Depuis:
11.1

Références $client, $file, $folder, $path, JPath\clean(), JFolder\create(), JApplicationHelper\getClientInfo(), JPATH_ROOT, null, JError\raiseWarning(), et JText\sprintf().

+ 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.

Paramètres:
SimpleXMLElement$elementThe XML node to process
Renvoie:
mixed Number of queries processed or False on error
Depuis:
11.1

Références $db, $query, JError\raiseWarning(), et JText\sprintf().

+ Voici le graphe d'appel pour cette fonction :

JInstaller::parseSchemaUpdates (   $schema,
  $eid 
)

Method to process the updates for an item

Paramètres:
SimpleXMLElement$schemaThe XML node to process
integer$eidExtension Identifier
Renvoie:
boolean Result of the operations
Depuis:
11.1

Références $db, $file, $files, $query, $version, JText\_(), elseif, JFolder\files(), JError\raiseWarning(), JInstallerHelper\splitSql(), et JText\sprintf().

+ 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.

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

Références $db, $file, $query, JText\_(), elseif, JError\raiseWarning(), JInstallerHelper\splitSql(), et JText\sprintf().

+ Voici le graphe d'appel pour cette fonction :

static JInstaller::parseXMLInstallFile (   $path)
static

Parse a XML install manifest file.

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

Paramètres:
string$pathFull path to XML file.
Renvoie:
array XML metadata.
Depuis:
12.1

Références $data, $path, JText\_(), et JFactory\getXML().

Référencé par ModulesHelperXML\parseXMLModuleFile(), PluginsHelper\parseXMLTemplateFile(), et TemplatesHelper\parseXMLTemplateFile().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

JInstaller::pushStep (   $step)

Pushes a step onto the installer stack for rolling back steps

Paramètres:
array$stepInstaller step
Renvoie:
void
Depuis:
11.1
JInstaller::refreshManifestCache (   $eid)

Refreshes the manifest cache stored in #__extensions

Paramètres:
integer$eidExtension ID
Renvoie:
mixed void on success, false on error
Depuis:
11.1

Références JText\_(), JTable\getInstance(), et JText\sprintf().

+ Voici le graphe d'appel pour cette fonction :

JInstaller::removeFiles (   $element,
  $cid = 0 
)

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

Paramètres:
object$elementThe XML node to process
integer$cidApplication ID of application to remove from
Renvoie:
boolean True on success
Depuis:
11.1

Références $client, $file, $files, $folder, $GLOBALS, $path, JFile\delete(), JFolder\delete(), JFolder\exists(), JApplicationHelper\getClientInfo(), null, et JError\raiseWarning().

+ Voici le graphe d'appel pour cette fonction :

JInstaller::setOverwrite (   $state = false)

Set the allow overwrite switch

Paramètres:
boolean$stateOverwrite switch state
Renvoie:
boolean True it state is set, false if it is not
Depuis:
11.1

Références $state.

JInstaller::setPath (   $name,
  $value 
)

Sets an installer path by name

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

Références $name.

Référencé par JInstallerPlugin\install(), et JInstallerComponent\update().

+ Voici le graphe des appelants de cette fonction :

JInstaller::setRedirectURL (   $newurl)

Set the redirect location

Paramètres:
string$newurlNew redirect location
Renvoie:
void
Depuis:
11.1
JInstaller::setSchemaVersion (   $schema,
  $eid 
)

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

Paramètres:
SimpleXMLElement$schemaSchema Tag
integer$eidExtension ID
Renvoie:
void
Depuis:
11.1

Références $db, $files, $query, elseif, et JFolder\files().

+ Voici le graphe d'appel pour cette fonction :

JInstaller::setUpgrade (   $state = false)

Set the upgrade switch

Paramètres:
boolean$stateUpgrade switch state
Renvoie:
boolean True if upgrade, false otherwise
Depuis:
11.1

Références $state.

JInstaller::setupInstall ( )

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

Renvoie:
boolean True on success
Depuis:
11.1

Références $type.

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

Package uninstallation method

Paramètres:
string$typePackage type
mixed$identifierPackage identifier for adapter
integer$cidApplication ID; deprecated in 1.6
Renvoie:
boolean True if successful
Depuis:
11.1

Références $dispatcher, $type, JDispatcher\getInstance(), et JPluginHelper\importPlugin().

Référencé par JInstallerLibrary\install().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

JInstaller::update (   $path = null)

Package update method

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

Références $dispatcher, $path, $type, JText\_(), JFolder\exists(), JDispatcher\getInstance(), et JPluginHelper\importPlugin().

+ Voici le graphe d'appel pour cette fonction :


Documentation des données membres

JInstaller::$_overwrite = false
protected
JInstaller::$_paths = array()
protected
JInstaller::$_stepStack = array()
protected
JInstaller::$_upgrade = null
protected
JInstaller::$extension = null
JInstaller::$extension_message = null
protected
JInstaller::$instance
staticprotected
JInstaller::$manifest = null
JInstaller::$manifestClass = null
JInstaller::$message = null
JInstaller::$redirect_url = null
protected

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