Configurator
in package
implements
ConfiguratorInterface
Uses
InstallConfigTrait
Base class for classes which configure a module.
Tags
Interfaces, Classes and Traits
- ConfiguratorInterface
- Interface for classes which configure a module.
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.
- declareUrls() : void
- List of Url to declare on entrypoints.
- getDefaultParameters() : array<string|int, mixed>
- List of possible installation parameters with their default values.
- getEntryPointsToCreate() : array<string|int, EntryPointToInstall>
- List of entrypoint to create
- 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.
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()
Tags
$componentName
private
string
$componentName
name of the component
Tags
$name
private
string
$name
name of the installer
Tags
$path
The path of the module.
private
string
$path
Tags
$version
private
string
$version
= '0'
the version for which the installer is called
Tags
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
Tags
Return values
mixed —configure()
Configure the module.
public
configure(ConfigurationHelpers $helpers) : mixed
Parameters
- $helpers : ConfigurationHelpers
Tags
Return values
mixed —declareUrls()
List of Url to declare on entrypoints.
public
declareUrls(EntryPointUrlModifier $registerOnEntryPoint) : void
By default, it searches an urls.xml file in the module, and if there is one, it attach it on the main entrypoint with the module name as path info. Else it declares the module on the main entrypoint, to have automatic urls. If you want to setup urls on specific entrypoints, you must override this method.
Parameters
- $registerOnEntryPoint : EntryPointUrlModifier
Tags
Return values
void —getDefaultParameters()
List of possible installation parameters with their default values.
public
getDefaultParameters() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getEntryPointsToCreate()
List of entrypoint to create
public
getEntryPointsToCreate() : array<string|int, EntryPointToInstall>
Return the list of entrypoint that your module need to install. No need to call yourself ConfigurationHelpers::createEntryPoint() and ConfigurationHelpers::removeEntryPoint(). These entrypoints will be removed automatically when you will deconfigure the module.
Tags
Return values
array<string|int, EntryPointToInstall> —getFilesToCopy()
List of files or directories to copy.
public
getFilesToCopy() : array<string|int, string>
Tags
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:') Target can be an array containing the path and a boolean indicating if, when the target already exists, it should be overwritten (true) or not (false). By default it is overwritten.
getModuleName()
public
final getModuleName() : mixed
Tags
Return values
mixed —getName()
public
final getName() : mixed
Tags
Return values
mixed —getParameter()
public
final getParameter(mixed $name) : mixed
Parameters
- $name : mixed
Tags
Return values
mixed —getParameters()
{@inheritdoc}
public
final getParameters() : mixed
Tags
Return values
mixed —getPath()
public
final getPath() : mixed
Tags
Return values
mixed —getVersion()
public
final getVersion() : mixed
Tags
Return values
mixed —localConfigure()
Configure the module in the context of the local configuration.
public
localConfigure(LocalConfigurationHelpers $helpers) : mixed
Parameters
- $helpers : LocalConfigurationHelpers
Tags
Return values
mixed —localUnconfigure()
Unconfigure the module in the context of the local configuration.
public
localUnconfigure(LocalConfigurationHelpers $helpers) : mixed
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
Parameters
- $helpers : PreConfigurationHelpers
Tags
Return values
mixed —preUnconfigure()
called before unconfiguration of any modules.
public
preUnconfigure(PreConfigurationHelpers $helpers) : mixed
Parameters
- $helpers : PreConfigurationHelpers
Tags
Return values
mixed —setParameters()
{@inheritdoc}
public
final setParameters(mixed $parameters) : mixed
Parameters
- $parameters : mixed
Tags
Return values
mixed —unconfigure()
Unconfigure the module.
public
unconfigure(ConfigurationHelpers $helpers) : mixed
Parameters
- $helpers : ConfigurationHelpers