jelixModuleConfigurator
extends Configurator
in package
Base class for classes which configure a module.
Tags
Table of Contents
- $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.
- $version : string
- __construct() : mixed
- configure() : mixed
- Configure the module.
- getDefaultParameters() : array<string|int, mixed>
- List of possible installation parameters with their default values.
- getFilesToCopy() : array<string|int, string>
- List of files or directories to copy.
- getModuleName() : mixed
- getName() : mixed
- getParameter() : mixed
- getParameters() : mixed
- {@inheritdoc}
- getPath() : mixed
- getVersion() : mixed
- 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
- {@inheritdoc}
- unconfigure() : mixed
- Unconfigure the module.
- migrate() : mixed
- migrateConfig() : mixed
- migrateLocal() : mixed
Properties
$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
$version
private
string
$version
= '0'
the version for which the installer is called
Methods
__construct()
public
__construct(string $componentName, string $name, string $path, string $version) : 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
Return values
mixed —configure()
Configure the module.
public
configure(ConfigurationHelpers $helpers) : mixed
Parameters
- $helpers : ConfigurationHelpers
Return values
mixed —getDefaultParameters()
List of possible installation parameters with their default values.
public
getDefaultParameters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getFilesToCopy()
List of files or directories to copy.
public
getFilesToCopy() : array<string|int, string>
Return values
array<string|int, string> —- keys are relative path to the install/ directory of the module
- values are target path. Shortcut allowed ('www:', 'config:', 'var:', 'temp:', 'log:')
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 —getVersion()
public
final getVersion() : mixed
Return values
mixed —localConfigure()
Configure the module in the context of the local configuration.
public
localConfigure(LocalConfigurationHelpers $helpers) : mixed
Parameters
- $helpers : LocalConfigurationHelpers
Return values
mixed —localUnconfigure()
Unconfigure the module in the context of the local configuration.
public
localUnconfigure(LocalConfigurationHelpers $helpers) : mixed
Parameters
- $helpers : LocalConfigurationHelpers
Return values
mixed —postConfigure()
called after the configuration of all modules.
public
postConfigure(ConfigurationHelpers $helpers) : mixed
Parameters
- $helpers : ConfigurationHelpers
Return values
mixed —postUnconfigure()
called after the unconfiguration of all modules.
public
postUnconfigure(ConfigurationHelpers $helpers) : mixed
Parameters
- $helpers : ConfigurationHelpers
Return values
mixed —preConfigure()
called before configuration of any modules.
public
preConfigure(PreConfigurationHelpers $helpers) : mixed
Parameters
- $helpers : PreConfigurationHelpers
Return values
mixed —preUnconfigure()
called before unconfiguration of any modules.
public
preUnconfigure(PreConfigurationHelpers $helpers) : mixed
Parameters
- $helpers : PreConfigurationHelpers
Return values
mixed —setParameters()
{@inheritdoc}
public
final setParameters(mixed $parameters) : mixed
Parameters
- $parameters : mixed
Return values
mixed —unconfigure()
Unconfigure the module.
public
unconfigure(ConfigurationHelpers $helpers) : mixed
Parameters
- $helpers : ConfigurationHelpers
Return values
mixed —migrate()
protected
migrate(ConfigurationHelpers $helpers) : mixed
Parameters
- $helpers : ConfigurationHelpers
Return values
mixed —migrateConfig()
protected
migrateConfig(IniReaderInterface $ini[, mixed $forLocal = false ]) : mixed
Parameters
- $ini : IniReaderInterface
- $forLocal : mixed = false
Return values
mixed —migrateLocal()
protected
migrateLocal(LocalConfigurationHelpers $helpers) : mixed
Parameters
- $helpers : LocalConfigurationHelpers