Actions

API17

Difference between revisions of "JInstaller"

From Joomla! Documentation

(Layout updates)
(Updated to r1448:247ba8d88526)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 +
=={{JVer|11.1}} JInstaller==
 +
===Description===
 +
{{Description:JInstaller}}
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[Description:JInstaller|Edit Descripton]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[Description:JInstaller|Edit Descripton]]<nowiki>]</nowiki>
 
</span>
 
</span>
{{Description:JInstaller}}
 
===Defined in===
 
libraries/joomla/installer/installer.php
 
* see source code in [[jplatform:installer/installer.php|BitBucket]]
 
===Subpackage===
 
[[Subpackage Installer/11.1|Installer]]
 
===Extends===
 
[[JAdapter/11.1|JAdapter]]
 
===Extended by===
 
 
===Methods===
 
===Methods===
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
 +
!Visibility
 
!Method name
 
!Method name
 
!Description
 
!Description
 
|-
 
|-
 +
|public
 
|[[JInstaller::__construct/11.1|__construct]]
 
|[[JInstaller::__construct/11.1|__construct]]
 
|Constructor.  
 
|Constructor.  
 
|-
 
|-
 +
|public
 
|[[JInstaller::abort/11.1|abort]]
 
|[[JInstaller::abort/11.1|abort]]
 
|Installation abort method.  
 
|Installation abort method.  
 
|-
 
|-
 +
|public
 
|[[JInstaller::cleanDiscoveredExtension/11.1|cleanDiscoveredExtension]]
 
|[[JInstaller::cleanDiscoveredExtension/11.1|cleanDiscoveredExtension]]
 
|Cleans up discovered extensions if they're being installed somehow else.  
 
|Cleans up discovered extensions if they're being installed somehow else.  
 
|-
 
|-
 +
|public
 
|[[JInstaller::copyFiles/11.1|copyFiles]]
 
|[[JInstaller::copyFiles/11.1|copyFiles]]
|Copy files from source directory to the target directory.  
+
|Copyfiles.  
 
|-
 
|-
 +
|public
 
|[[JInstaller::copyManifest/11.1|copyManifest]]
 
|[[JInstaller::copyManifest/11.1|copyManifest]]
 
|Copies the installation manifest file to the extension folder in the given client.  
 
|Copies the installation manifest file to the extension folder in the given client.  
 
|-
 
|-
 +
|public
 
|[[JInstaller::discover/11.1|discover]]
 
|[[JInstaller::discover/11.1|discover]]
 
|Extension discover method Asks each adapter to find extensions.  
 
|Extension discover method Asks each adapter to find extensions.  
 
|-
 
|-
 +
|public
 
|[[JInstaller::discover_install/11.1|discover_install]]
 
|[[JInstaller::discover_install/11.1|discover_install]]
 
|
 
|
 
|-
 
|-
 +
|public
 
|[[JInstaller::findDeletedFiles/11.1|findDeletedFiles]]
 
|[[JInstaller::findDeletedFiles/11.1|findDeletedFiles]]
 
|Compares two "files" entries to find deleted files/folders.  
 
|Compares two "files" entries to find deleted files/folders.  
 
|-
 
|-
 +
|public
 
|[[JInstaller::findManifest/11.1|findManifest]]
 
|[[JInstaller::findManifest/11.1|findManifest]]
 
|Tries to find the package manifest file.  
 
|Tries to find the package manifest file.  
 
|-
 
|-
 +
|public
 
|[[JInstaller::generateManifestCache/11.1|generateManifestCache]]
 
|[[JInstaller::generateManifestCache/11.1|generateManifestCache]]
 
|Generates a manifest cache.  
 
|Generates a manifest cache.  
 
|-
 
|-
 +
|public
 
|[[JInstaller::getManifest/11.1|getManifest]]
 
|[[JInstaller::getManifest/11.1|getManifest]]
 
|Get the installation manifest object.  
 
|Get the installation manifest object.  
 
|-
 
|-
 +
|public
 
|[[JInstaller::getOverwrite/11.1|getOverwrite]]
 
|[[JInstaller::getOverwrite/11.1|getOverwrite]]
 
|Get the allow overwrite switch.  
 
|Get the allow overwrite switch.  
 
|-
 
|-
 +
|public
 
|[[JInstaller::getParams/11.1|getParams]]
 
|[[JInstaller::getParams/11.1|getParams]]
|Method to parse the parameters of an extension, build the INI string for it's default parameters, and return the INI string.  
+
|Method to parse the parameters of an extension, build the INI string for its default parameters, and return the INI string.  
 
|-
 
|-
 +
|public
 
|[[JInstaller::getPath/11.1|getPath]]
 
|[[JInstaller::getPath/11.1|getPath]]
 
|Get an installer path by name.  
 
|Get an installer path by name.  
 
|-
 
|-
 +
|public
 
|[[JInstaller::getRedirectURL/11.1|getRedirectURL]]
 
|[[JInstaller::getRedirectURL/11.1|getRedirectURL]]
 
|Get the redirect location.  
 
|Get the redirect location.  
 
|-
 
|-
 +
|public
 
|[[JInstaller::getUpgrade/11.1|getUpgrade]]
 
|[[JInstaller::getUpgrade/11.1|getUpgrade]]
 
|Get the allow overwrite switch.  
 
|Get the allow overwrite switch.  
 
|-
 
|-
 +
|public
 
|[[JInstaller::install/11.1|install]]
 
|[[JInstaller::install/11.1|install]]
 
|Package installation method.  
 
|Package installation method.  
 
|-
 
|-
 +
|public
 
|[[JInstaller::isManifest/11.1|isManifest]]
 
|[[JInstaller::isManifest/11.1|isManifest]]
 
|Is the xml file a valid Joomla installation manifest file.  
 
|Is the xml file a valid Joomla installation manifest file.  
 
|-
 
|-
 +
|public
 
|[[JInstaller::loadMD5Sum/11.1|loadMD5Sum]]
 
|[[JInstaller::loadMD5Sum/11.1|loadMD5Sum]]
 
|Loads an MD5SUMS file into an associative array.  
 
|Loads an MD5SUMS file into an associative array.  
 
|-
 
|-
 +
|public
 
|[[JInstaller::parseFiles/11.1|parseFiles]]
 
|[[JInstaller::parseFiles/11.1|parseFiles]]
 
|Method to parse through a files element of the installation manifest and take appropriate action.  
 
|Method to parse through a files element of the installation manifest and take appropriate action.  
 
|-
 
|-
 +
|public
 
|[[JInstaller::parseLanguages/11.1|parseLanguages]]
 
|[[JInstaller::parseLanguages/11.1|parseLanguages]]
 
|Method to parse through a languages element of the installation manifest and take appropriate action.  
 
|Method to parse through a languages element of the installation manifest and take appropriate action.  
 
|-
 
|-
 +
|public
 
|[[JInstaller::parseMedia/11.1|parseMedia]]
 
|[[JInstaller::parseMedia/11.1|parseMedia]]
 
|Method to parse through a media element of the installation manifest and take appropriate action.  
 
|Method to parse through a media element of the installation manifest and take appropriate action.  
 
|-
 
|-
 +
|public
 
|[[JInstaller::parseQueries/11.1|parseQueries]]
 
|[[JInstaller::parseQueries/11.1|parseQueries]]
|Backward compatible Method to parse through a queries element of the installation manifest file and take appropriate action.  
+
|Backward compatible method to parse through a queries element of the installation manifest file and take appropriate action.  
 
|-
 
|-
 +
|public
 
|[[JInstaller::parseSchemaUpdates/11.1|parseSchemaUpdates]]
 
|[[JInstaller::parseSchemaUpdates/11.1|parseSchemaUpdates]]
 
|Method to process the updates for an item.  
 
|Method to process the updates for an item.  
 
|-
 
|-
 +
|public
 
|[[JInstaller::parseSQLFiles/11.1|parseSQLFiles]]
 
|[[JInstaller::parseSQLFiles/11.1|parseSQLFiles]]
 
|Method to extract the name of a discreet installation sql file from the installation manifest file.  
 
|Method to extract the name of a discreet installation sql file from the installation manifest file.  
 
|-
 
|-
 +
|public
 
|[[JInstaller::pushStep/11.1|pushStep]]
 
|[[JInstaller::pushStep/11.1|pushStep]]
 
|Pushes a step onto the installer stack for rolling back steps.  
 
|Pushes a step onto the installer stack for rolling back steps.  
 
|-
 
|-
 +
|public
 
|[[JInstaller::refreshManifestCache/11.1|refreshManifestCache]]
 
|[[JInstaller::refreshManifestCache/11.1|refreshManifestCache]]
 
|Refreshes the manifest cache stored in __extensions.  
 
|Refreshes the manifest cache stored in __extensions.  
 
|-
 
|-
 +
|public
 
|[[JInstaller::removeFiles/11.1|removeFiles]]
 
|[[JInstaller::removeFiles/11.1|removeFiles]]
 
|Method to parse through a files element of the installation manifest and remove the files that were installed.  
 
|Method to parse through a files element of the installation manifest and remove the files that were installed.  
 
|-
 
|-
 +
|public
 
|[[JInstaller::setOverwrite/11.1|setOverwrite]]
 
|[[JInstaller::setOverwrite/11.1|setOverwrite]]
 
|Set the allow overwrite switch.  
 
|Set the allow overwrite switch.  
 
|-
 
|-
 +
|public
 
|[[JInstaller::setPath/11.1|setPath]]
 
|[[JInstaller::setPath/11.1|setPath]]
 
|Sets an installer path by name.  
 
|Sets an installer path by name.  
 
|-
 
|-
 +
|public
 
|[[JInstaller::setRedirectURL/11.1|setRedirectURL]]
 
|[[JInstaller::setRedirectURL/11.1|setRedirectURL]]
 
|Set the redirct location.  
 
|Set the redirct location.  
 
|-
 
|-
 +
|public
 
|[[JInstaller::setSchemaVersion/11.1|setSchemaVersion]]
 
|[[JInstaller::setSchemaVersion/11.1|setSchemaVersion]]
 
|Set the schema version for an extension by looking at its latest update.  
 
|Set the schema version for an extension by looking at its latest update.  
 
|-
 
|-
 +
|public
 
|[[JInstaller::setUpgrade/11.1|setUpgrade]]
 
|[[JInstaller::setUpgrade/11.1|setUpgrade]]
 
|Set the allow overwrite switch.  
 
|Set the allow overwrite switch.  
 
|-
 
|-
 +
|public
 
|[[JInstaller::setupInstall/11.1|setupInstall]]
 
|[[JInstaller::setupInstall/11.1|setupInstall]]
 
|Prepare for installation: this method sets the installation directory, finds and checks the installation file and verifies the installation type.  
 
|Prepare for installation: this method sets the installation directory, finds and checks the installation file and verifies the installation type.  
 
|-
 
|-
 +
|public
 
|[[JInstaller::uninstall/11.1|uninstall]]
 
|[[JInstaller::uninstall/11.1|uninstall]]
 
|Package uninstallation method.  
 
|Package uninstallation method.  
 
|-
 
|-
 +
|public
 
|[[JInstaller::update/11.1|update]]
 
|[[JInstaller::update/11.1|update]]
 
|Package update method.  
 
|Package update method.  
 
|-
 
|-
 +
|public static
 
|[[JInstaller::getInstance/11.1|getInstance]]
 
|[[JInstaller::getInstance/11.1|getInstance]]
 
|Returns the global Installer object, only creating it if it doesn't already exist.  
 
|Returns the global Installer object, only creating it if it doesn't already exist.  
 
|-
 
|-
 
|}
 
|}
 +
* '''Defined in''' libraries/joomla/installer/installer.php
 +
* '''Extends''' [[JAdapter/11.1|JAdapter]]
 
===Importing===
 
===Importing===
 
<source lang="php">jimport( 'joomla.installer.installer' );</source>
 
<source lang="php">jimport( 'joomla.installer.installer' );</source>
 
===See also===
 
===See also===
* JInstaller source code in [[jplatform:installer/installer.php|BitBucket]]
+
* {{JVer|11.1}} '''JInstaller source code''' on [[jplatform:installer/installer.php|BitBucket]]
* [[JInstaller|Other versions of this class]]
+
* {{JVer|11.1}} Subpackage [[Subpackage Installer/11.1|Installer]]
 +
* [[JInstaller|Other versions of JInstaller]]
 
{{SeeAlso:JInstaller}}
 
{{SeeAlso:JInstaller}}
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[SeeAlso:JInstaller|Edit See Also]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[SeeAlso:JInstaller|Edit See Also]]<nowiki>]</nowiki>
 
</span>
 
</span>
===Examples===
+
===User contributed notes===
 
<CodeExamplesForm />
 
<CodeExamplesForm />
 
<dpl>
 
<dpl>
Line 147: Line 182:
 
category=ClassExample
 
category=ClassExample
 
include=*
 
include=*
 +
namespace=CodeExample
 
format= ,,,
 
format= ,,,
 
</dpl>
 
</dpl>
 
<noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JInstaller]]</noinclude>
 
<noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JInstaller]]</noinclude>

Revision as of 18:05, 27 April 2011

Replacement filing cabinet.png
This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Joomla 11.1 JInstaller

Description

Description:JInstaller [Edit Descripton]

Methods

Visibility Method name Description
public __construct Constructor.
public abort Installation abort method.
public cleanDiscoveredExtension Cleans up discovered extensions if they're being installed somehow else.
public copyFiles Copyfiles.
public copyManifest Copies the installation manifest file to the extension folder in the given client.
public discover Extension discover method Asks each adapter to find extensions.
public discover_install
public findDeletedFiles Compares two "files" entries to find deleted files/folders.
public findManifest Tries to find the package manifest file.
public generateManifestCache Generates a manifest cache.
public getManifest Get the installation manifest object.
public getOverwrite Get the allow overwrite switch.
public getParams Method to parse the parameters of an extension, build the INI string for its default parameters, and return the INI string.
public getPath Get an installer path by name.
public getRedirectURL Get the redirect location.
public getUpgrade Get the allow overwrite switch.
public install Package installation method.
public isManifest Is the xml file a valid Joomla installation manifest file.
public loadMD5Sum Loads an MD5SUMS file into an associative array.
public parseFiles Method to parse through a files element of the installation manifest and take appropriate action.
public parseLanguages Method to parse through a languages element of the installation manifest and take appropriate action.
public parseMedia Method to parse through a media element of the installation manifest and take appropriate action.
public parseQueries Backward compatible method to parse through a queries element of the installation manifest file and take appropriate action.
public parseSchemaUpdates Method to process the updates for an item.
public parseSQLFiles Method to extract the name of a discreet installation sql file from the installation manifest file.
public pushStep Pushes a step onto the installer stack for rolling back steps.
public refreshManifestCache Refreshes the manifest cache stored in __extensions.
public removeFiles Method to parse through a files element of the installation manifest and remove the files that were installed.
public setOverwrite Set the allow overwrite switch.
public setPath Sets an installer path by name.
public setRedirectURL Set the redirct location.
public setSchemaVersion Set the schema version for an extension by looking at its latest update.
public setUpgrade Set the allow overwrite switch.
public setupInstall Prepare for installation: this method sets the installation directory, finds and checks the installation file and verifies the installation type.
public uninstall Package uninstallation method.
public update Package update method.
public static getInstance Returns the global Installer object, only creating it if it doesn't already exist.
  • Defined in libraries/joomla/installer/installer.php
  • Extends JAdapter

Importing

jimport( 'joomla.installer.installer' );

See also

SeeAlso:JInstaller [Edit See Also]

User contributed notes

<CodeExamplesForm />