ConfiguratorInterface
in
Interface for classes which configure a module.
Tags
Table of Contents
- configure() : mixed
- Configure the module.
- getDefaultParameters() : array<string|int, mixed>
- List of possible installation parameters with their default values.
- getParameters() : array<string|int, mixed>
- return list of installation parameters.
- localConfigure() : mixed
- Configure the module in the context of the local configuration.
- localUnconfigure() : mixed
- Unconfigure the module in the context of the local configuration.
- postConfigure() : mixed
- called after the configuration of all modules.
- postUnconfigure() : mixed
- called after the unconfiguration of all modules.
- preConfigure() : mixed
- called before configuration of any modules.
- preUnconfigure() : mixed
- called before unconfiguration of any modules.
- setParameters() : mixed
- indicates installation parameters to use.
- unconfigure() : mixed
- Unconfigure the module.
Methods
configure()
Configure the module.
public
configure(ConfigurationHelpers $helpers) : mixed
You can set some configuration parameters in the application configuration files, you can also copy some files into the application, setup the urls mapping etc.
Parameters
- $helpers : ConfigurationHelpers
Tags
Return values
mixed —getDefaultParameters()
List of possible installation parameters with their default values.
public
getDefaultParameters() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getParameters()
return list of installation parameters.
public
getParameters() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —localConfigure()
Configure the module in the context of the local configuration.
public
localConfigure(LocalConfigurationHelpers $helpers) : mixed
You can set some configuration parameters in the local configuration files, you can also copy some files into the application, setup the urls mapping etc.
It is useful when the module is installed natively into the application, but you want to do additional configuration setup in an instance of the application, that depends on the local context of the application
Parameters
- $helpers : LocalConfigurationHelpers
Tags
Return values
mixed —localUnconfigure()
Unconfigure the module in the context of the local configuration.
public
localUnconfigure(LocalConfigurationHelpers $helpers) : mixed
You can remove some configuration parameters from the application parameters that are not needed for the uninstaller. You can also delete some files you installed into the configure() method, remove the url mapping etc..
Parameters
- $helpers : LocalConfigurationHelpers
Tags
Return values
mixed —postConfigure()
called after the configuration of all modules.
public
postConfigure(ConfigurationHelpers $helpers) : mixed
Parameters
- $helpers : ConfigurationHelpers
Tags
Return values
mixed —postUnconfigure()
called after the unconfiguration of all modules.
public
postUnconfigure(ConfigurationHelpers $helpers) : mixed
Parameters
- $helpers : ConfigurationHelpers
Tags
Return values
mixed —preConfigure()
called before configuration of any modules.
public
preConfigure(PreConfigurationHelpers $helpers) : mixed
This is the opportunity to check some things. Throw an exception to interrupt the configuration process.
Parameters
- $helpers : PreConfigurationHelpers
Tags
Return values
mixed —preUnconfigure()
called before unconfiguration of any modules.
public
preUnconfigure(PreConfigurationHelpers $helpers) : mixed
This is the opportunity to check some things. Throw an exception to interrupt the configuration process.
Parameters
- $helpers : PreConfigurationHelpers
Tags
Return values
mixed —setParameters()
indicates installation parameters to use.
public
setParameters(array<string|int, mixed> $parameters) : mixed
can be called whether the interactive mode is enabled or not (but before preConfigure())
Parameters
- $parameters : array<string|int, mixed>
Tags
Return values
mixed —unconfigure()
Unconfigure the module.
public
unconfigure(ConfigurationHelpers $helpers) : mixed
You can remove some configuration parameters from the application parameters that are not needed for the uninstaller. You can also delete some files you installed into the configure() method, remove the url mapping etc..
Parameters
- $helpers : ConfigurationHelpers