PreConfigurationHelpers
in package
Tags
Table of Contents
- $globalSetup : GlobalSetup
- global setup.
- __construct() : mixed
- configFilePath() : string
- Path to the configuration directory.
- forLocalConfiguration() : mixed
- getConfigIni() : IniModifierArray
- default config, main config combined with or without local config.
- getCoordPluginConfig() : 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.
- getEntryPointsById() : EntryPointPreConfigurator
- getEntryPointsByType() : array<string|int, EntryPointPreConfigurator>
- getEntryPointsList() : array<string|int, EntryPointPreConfigurator>
- List of entry points of the application.
- getMainEntryPoint() : EntryPointPreConfigurator
- Main entrypoint of the application (in most of case, index.php).
- getProfilesIni() : mixed
- getSingleConfigIni() : IniModifierInterface|IniReaderInterface
- main config or local config ini file alone.
Properties
$globalSetup
global setup.
protected
GlobalSetup
$globalSetup
Tags
Methods
__construct()
public
__construct(GlobalSetup $setup) : mixed
Parameters
- $setup : GlobalSetup
Tags
Return values
mixed —configFilePath()
Path to the configuration directory.
public
configFilePath([string $file = '' ]) : string
It gives the path to app/system or local/config, depending on if the configuration is for the application or for the instance
Parameters
- $file : string = ''
Tags
Return values
string —the path
forLocalConfiguration()
public
forLocalConfiguration() : mixed
Tags
Return values
mixed —getConfigIni()
default config, main config combined with or without local config.
public
getConfigIni() : IniModifierArray
Tags
Return values
IniModifierArray —getCoordPluginConfig()
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
getCoordPluginConfig(string $pluginName[, IniReaderInterface $config = null ]) : null|array<string|int, mixed>
Parameters
- $pluginName : string
- $config : IniReaderInterface = null
-
the configuration file from which we should extract the plugin configuration. default is the full configuration.
Tags
Return values
null|array<string|int, mixed> —null if plugin is unknown, else array($iniModifier, $section)
getEntryPointsById()
public
getEntryPointsById( $epId) : EntryPointPreConfigurator
Parameters
Tags
Return values
EntryPointPreConfigurator —getEntryPointsByType()
public
getEntryPointsByType([string $type = 'classic' ]) : array<string|int, EntryPointPreConfigurator>
Parameters
- $type : string = 'classic'
Tags
Return values
array<string|int, EntryPointPreConfigurator> —getEntryPointsList()
List of entry points of the application.
public
getEntryPointsList() : array<string|int, EntryPointPreConfigurator>
Tags
Return values
array<string|int, EntryPointPreConfigurator> —getMainEntryPoint()
Main entrypoint of the application (in most of case, index.php).
public
getMainEntryPoint() : EntryPointPreConfigurator
Tags
Return values
EntryPointPreConfigurator —getProfilesIni()
public
getProfilesIni() : mixed
Tags
Return values
mixed —getSingleConfigIni()
main config or local config ini file alone.
public
getSingleConfigIni() : IniModifierInterface|IniReaderInterface