PreInstallHelpers
in package
Tags
Table of Contents
- $globalSetup : GlobalSetup
- global setup.
- __construct() : mixed
- getConfigIni() : IniModifierArray
- default config, main config combined with local config. Read only.
- 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() : EntryPoint
- getEntryPointsByType() : array<string|int, EntryPoint>
- getEntryPointsList() : array<string|int, EntryPoint>
- List of entry points of the application.
- getLocalConfigIni() : IniModifierInterface|IniReaderInterface
- local config ini file alone.
- getMainEntryPoint() : EntryPoint
- Main entrypoint of the application (in most of case, index.php).
- getProfilesIni() : mixed
Properties
$globalSetup
global setup.
protected
GlobalSetup
$globalSetup
Methods
__construct()
public
__construct(GlobalSetup $setup) : mixed
Parameters
- $setup : GlobalSetup
Return values
mixed —getConfigIni()
default config, main config combined with local config. Read only.
public
getConfigIni() : IniModifierArray
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) : EntryPoint
Parameters
Return values
EntryPoint —getEntryPointsByType()
public
getEntryPointsByType([string $type = 'classic' ]) : array<string|int, EntryPoint>
Parameters
- $type : string = 'classic'
Return values
array<string|int, EntryPoint> —getEntryPointsList()
List of entry points of the application.
public
getEntryPointsList() : array<string|int, EntryPoint>
Return values
array<string|int, EntryPoint> —getLocalConfigIni()
local config ini file alone.
public
getLocalConfigIni() : IniModifierInterface|IniReaderInterface
Return values
IniModifierInterface|IniReaderInterface —getMainEntryPoint()
Main entrypoint of the application (in most of case, index.php).
public
getMainEntryPoint() : EntryPoint
Return values
EntryPoint —getProfilesIni()
public
getProfilesIni() : mixed