Joomla CMS
3.9.25 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.9.25 et du framework Joomla Platform intégré
|
Fonctions membres publiques | |
__construct ($basepath=__DIR__, $classprefix='\\Joomla\\CMS\\Installer\\Adapter', $adapterfolder='Adapter') | |
isOverwrite () | |
setOverwrite ($state=false) | |
getRedirectUrl () | |
setRedirectUrl ($newurl) | |
isPackageUninstall () | |
setPackageUninstall ($uninstall) | |
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 ($route='install', $returnAdapter=false) | |
parseQueries (\SimpleXMLElement $element) | |
parseSQLFiles ($element) | |
setSchemaVersion (\SimpleXMLElement $schema, $eid) | |
parseSchemaUpdates (\SimpleXMLElement $schema, $eid) | |
parseFiles (\SimpleXMLElement $element, $cid=0, $oldFiles=null, $oldMD5=null) | |
parseLanguages (\SimpleXMLElement $element, $cid=0) | |
parseMedia (\SimpleXMLElement $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 ($oldFiles, $newFiles) | |
loadMD5Sum ($filename) | |
getAdapter ($name, $options=array()) | |
getAdapters ($options=array(), array $custom=array()) | |
loadAdapter ($adapter, $options=array()) | |
loadAllAdapters ($options=array()) | |
Fonctions membres publiques hérités de JAdapter | |
__construct ($basepath, $classprefix=null, $adapterfolder=null) | |
getDbo () | |
getAdapter ($name, $options=array()) | |
setAdapter ($name, &$adapter=null, $options=array()) | |
loadAllAdapters ($options=array()) | |
Fonctions membres publiques statiques | |
static | getInstance ($basepath=__DIR__, $classprefix='\\Joomla\\CMS\\Installer\\Adapter', $adapterfolder='Adapter') |
static | parseXMLInstallFile ($path) |
Champs de données | |
$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 | |
$packageUninstall = false | |
Attributs protégés hérités de JAdapter | |
$_adapters = array() | |
$_adapterfolder = 'adapters' | |
$_classprefix = 'J' | |
$_basepath = null | |
$_db | |
Attributs protégés statiques | |
static | $instance |
static | $instances |
Joomla base installer class
__construct | ( | $basepath = __DIR__ , |
|
$classprefix = '\\Joomla\\CMS\\Installer\\Adapter' , |
|||
$adapterfolder = 'Adapter' |
|||
) |
Constructor
string | $basepath | Base Path of the adapters |
string | $classprefix | Class prefix of adapters |
string | $adapterfolder | Name of folder to append to base path |
Références extension, et Table\getInstance().
cleanDiscoveredExtension | ( | $type, | |
$element, | |||
$folder = '' , |
|||
$client = 0 |
|||
) |
Cleans up discovered extensions if they're being installed some other way
string | $type | The type of extension (component, etc) |
string | $element | Unique element identifier (e.g. com_content) |
string | $folder | The folder of the extension (plugins; e.g. system) |
integer | $client | The client application (administrator or site) |
copyFiles | ( | $files, | |
$overwrite = null |
|||
) |
copyManifest | ( | $cid = 1 | ) |
Copies the installation manifest file to the extension folder in the given client
integer | $cid | Where to copy the installfile [optional: defaults to 1 (admin)] |
Références $client, $path, et ApplicationHelper\getClientInfo().
discover | ( | ) |
Extension discover method
Asks each adapter to find extensions
discover_install | ( | $eid = null | ) |
Discovered package installation method
integer | $eid | Extension ID |
Références $dispatcher, $params, $type, extension, JEventDispatcher\getInstance(), PluginHelper\importPlugin(), et null.
findDeletedFiles | ( | $oldFiles, | |
$newFiles | |||
) |
Compares two "files" entries to find deleted files/folders
array | $oldFiles | An array of objects that are the old files |
array | $newFiles | An array of objects that are the new files |
findManifest | ( | ) |
generateManifestCache | ( | ) |
getAdapter | ( | $name, | |
$options = array() |
|||
) |
Fetches an adapter and adds it to the internal storage if an instance is not set while also ensuring its a valid adapter name
string | $name | Name of adapter to return |
array | $options | Adapter options |
getAdapters | ( | $options = array() , |
|
array | $custom = array() |
||
) |
Gets a list of available install adapters.
array | $options | An array of options to inject into the adapter |
array | $custom | Array of custom install adapters |
Références $class, $file, $files, $name, $options, et JLoader\register().
|
static |
getManifest | ( | ) |
getParams | ( | ) |
Method to parse the parameters of an extension, build the JSON string for its default parameters, and return the JSON string.
Références $field, $fieldsets, $name, $value, json_encode, et null.
getPath | ( | $name, | |
$default = null |
|||
) |
getRedirectUrl | ( | ) |
Get the redirect location
install | ( | $path = null | ) |
Package installation method
string | $path | Path to package source folder |
Références $dispatcher, $manifest, $path, JEventDispatcher\getInstance(), et PluginHelper\importPlugin().
Référencé par PackageAdapter\copyBaseFiles().
isManifest | ( | $file | ) |
isOverwrite | ( | ) |
Get the allow overwrite switch
isPackageUninstall | ( | ) |
Get whether this installer is uninstalling extensions which are part of a package
isUpgrade | ( | ) |
Get the upgrade switch
loadAdapter | ( | $adapter, | |
$options = array() |
|||
) |
Method to load an adapter instance
Références $class, $options, $path, et JLoader\register().
loadAllAdapters | ( | $options = array() | ) |
loadMD5Sum | ( | $filename | ) |
Method to parse through a files element of the installation manifest and take appropriate action.
\SimpleXMLElement | $element | The XML node to process |
integer | $cid | Application ID of application to install to |
array | $oldFiles | List of old files (SimpleXMLElement's) |
array | $oldMD5 | List of old MD5 sums (indexed by filename with value as MD5) |
Références $client, $file, $folder, $path, et ApplicationHelper\getClientInfo().
parseLanguages | ( | \SimpleXMLElement | $element, |
$cid = 0 |
|||
) |
Method to parse through a languages element of the installation manifest and take appropriate action.
\SimpleXMLElement | $element | The XML node to process |
integer | $cid | Application ID of application to install to |
Références $client, $file, $folder, $path, et ApplicationHelper\getClientInfo().
parseMedia | ( | \SimpleXMLElement | $element, |
$cid = 0 |
|||
) |
Method to parse through a media element of the installation manifest and take appropriate action.
\SimpleXMLElement | $element | The XML node to process |
integer | $cid | Application ID of application to install to |
Références $file, $folder, $path, JPATH_ROOT, et null.
parseQueries | ( | \SimpleXMLElement | $element | ) |
parseSchemaUpdates | ( | \SimpleXMLElement | $schema, |
$eid | |||
) |
parseSQLFiles | ( | $element | ) |
|
static |
Parse a XML install manifest file.
XML Root tag should be 'install' except for languages which use meta file.
string | $path | Full path to XML file. |
Références $data, $name, et $path.
Référencé par ModuleAdapter\discover(), LibraryAdapter\discover(), TemplateAdapter\discover(), PluginAdapter\discover(), LanguageAdapter\discover(), ComponentAdapter\discover(), LanguageAdapter\discover_install(), LibraryAdapter\refreshManifestCache(), ModuleAdapter\refreshManifestCache(), TemplateAdapter\refreshManifestCache(), FileAdapter\refreshManifestCache(), PluginAdapter\refreshManifestCache(), PackageAdapter\refreshManifestCache(), LanguageAdapter\refreshManifestCache(), ComponentAdapter\refreshManifestCache(), LibraryAdapter\storeExtension(), TemplateAdapter\storeExtension(), et PluginAdapter\storeExtension().
pushStep | ( | $step | ) |
refreshManifestCache | ( | $eid | ) |
removeFiles | ( | $element, | |
$cid = 0 |
|||
) |
Method to parse through a files element of the installation manifest and remove the files that were installed
object | $element | The XML node to process |
integer | $cid | Application ID of application to remove from |
Références $client, $file, $files, $folder, $path, ApplicationHelper\getClientInfo(), et null.
setOverwrite | ( | $state = false | ) |
setPackageUninstall | ( | $uninstall | ) |
Set whether this installer is uninstalling extensions which are part of a package
boolean | $uninstall | True if a package triggered the uninstall, false otherwise |
Référencé par LibraryAdapter\checkExtensionInFilesystem(), et PackageAdapter\uninstall().
setPath | ( | $name, | |
$value | |||
) |
Sets an installer path by name
string | $name | Path name |
string | $value | Path |
Référencé par PluginAdapter\createExtensionRoot(), et ComponentAdapter\setupUpdates().
setRedirectUrl | ( | $newurl | ) |
Set the redirect location
string | $newurl | New redirect location |
setSchemaVersion | ( | \SimpleXMLElement | $schema, |
$eid | |||
) |
setUpgrade | ( | $state = false | ) |
Prepare for installation: this method sets the installation directory, finds and checks the installation file and verifies the installation type.
string | $route | The install route being followed |
boolean | $returnAdapter | Flag to return the instantiated adapter |
uninstall | ( | $type, | |
$identifier, | |||
$cid = 0 |
|||
) |
Package uninstallation method
string | $type | Package type |
mixed | $identifier | Package identifier for adapter |
integer | $cid | Application ID; deprecated in 1.6 |
Références $dispatcher, $params, $type, extension, JEventDispatcher\getInstance(), et PluginHelper\importPlugin().
update | ( | $path = null | ) |
Package update method
string | $path | Path to package source folder |
Références $dispatcher, $manifest, $path, JEventDispatcher\getInstance(), et PluginHelper\importPlugin().
|
protected |
|
staticprotected |
|
staticprotected |
$manifest = null |
$manifestClass = null |
$message = null |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |