Uninstaller
extends InstallerAbstract
in package
implements
UninstallerInterface
A class that does processing to uninstall a module from an instance of the application. A module should have a class that inherits from it in order to remove things from the application.
Tags
Interfaces, Classes and Traits
- UninstallerInterface
- interface for classes that uninstall a module.
Table of Contents
- $defaultDbProfile : string
- $parameters : array<string|int, mixed>
- parameters for the installer, indicated in the configuration file or dynamically, by a launcher in a command line for instance.
- $componentName : string
- $name : string
- $path : string
- The path of the module.
- __construct() : mixed
- getDefaultDbProfile() : mixed
- getModuleName() : mixed
- getName() : mixed
- getParameter() : mixed
- getParameters() : mixed
- {@inheritdoc}
- getPath() : mixed
- postUninstall() : mixed
- Redefine this method if you do some additional process after the uninstallation of all modules.
- preUninstall() : mixed
- Called before the uninstallation of all other modules.
- setParameters() : mixed
- {@inheritdoc}
- uninstall() : mixed
- should uninstall the module.
Properties
$defaultDbProfile
protected
string
$defaultDbProfile
= ''
the default profile name for the component, if it exist. keep it to '' if not
$parameters
parameters for the installer, indicated in the configuration file or dynamically, by a launcher in a command line for instance.
protected
array<string|int, mixed>
$parameters
= array()
$componentName
private
string
$componentName
name of the component
$name
private
string
$name
name of the installer
$path
The path of the module.
private
string
$path
Methods
__construct()
public
__construct(string $componentName, string $name, string $path, string $version[, bool $installWholeApp = true ]) : mixed
Parameters
- $componentName : string
-
name of the component
- $name : string
-
name of the installer
- $path : string
-
the component path
- $version : string
-
version of the component
- $installWholeApp : bool = true
-
deprecated
Return values
mixed —getDefaultDbProfile()
public
getDefaultDbProfile() : mixed
Return values
mixed —getModuleName()
public
final getModuleName() : mixed
Return values
mixed —getName()
public
final getName() : mixed
Return values
mixed —getParameter()
public
final getParameter(mixed $name) : mixed
Parameters
- $name : mixed
Return values
mixed —getParameters()
{@inheritdoc}
public
final getParameters() : mixed
Return values
mixed —getPath()
public
final getPath() : mixed
Return values
mixed —postUninstall()
Redefine this method if you do some additional process after the uninstallation of all modules.
public
postUninstall(InstallHelpers $helpers) : mixed
Parameters
- $helpers : InstallHelpers
Return values
mixed —preUninstall()
Called before the uninstallation of all other modules.
public
preUninstall(PreInstallHelpers $helpers) : mixed
Parameters
- $helpers : PreInstallHelpers
Return values
mixed —setParameters()
{@inheritdoc}
public
final setParameters(mixed $parameters) : mixed
Parameters
- $parameters : mixed
Return values
mixed —uninstall()
should uninstall the module.
public
uninstall(InstallHelpers $helpers) : mixed
Parameters
- $helpers : InstallHelpers