PreConfigurationHelpers

since 1.7
package

Default

Methods

__construct

__construct(\Jelix\Installer\GlobalSetup $setup) 

Arguments

Path to the configuration directory.

configFilePath(string $file = '') : string

It gives the path to app/system or local/config, depending if the configuration is for the application or for the instance

Arguments

$file

string

Response

string

the path

forLocalConfiguration

forLocalConfiguration() 

default config, main config combined with or without local config.

getConfigIni() : \Jelix\IniFile\IniModifierArray

Response

\Jelix\IniFile\IniModifierArray

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.

getCoordPluginConfig(string $pluginName, \Jelix\IniFile\IniReaderInterface $config = null) : null|array
Throws
\Exception

when the configuration filename is not found

Arguments

$pluginName

string

$config

\Jelix\IniFile\IniReaderInterface

the configuration file from which we should extract the plugin configuration. default is the full configuration.

Response

null|array

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

getEntryPointsById

getEntryPointsById( $epId) : \Jelix\Installer\EntryPointPreConfigurator

getEntryPointsByType

getEntryPointsByType(string $type = 'classic') : array<mixed,\Jelix\Installer\EntryPointPreConfigurator>

Arguments

$type

string

Response

array<mixed,\Jelix\Installer\EntryPointPreConfigurator>

List of entry points of the application.

getEntryPointsList() : array<mixed,\Jelix\Installer\EntryPointPreConfigurator>

Main entrypoint of the application (in most of case, index.php).

getMainEntryPoint() : \Jelix\Installer\EntryPointPreConfigurator

getProfilesIni

getProfilesIni() 

main config or local config ini file alone.

getSingleConfigIni() : \Jelix\IniFile\IniModifierInterface|\Jelix\IniFile\IniReaderInterface

Response

\Jelix\IniFile\IniModifierInterface|\Jelix\IniFile\IniReaderInterface

Properties

global setup.

globalSetup : \Jelix\Installer\GlobalSetup