Configurator
in package
main class to configure modules.
It loads all entry points configurations and all informations about activated modules. Configurator then constructs a tree dependencies for these activated modules, and launch configuration of given module
Tags
Table of Contents
- INSTALL_ERROR_CIRCULAR_DEPENDENCY = 2
- error code stored in a component: impossible to install the module because of circular dependencies.
- INSTALL_ERROR_CONFLICT = 3
- error code stored in a component:.
- INSTALL_ERROR_MISSING_DEPENDENCIES = 1
- error code stored in a component: impossible to install the module because dependencies are missing.
- $consoleInput : InputInterface
- $consoleOutput : OutputInterface
- $globalSetup : GlobalSetup
- the global app setup.
- $mainEntryPoint : EntryPoint
- the main entrypoint of the application.
- $messages : JInstallerMessageProvider
- $moduleParameters : mixed
- $questionHelper : QuestionHelper
- $reporter : ReporterInterface
- the object responsible of the results output.
- __construct() : mixed
- initialize the configuration.
- configureModules() : mixed
- localConfigureEnabledModules() : mixed
- Force launch of configurator of enabled modules, in the local context.
- setModuleAsConfigured() : mixed
- setModuleParameters() : mixed
- set parameters for the installer of a module.
- unconfigureModule() : mixed
- Unconfigure some modules.
- endMessage() : mixed
- error() : mixed
- execModuleConfigure() : mixed
- execModuleUnconfigure() : mixed
- notice() : mixed
- ok() : mixed
- processResolverError() : mixed
- runConfigure() : bool
- runPostConfigure() : bool
- runPostUnconfigure() : bool
- runPreConfigure() : array<string|int, mixed>|bool
- Launch the preConfigure method of each modules configurator.
- runPreUnconfigure() : array<string|int, mixed>|bool
- Launch the preUnconfigure method of each modules configurator.
- runUnconfigure() : bool
- saveConfigurationFiles() : mixed
- startMessage() : mixed
- warning() : mixed
Constants
INSTALL_ERROR_CIRCULAR_DEPENDENCY
error code stored in a component: impossible to install the module because of circular dependencies.
public
mixed
INSTALL_ERROR_CIRCULAR_DEPENDENCY
= 2
INSTALL_ERROR_CONFLICT
error code stored in a component:.
public
mixed
INSTALL_ERROR_CONFLICT
= 3
INSTALL_ERROR_MISSING_DEPENDENCIES
error code stored in a component: impossible to install the module because dependencies are missing.
public
mixed
INSTALL_ERROR_MISSING_DEPENDENCIES
= 1
Properties
$consoleInput
protected
InputInterface
$consoleInput
$consoleOutput
protected
OutputInterface
$consoleOutput
$globalSetup
the global app setup.
protected
GlobalSetup
$globalSetup
$mainEntryPoint
the main entrypoint of the application.
protected
EntryPoint
$mainEntryPoint
$messages
protected
JInstallerMessageProvider
$messages
$moduleParameters
protected
mixed
$moduleParameters
= array()
$questionHelper
protected
QuestionHelper
$questionHelper
$reporter
the object responsible of the results output.
protected
ReporterInterface
$reporter
Methods
__construct()
initialize the configuration.
public
__construct(ReporterInterface $reporter, GlobalSetup $globalSetup, QuestionHelper $helper, InputInterface $input, OutputInterface $output[, mixed $lang = '' ]) : mixed
GlobalSetup reads configurations files of all entry points, and prepare object for each module, needed to configure modules.
Parameters
- $reporter : ReporterInterface
-
object which is responsible to process messages (display, storage or other..)
- $globalSetup : GlobalSetup
- $helper : QuestionHelper
- $input : InputInterface
- $output : OutputInterface
- $lang : mixed = ''
Return values
mixed —configureModules()
public
configureModules(array<string|int, mixed> $modulesList[, string $dedicatedEntryPointId = 'index' ][, null|bool $forLocalConfig = null ][, bool $forceReconfigure = false ]) : mixed
Parameters
- $modulesList : array<string|int, mixed>
-
array of module names
- $dedicatedEntryPointId : string = 'index'
-
entry point from which the module will be mainly accessible
- $forLocalConfig : null|bool = null
-
true if the configuration should be done into the local configuration instead of app configuration (false). give null to use the default configuration mode
- $forceReconfigure : bool = false
-
true if an already configured module should be reconfigured
Return values
mixed —localConfigureEnabledModules()
Force launch of configurator of enabled modules, in the local context.
public
localConfigureEnabledModules() : mixed
Should be used in the case of a user that just installed the application and want to configure it with local parameter.
This is necessary a "forced" configuration, as modules are already enabled by the developers.
Return values
mixed —setModuleAsConfigured()
public
static setModuleAsConfigured(mixed $moduleName, IniModifierInterface $configIni) : mixed
Parameters
- $moduleName : mixed
- $configIni : IniModifierInterface
Return values
mixed —setModuleParameters()
set parameters for the installer of a module.
public
setModuleParameters(string $moduleName, array<string|int, mixed> $parameters) : mixed
Parameters
- $moduleName : string
-
the name of the module
- $parameters : array<string|int, mixed>
-
parameters
Return values
mixed —unconfigureModule()
Unconfigure some modules.
public
unconfigureModule(array<string|int, mixed> $modulesList[, string $dedicatedEntryPointId = 'index' ][, null|bool $forLocalConfig = null ]) : mixed
Parameters
- $modulesList : array<string|int, mixed>
-
array of module names
- $dedicatedEntryPointId : string = 'index'
-
entry point from which the module is mainly accessible
- $forLocalConfig : null|bool = null
-
true if the configuration should be done into the local configuration instead of app configuration (false). give null to use the default configuration mode
Return values
mixed —endMessage()
protected
endMessage() : mixed
Return values
mixed —error()
protected
error(mixed $msg[, mixed $params = null ][, mixed $fullString = false ]) : mixed
Parameters
- $msg : mixed
- $params : mixed = null
- $fullString : mixed = false
Return values
mixed —execModuleConfigure()
protected
execModuleConfigure(Configurator $configurator, ConfigurationHelpers $configHelpers) : mixed
Parameters
- $configurator : Configurator
- $configHelpers : ConfigurationHelpers
Return values
mixed —execModuleUnconfigure()
protected
execModuleUnconfigure(Configurator $configurator, ConfigurationHelpers $configHelpers) : mixed
Parameters
- $configurator : Configurator
- $configHelpers : ConfigurationHelpers
Return values
mixed —notice()
protected
notice(mixed $msg[, mixed $params = null ][, mixed $fullString = false ]) : mixed
Parameters
- $msg : mixed
- $params : mixed = null
- $fullString : mixed = false
Return values
mixed —ok()
protected
ok(mixed $msg[, mixed $params = null ][, mixed $fullString = false ]) : mixed
Parameters
- $msg : mixed
- $params : mixed = null
- $fullString : mixed = false
Return values
mixed —processResolverError()
protected
processResolverError(ItemException $e) : mixed
Parameters
- $e : ItemException
Return values
mixed —runConfigure()
protected
runConfigure(array<string|int, array<string|int, mixed>> $componentsToConfigure, EntryPoint $entryPoint) : bool
Parameters
- $componentsToConfigure : array<string|int, array<string|int, mixed>>
-
each items have a \Jelix\Installer\Module\Configurator object and a \Jelix\Installer\ModuleInstallerLauncher object
- $entryPoint : EntryPoint
Return values
bool —runPostConfigure()
protected
runPostConfigure(array<string|int, array<string|int, mixed>> $componentsToConfigure, EntryPoint $entryPoint) : bool
Parameters
- $componentsToConfigure : array<string|int, array<string|int, mixed>>
-
each items have a \Jelix\Installer\Module\Configurator object and a \Jelix\Installer\ModuleInstallerLauncher object
- $entryPoint : EntryPoint
Return values
bool —runPostUnconfigure()
protected
runPostUnconfigure(array<string|int, array<string|int, mixed>> $componentsToUnconfigure, EntryPoint $entryPoint) : bool
Parameters
- $componentsToUnconfigure : array<string|int, array<string|int, mixed>>
-
each items have a \Jelix\Installer\Module\Configurator object and a \Jelix\Installer\ModuleInstallerLauncher object
- $entryPoint : EntryPoint
Return values
bool —runPreConfigure()
Launch the preConfigure method of each modules configurator.
protected
runPreConfigure(array<string|int, Item> &$moduleschain, EntryPoint $entryPoint, bool|null $forLocalConfig) : array<string|int, mixed>|bool
Parameters
- $moduleschain : array<string|int, Item>
- $entryPoint : EntryPoint
- $forLocalConfig : bool|null
-
If not null, uninstalled modules will be configured into the local or app scope, according to this given value, else installed module will be configured in the scope already indicated into their current status
Return values
array<string|int, mixed>|bool —runPreUnconfigure()
Launch the preUnconfigure method of each modules configurator.
protected
runPreUnconfigure(array<string|int, Item> &$moduleschain, EntryPoint $entryPoint) : array<string|int, mixed>|bool
Parameters
- $moduleschain : array<string|int, Item>
- $entryPoint : EntryPoint
Return values
array<string|int, mixed>|bool —runUnconfigure()
protected
runUnconfigure(array<string|int, array<string|int, mixed>> $componentsToUnconfigure, EntryPoint $entryPoint) : bool
Parameters
- $componentsToUnconfigure : array<string|int, array<string|int, mixed>>
-
each items have a \Jelix\Installer\Module\Configurator object and a \Jelix\Installer\ModuleInstallerLauncher object
- $entryPoint : EntryPoint
Return values
bool —saveConfigurationFiles()
protected
saveConfigurationFiles(EntryPoint $entryPoint) : mixed
Parameters
- $entryPoint : EntryPoint
Return values
mixed —startMessage()
protected
startMessage() : mixed
Return values
mixed —warning()
protected
warning(mixed $msg[, mixed $params = null ][, mixed $fullString = false ]) : mixed
Parameters
- $msg : mixed
- $params : mixed = null
- $fullString : mixed = false