Jelix 1.7.18

jelixModuleConfigurator extends Configurator
in package

Base class for classes which configure a module.

Tags
subpackage

jelix-module

author

Laurent Jouanneau

copyright

2018-2019 Laurent Jouanneau

see
http://www.jelix.org
licence

GNU Lesser General Public Licence see LICENCE file or http://www.gnu.org/licenses/lgpl.html

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()

$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

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:')

getParameter()

public final getParameter(mixed $name) : mixed
Parameters
$name : mixed
Return values
mixed

getParameters()

{@inheritdoc}

public final getParameters() : mixed
Return values
mixed

getVersion()

public final getVersion() : mixed
Return values
mixed

setParameters()

{@inheritdoc}

public final setParameters(mixed $parameters) : mixed
Parameters
$parameters : mixed
Return values
mixed

migrateConfig()

protected migrateConfig(IniReaderInterface $ini[, mixed $forLocal = false ]) : mixed
Parameters
$ini : IniReaderInterface
$forLocal : mixed = false
Return values
mixed

Search results