Difference between revisions of "JInstaller"
From Joomla! Documentation
m (→User contributed notes: moving preparation) |
m (moving preparation) |
||
Line 14: | Line 14: | ||
|- | |- | ||
|public | |public | ||
− | |[[JInstaller::__construct | + | |[[API17:JInstaller::__construct|__construct]] |
|Constructor. | |Constructor. | ||
|- | |- | ||
|public | |public | ||
− | |[[JInstaller::abort | + | |[[API17:JInstaller::abort|abort]] |
|Installation abort method. | |Installation abort method. | ||
|- | |- | ||
|public | |public | ||
− | |[[JInstaller::cleanDiscoveredExtension | + | |[[API17:JInstaller::cleanDiscoveredExtension|cleanDiscoveredExtension]] |
|Cleans up discovered extensions if they're being installed somehow else. | |Cleans up discovered extensions if they're being installed somehow else. | ||
|- | |- | ||
|public | |public | ||
− | |[[JInstaller::copyFiles | + | |[[API17:JInstaller::copyFiles|copyFiles]] |
|Copyfiles. | |Copyfiles. | ||
|- | |- | ||
|public | |public | ||
− | |[[JInstaller::copyManifest | + | |[[API17:JInstaller::copyManifest|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 | |public | ||
− | |[[JInstaller::discover | + | |[[API17:JInstaller::discover|discover]] |
|Extension discover method Asks each adapter to find extensions. | |Extension discover method Asks each adapter to find extensions. | ||
|- | |- | ||
|public | |public | ||
− | |[[JInstaller::discover_install | + | |[[API17:JInstaller::discover_install|discover_install]] |
| | | | ||
|- | |- | ||
|public | |public | ||
− | |[[JInstaller::findDeletedFiles | + | |[[API17:JInstaller::findDeletedFiles|findDeletedFiles]] |
|Compares two "files" entries to find deleted files/folders. | |Compares two "files" entries to find deleted files/folders. | ||
|- | |- | ||
|public | |public | ||
− | |[[JInstaller::findManifest | + | |[[API17:JInstaller::findManifest|findManifest]] |
|Tries to find the package manifest file. | |Tries to find the package manifest file. | ||
|- | |- | ||
|public | |public | ||
− | |[[JInstaller::generateManifestCache | + | |[[API17:JInstaller::generateManifestCache|generateManifestCache]] |
|Generates a manifest cache. | |Generates a manifest cache. | ||
|- | |- | ||
|public | |public | ||
− | |[[JInstaller::getManifest | + | |[[API17:JInstaller::getManifest|getManifest]] |
|Get the installation manifest object. | |Get the installation manifest object. | ||
|- | |- | ||
|public | |public | ||
− | |[[JInstaller::getOverwrite | + | |[[API17:JInstaller::getOverwrite|getOverwrite]] |
|Get the allow overwrite switch. | |Get the allow overwrite switch. | ||
|- | |- | ||
|public | |public | ||
− | |[[JInstaller::getParams | + | |[[API17:JInstaller::getParams|getParams]] |
|Method to parse the parameters of an extension, build the INI string for its 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 | |public | ||
− | |[[JInstaller::getPath | + | |[[API17:JInstaller::getPath|getPath]] |
|Get an installer path by name. | |Get an installer path by name. | ||
|- | |- | ||
|public | |public | ||
− | |[[JInstaller::getRedirectURL | + | |[[API17:JInstaller::getRedirectURL|getRedirectURL]] |
|Get the redirect location. | |Get the redirect location. | ||
|- | |- | ||
|public | |public | ||
− | |[[JInstaller::getUpgrade | + | |[[API17:JInstaller::getUpgrade|getUpgrade]] |
|Get the allow overwrite switch. | |Get the allow overwrite switch. | ||
|- | |- | ||
|public | |public | ||
− | |[[JInstaller::install | + | |[[API17:JInstaller::install|install]] |
|Package installation method. | |Package installation method. | ||
|- | |- | ||
|public | |public | ||
− | |[[JInstaller::isManifest | + | |[[API17:JInstaller::isManifest|isManifest]] |
|Is the xml file a valid Joomla installation manifest file. | |Is the xml file a valid Joomla installation manifest file. | ||
|- | |- | ||
|public | |public | ||
− | |[[JInstaller::loadMD5Sum | + | |[[API17:JInstaller::loadMD5Sum|loadMD5Sum]] |
|Loads an MD5SUMS file into an associative array. | |Loads an MD5SUMS file into an associative array. | ||
|- | |- | ||
|public | |public | ||
− | |[[JInstaller::parseFiles | + | |[[API17:JInstaller::parseFiles|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 | |public | ||
− | |[[JInstaller::parseLanguages | + | |[[API17:JInstaller::parseLanguages|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 | |public | ||
− | |[[JInstaller::parseMedia | + | |[[API17:JInstaller::parseMedia|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 | |public | ||
− | |[[JInstaller::parseQueries | + | |[[API17:JInstaller::parseQueries|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 | |public | ||
− | |[[JInstaller::parseSchemaUpdates | + | |[[API17:JInstaller::parseSchemaUpdates|parseSchemaUpdates]] |
|Method to process the updates for an item. | |Method to process the updates for an item. | ||
|- | |- | ||
|public | |public | ||
− | |[[JInstaller::parseSQLFiles | + | |[[API17:JInstaller::parseSQLFiles|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 | |public | ||
− | |[[JInstaller::pushStep | + | |[[API17:JInstaller::pushStep|pushStep]] |
|Pushes a step onto the installer stack for rolling back steps. | |Pushes a step onto the installer stack for rolling back steps. | ||
|- | |- | ||
|public | |public | ||
− | |[[JInstaller::refreshManifestCache | + | |[[API17:JInstaller::refreshManifestCache|refreshManifestCache]] |
|Refreshes the manifest cache stored in __extensions. | |Refreshes the manifest cache stored in __extensions. | ||
|- | |- | ||
|public | |public | ||
− | |[[JInstaller::removeFiles | + | |[[API17:JInstaller::removeFiles|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 | |public | ||
− | |[[JInstaller::setOverwrite | + | |[[API17:JInstaller::setOverwrite|setOverwrite]] |
|Set the allow overwrite switch. | |Set the allow overwrite switch. | ||
|- | |- | ||
|public | |public | ||
− | |[[JInstaller::setPath | + | |[[API17:JInstaller::setPath|setPath]] |
|Sets an installer path by name. | |Sets an installer path by name. | ||
|- | |- | ||
|public | |public | ||
− | |[[JInstaller::setRedirectURL | + | |[[API17:JInstaller::setRedirectURL|setRedirectURL]] |
|Set the redirct location. | |Set the redirct location. | ||
|- | |- | ||
|public | |public | ||
− | |[[JInstaller::setSchemaVersion | + | |[[API17:JInstaller::setSchemaVersion|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 | |public | ||
− | |[[JInstaller::setUpgrade | + | |[[API17:JInstaller::setUpgrade|setUpgrade]] |
|Set the allow overwrite switch. | |Set the allow overwrite switch. | ||
|- | |- | ||
|public | |public | ||
− | |[[JInstaller::setupInstall | + | |[[API17:JInstaller::setupInstall|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 | |public | ||
− | |[[JInstaller::uninstall | + | |[[API17:JInstaller::uninstall|uninstall]] |
|Package uninstallation method. | |Package uninstallation method. | ||
|- | |- | ||
|public | |public | ||
− | |[[JInstaller::update | + | |[[API17:JInstaller::update|update]] |
|Package update method. | |Package update method. | ||
|- | |- | ||
|public static | |public static | ||
− | |[[JInstaller::getInstance | + | |[[API17:JInstaller::getInstance|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 | * '''Defined in''' libraries/joomla/installer/installer.php | ||
− | * '''Extends''' [[JAdapter | + | * '''Extends''' [[API17:JAdapter|JAdapter]] |
===Importing=== | ===Importing=== | ||
<source lang="php">jimport( 'joomla.installer.installer' );</source> | <source lang="php">jimport( 'joomla.installer.installer' );</source> | ||
===See also=== | ===See also=== | ||
* {{JVer|11.1}} '''JInstaller source code''' on [[jplatform:installer/installer.php|BitBucket]] | * {{JVer|11.1}} '''JInstaller source code''' on [[jplatform:installer/installer.php|BitBucket]] | ||
− | * {{JVer|11.1}} Subpackage [[Subpackage Installer | + | * {{JVer|11.1}} Subpackage [[API17:Subpackage Installer|Installer]] |
− | * [[JInstaller|Other versions of JInstaller]] | + | * [[API17:JInstaller|Other versions of JInstaller]] |
{{SeeAlso:JInstaller}} | {{SeeAlso:JInstaller}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> |
Revision as of 20:58, 11 May 2013
The "API17" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.
JInstaller[edit]
Description[edit]
Template:Description:JInstaller [Edit Descripton]
Methods[edit]
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[edit]
jimport( 'joomla.installer.installer' );
See also[edit]
- JInstaller source code on BitBucket
- Subpackage Installer
- Other versions of JInstaller
Template:SeeAlso:JInstaller [Edit See Also]
User contributed notes[edit]
<CodeExamplesForm />