Jelix 1.8.9

GlobalSetup
in package

Tags
since
1.7.0

Table of Contents

$currentProcessedModule  : ModuleInstallerLauncher
$defaultConfigIni  : IniReader
the ini file: jelix/core/defaultconfig.ini.php.
$entryPoints  : array<string|int, EntryPoint>
list of entry point and their properties.
$frameworkInfos  : FrameworkInfos
$ghostModules  : array<string|int, ModuleInstallerLauncher>
list of ghost modules.
$installerContexts  : mixed
$installerIni  : IniModifier
$liveConfigIni  : IniModifier
the liveconfig.ini.php of the application.
$localConfigIni  : IniModifier
the localconfig.ini.php of the application.
$localUninstallerIni  : IniModifier
it represents the var/config/uninstall/uninstaller.ini.php file.
$mainConfigIni  : IniModifier
the mainconfig.ini.php of the application.
$mainEntryPoint  : EntryPoint
$mainUninstallerIni  : IniModifier
it represents the install/uninstall/uninstaller.ini.php file.
$modules  : array<string|int, ModuleInstallerLauncher>
list of modules.
$profilesIni  : IniModifier
$readWriteConfigMode  : bool
$urlLocalMapModifier  : XmlRedefinedMapModifier
$urlMapModifier  : XmlMapModifier
$forLocalConfiguration  : bool
__construct()  : mixed
GlobalSetup constructor.
addModuleComponent()  : mixed
clearUninstallerData()  : void
declareNewEntryPoint()  : mixed
Declare a new entry point.
declareWebAssetsInConfig()  : mixed
forLocalConfiguration()  : bool
getCoordPluginConf()  : null|array<string|int, mixed>
return the section name of configuration of a plugin for the coordinator or the IniModifier for the configuration file of the plugin if it exists.
getCurrentModulePath()  : mixed
getDefaultConfigIni()  : IniReader
the defaultconfig.ini.php file.
getEntryPointById()  : EntryPoint
getEntryPointsByType()  : array<string|int, EntryPoint>
getEntryPointsList()  : array<string|int, EntryPoint>
getFullConfigIni()  : IniModifierArray
All combined config files : defaultconfig.ini.php, mainconfig.ini.php localconfig.ini.php and liveconfig.ini.php.
getGhostModuleComponents()  : array<string|int, ModuleInstallerLauncher>
List of modules that should be uninstall and we have only their uninstaller into install/uninstall/ or var/config/uninstall.
getGhostModuleInfosAndStatuses()  : Generator
getInstallerContexts()  : mixed
getInstallerIni()  : IniModifier
the installer.ini.php.
getLiveConfigIni()  : IniModifierInterface|IniReaderInterface
the liveconfig.ini.php file.
getLocalConfigIni()  : IniModifierInterface|IniReaderInterface
the localconfig.ini.php file.
getLocalUrlModifier()  : XmlMapModifier
getMainConfigIni()  : IniModifierInterface|IniReaderInterface
the mainconfig.ini.php file.
getMainEntryPoint()  : EntryPoint
getModuleComponent()  : null|ModuleInstallerLauncher
getModuleComponentsList()  : array<string|int, ModuleInstallerLauncher>
getModuleInfosAndStatuses()  : Generator
getProfilesIni()  : IniModifierInterface|IniReaderInterface
the profiles.ini.php file.
getSystemConfigIni()  : IniModifierArray
the combined global config files, defaultconfig.ini.php and mainconfig.ini.php.
getUrlModifier()  : XmlMapModifier
isReadWriteConfigMode()  : bool
removeInstallerContexts()  : mixed
removeWebAssetsFromConfig()  : mixed
saveUninstallerData()  : bool
Backup the uninstall.php outside the module.
saveUninstallerIni()  : mixed
setCurrentConfiguratorStatus()  : void
setCurrentProcessedModule()  : mixed
setReadWriteConfigMode()  : mixed
undeclareEntryPoint()  : mixed
Undeclare an entry point.
updateInstallerContexts()  : mixed
loadInstallerIni()  : IniModifier
readEntryPointData()  : mixed
read the list of entrypoint from the project.xml file and read all modules data used by each entry point.
readModuleInfos()  : mixed
readUninstallerFile()  : void

Properties

$defaultConfigIni

the ini file: jelix/core/defaultconfig.ini.php.

protected IniReader $defaultConfigIni
Tags

$entryPoints

list of entry point and their properties.

protected array<string|int, EntryPoint> $entryPoints = array()

keys are entry point id

Tags

$ghostModules

list of ghost modules.

protected array<string|int, ModuleInstallerLauncher> $ghostModules = array()

ghost module is a module for which we have only its uninstaller

key: module name

Tags

$installerContexts

protected mixed $installerContexts = array()
Tags

$installerIni

protected IniModifier $installerIni

it represents the installer.ini.php file.

Tags

$liveConfigIni

the liveconfig.ini.php of the application.

protected IniModifier $liveConfigIni
Tags

$localConfigIni

the localconfig.ini.php of the application.

protected IniModifier $localConfigIni
Tags

$localUninstallerIni

it represents the var/config/uninstall/uninstaller.ini.php file.

protected IniModifier $localUninstallerIni

This file contain informations about modules that are disabled by the user, and for which there are no more sources, only an uninstaller script.

Tags

$mainConfigIni

the mainconfig.ini.php of the application.

protected IniModifier $mainConfigIni
Tags

$mainUninstallerIni

it represents the install/uninstall/uninstaller.ini.php file.

protected IniModifier $mainUninstallerIni

This file contain informations about modules that are disabled by the developer, and for which there are no more sources, only an uninstaller script.

Tags

$profilesIni

protected IniModifier $profilesIni

it represents the profiles.ini.php file.

Tags

$readWriteConfigMode

protected bool $readWriteConfigMode = true

true if the configuration can be modified

Tags

$forLocalConfiguration

private bool $forLocalConfiguration = false

indicates if we should work on the local configuration or into the application configuration (dev mode)

Tags

Methods

__construct()

GlobalSetup constructor.

public __construct([null|FrameworkInfos|string $frameworkFileName = null ][, null|mixed $localFrameworkFileName = null ][, null|string $mainConfigFileName = null ][, null|string $localConfigFileName = null ][, null|string $urlXmlFileName = null ][, null|string $urlLocalXmlFileName = null ]) : mixed
Parameters
$frameworkFileName : null|FrameworkInfos|string = null
$localFrameworkFileName : null|mixed = null
$mainConfigFileName : null|string = null
$localConfigFileName : null|string = null
$urlXmlFileName : null|string = null
$urlLocalXmlFileName : null|string = null
Tags
Return values
mixed

declareNewEntryPoint()

Declare a new entry point.

public declareNewEntryPoint(string $epId, string $epType, string $configFileName) : mixed
Parameters
$epId : string
$epType : string
$configFileName : string
Tags
throws
Exception
Return values
mixed

declareWebAssetsInConfig()

public declareWebAssetsInConfig(IniModifier $config, string $name, array<string|int, mixed> $values, string $collection, bool $force) : mixed
Parameters
$config : IniModifier
$name : string

the name of webassets

$values : array<string|int, mixed>
$collection : string

the name of the webassets collection

$force : bool
Tags
Return values
mixed

forLocalConfiguration()

public forLocalConfiguration() : bool
Return values
bool

indicates if we should work on the local configuration or into the application configuration

getCoordPluginConf()

return the section name of configuration of a plugin for the coordinator or the IniModifier for the configuration file of the plugin if it exists.

public getCoordPluginConf(IniModifierInterface $config, string $pluginName) : null|array<string|int, mixed>
Parameters
$config : IniModifierInterface

the global configuration content

$pluginName : string
Tags
throws
Exception

when the configuration filename is not found

Return values
null|array<string|int, mixed>

null if plugin is unknown, else array($iniModifier, $section)

getCurrentModulePath()

public getCurrentModulePath() : mixed
Tags
Return values
mixed

getDefaultConfigIni()

the defaultconfig.ini.php file.

public getDefaultConfigIni() : IniReader
Tags
Return values
IniReader

getEntryPointsByType()

public getEntryPointsByType([mixed $type = 'classic' ]) : array<string|int, EntryPoint>
Parameters
$type : mixed = 'classic'
Tags
Return values
array<string|int, EntryPoint>

getFullConfigIni()

All combined config files : defaultconfig.ini.php, mainconfig.ini.php localconfig.ini.php and liveconfig.ini.php.

public getFullConfigIni([bool $forceReadOnly = false ]) : IniModifierArray
Parameters
$forceReadOnly : bool = false
Tags
Return values
IniModifierArray

getGhostModuleComponents()

List of modules that should be uninstall and we have only their uninstaller into install/uninstall/ or var/config/uninstall.

public getGhostModuleComponents() : array<string|int, ModuleInstallerLauncher>
Tags
Return values
array<string|int, ModuleInstallerLauncher>

getGhostModuleInfosAndStatuses()

public getGhostModuleInfosAndStatuses() : Generator
Tags
Return values
Generator

getInstallerContexts()

public getInstallerContexts(mixed $moduleName) : mixed
Parameters
$moduleName : mixed
Tags
Return values
mixed

getInstallerIni()

the installer.ini.php.

public getInstallerIni() : IniModifier
Tags
Return values
IniModifier

getLiveConfigIni()

the liveconfig.ini.php file.

public getLiveConfigIni([mixed $forceReadOnly = false ]) : IniModifierInterface|IniReaderInterface
Parameters
$forceReadOnly : mixed = false
Tags
Return values
IniModifierInterface|IniReaderInterface

getLocalConfigIni()

the localconfig.ini.php file.

public getLocalConfigIni([mixed $forceReadOnly = false ]) : IniModifierInterface|IniReaderInterface
Parameters
$forceReadOnly : mixed = false
Tags
Return values
IniModifierInterface|IniReaderInterface

getMainConfigIni()

the mainconfig.ini.php file.

public getMainConfigIni([mixed $forceReadOnly = false ]) : IniModifierInterface|IniReaderInterface
Parameters
$forceReadOnly : mixed = false
Tags
Return values
IniModifierInterface|IniReaderInterface

getModuleInfosAndStatuses()

public getModuleInfosAndStatuses() : Generator
Tags
Return values
Generator

getProfilesIni()

the profiles.ini.php file.

public getProfilesIni([mixed $forceReadOnly = false ]) : IniModifierInterface|IniReaderInterface
Parameters
$forceReadOnly : mixed = false
Tags
Return values
IniModifierInterface|IniReaderInterface

getSystemConfigIni()

the combined global config files, defaultconfig.ini.php and mainconfig.ini.php.

public getSystemConfigIni([mixed $forceReadOnly = false ]) : IniModifierArray
Parameters
$forceReadOnly : mixed = false
Tags
Return values
IniModifierArray

isReadWriteConfigMode()

public isReadWriteConfigMode() : bool
Tags
Return values
bool

true if the configuration can be modified

removeInstallerContexts()

public removeInstallerContexts(mixed $moduleName) : mixed
Parameters
$moduleName : mixed
Tags
Return values
mixed

removeWebAssetsFromConfig()

public removeWebAssetsFromConfig(IniModifier $config, string $name, string $collection) : mixed
Parameters
$config : IniModifier
$name : string

the name of webassets

$collection : string

the name of the webassets collection

Tags
Return values
mixed

saveUninstallerData()

Backup the uninstall.php outside the module.

public saveUninstallerData(ModuleStatus $moduleStatus) : bool

It allows to run the uninstall.php script of the module, even if the module does not exist anymore. This could be the case when the module is bundled into a composer package, and we removed the composer package from composer.json before deploying the application. The script is copied into the install/uninstall or var/config/uninstall/ directory.

For some components that don't have an uninstaller script, we should reference them into uninstaller.ini.php anyway, because we need their information because they are reverse dependencies of another module we should uninstall.

Parameters
$moduleStatus : ModuleStatus
Tags
Return values
bool

true if there is an uninstall.php script

saveUninstallerIni()

public saveUninstallerIni() : mixed
Tags
Return values
mixed

setCurrentConfiguratorStatus()

public setCurrentConfiguratorStatus(bool $forLocalConfiguration) : void
Parameters
$forLocalConfiguration : bool
Tags
Return values
void

setCurrentProcessedModule()

public setCurrentProcessedModule(mixed $name) : mixed
Parameters
$name : mixed
Tags
Return values
mixed

setReadWriteConfigMode()

public setReadWriteConfigMode(bool $rwMode) : mixed
Parameters
$rwMode : bool

indicate if the configuration can be modified or not

Tags
Return values
mixed

undeclareEntryPoint()

Undeclare an entry point.

public undeclareEntryPoint(string $epId) : mixed
Parameters
$epId : string
Tags
throws
Exception
Return values
mixed

updateInstallerContexts()

public updateInstallerContexts(mixed $moduleName, mixed $contexts) : mixed
Parameters
$moduleName : mixed
$contexts : mixed
Tags
Return values
mixed

loadInstallerIni()

protected loadInstallerIni() : IniModifier
Tags
throws
Exception
Return values
IniModifier

the modifier for the installer.ini.php file

readEntryPointData()

read the list of entrypoint from the project.xml file and read all modules data used by each entry point.

protected readEntryPointData() : mixed
Tags
throws
Exception
Return values
mixed

readModuleInfos()

protected readModuleInfos() : mixed
Tags
Return values
mixed

readUninstallerFile()

protected readUninstallerFile(string $uninstallersDir, IniModifier $uninstallerIni) : void
Parameters
$uninstallersDir : string
$uninstallerIni : IniModifier
Tags
throws
Exception
Return values
void

Search results