InstallerScriptInterface
Base install script interface for use by extensions providing helper methods for common behaviours.
| since |
4.2.0 |
|---|---|
| package |
Joomla CMS |
Methods
install
Function called after the extension is installed.
install(\Joomla\CMS\Installer\InstallerAdapter adapter) : bool
| since |
4.2.0 |
|---|
Arguments
- adapter
\Joomla\CMS\Installer\InstallerAdapterThe adapter calling this method
Response
boolTrue on success
postflight
Function called after extension installation/update/removal procedure commences.
postflight(string type, \Joomla\CMS\Installer\InstallerAdapter adapter) : bool
| since |
4.2.0 |
|---|
Arguments
- type
stringThe type of change (install or discover_install, update, uninstall)- adapter
\Joomla\CMS\Installer\InstallerAdapterThe adapter calling this method
Response
boolTrue on success
preflight
Function called before extension installation/update/removal procedure commences.
preflight(string type, \Joomla\CMS\Installer\InstallerAdapter adapter) : bool
| since |
4.2.0 |
|---|
Arguments
- type
stringThe type of change (install or discover_install, update, uninstall)- adapter
\Joomla\CMS\Installer\InstallerAdapterThe adapter calling this method
Response
boolTrue on success
uninstall
Function called after the extension is uninstalled.
uninstall(\Joomla\CMS\Installer\InstallerAdapter adapter) : bool
| since |
4.2.0 |
|---|
Arguments
- adapter
\Joomla\CMS\Installer\InstallerAdapterThe adapter calling this method
Response
boolTrue on success
update
Function called after the extension is updated.
update(\Joomla\CMS\Installer\InstallerAdapter adapter) : bool
| since |
4.2.0 |
|---|
Arguments
- adapter
\Joomla\CMS\Installer\InstallerAdapterThe adapter calling this method
Response
boolTrue on success