PluginInstaller
extends ExtensionInstaller
in package
Base class for different extension installers.
Tags
Table of Contents
Properties
- $fileFetcher : FileFetcher
- Class responsible for fetching files from source.
- $pluginType : string
- Core, upload or user.
Methods
- abort() : void
- When installation procedure was not completed, abort changes.
- fetchFiles() : void
- Order the file fetcher to fetch files.
- getConfig() : ExtensionConfig|null
- Get the configuration from temp dir.
- install() : void
- Install unzipped package into correct folder.
- isWhitelisted() : bool
- Returns true if the plugin name is allowlisted or the allowlist is disabled.
- setFileFetcher() : void
- setPluginType() : void
- uninstall() : void
- Uninstall the extension.
- update() : void
- Update the plugin.
Properties
$fileFetcher
Class responsible for fetching files from source.
protected
FileFetcher
$fileFetcher
$pluginType
Core, upload or user.
protected
string
$pluginType
Methods
abort()
When installation procedure was not completed, abort changes.
public
abort() : void
fetchFiles()
Order the file fetcher to fetch files.
public
fetchFiles() : void
Tags
getConfig()
Get the configuration from temp dir.
public
getConfig() : ExtensionConfig|null
Before an extension is installed, we need to read the config file. That's why the extension if fetched into a temp folder first.
Return values
ExtensionConfig|nullinstall()
Install unzipped package into correct folder.
public
install() : void
Assumes file fetcher and config is set.
Tags
isWhitelisted()
Returns true if the plugin name is allowlisted or the allowlist is disabled.
public
isWhitelisted() : bool
Return values
boolsetFileFetcher()
public
setFileFetcher(FileFetcher $fileFetcher) : void
Parameters
- $fileFetcher : FileFetcher
setPluginType()
public
setPluginType(string $pluginType) : void
Parameters
- $pluginType : string
uninstall()
Uninstall the extension.
public
uninstall() : void
Tags
update()
Update the plugin.
public
update() : void
Assumes file fetcher and config is set.