Class jConfigCompiler

Description

jConfigCompiler merge two ini file in a single array and store it in a temporary file

This is a static class

Located in /core/jConfigCompiler.class.php (line 20)


	
			
Variable Summary
static mixed $commonConfig
Method Summary
static void checkCoordPluginsPath ( $config)
static void checkMiscParameters ( $config)
static void findServerName ([ $ext = '.php'], [ $isCli = false])
static void getPaths ( &$urlconf, [ $pseudoScriptName = ''], [ $isCli = false], array $urlconf)
static void prepareConfig (object $config, boolean $allModuleInfo, boolean $isCli, string $pseudoScriptName)
static object an read (string $configFile, [boolean $allModuleInfo = false], [boolean $isCli = false], [string $pseudoScriptName = ''])
static object an readAndCache (string $configFile, [boolean $isCli = null], [string $pseudoScriptName = ''])
static void runConfigCompilerPlugins ( $config)
static void _loadModuleInfo (object $config, boolean $allModuleInfo)
static void _loadPluginsPathList (object $config)
Variables
static mixed $commonConfig (line 22)
  • access: protected
Methods
static checkCoordPluginsPath (line 143)
  • access: protected
static void checkCoordPluginsPath ( $config)
  • $config
static checkMiscParameters (line 128)
  • access: protected
static void checkMiscParameters ( $config)
  • $config
static findServerName (line 498)
  • access: public
static void findServerName ([ $ext = '.php'], [ $isCli = false])
  • $ext
  • $isCli
static getPaths (line 400)

calculate miscelaneous path, depending of the server configuration and other informations in the given array : script path, script name, documentRoot ..

  • access: public
static void getPaths ( &$urlconf, [ $pseudoScriptName = ''], [ $isCli = false], array $urlconf)
  • array $urlconf: urlengine configuration. scriptNameServerVariable, basePath, jelixWWWPath and jqueryPath should be present
  • &$urlconf
  • $pseudoScriptName
  • $isCli
static prepareConfig (line 118)

fill some config properties with calculated values

  • access: protected
static void prepareConfig (object $config, boolean $allModuleInfo, boolean $isCli, string $pseudoScriptName)
  • object $config: the config object
  • boolean $allModuleInfo: may be true for the installer, which needs all informations else should be false, these extra informations are not needed to run the application
  • boolean $isCli: indicate if the configuration to read is for a CLI script or no
  • string $pseudoScriptName: the name of the entry point, relative to the base path, corresponding to the readed configuration
static read (line 41)

read the given ini file, for the current entry point, or for the entrypoint given in $pseudoScriptName. Merge it with the content of defaultconfig.ini.php It also calculates some options.

If you are in a CLI script but you want to load a configuration file for a web entry point or vice-versa, you need to indicate the $pseudoScriptName parameter with the name of the entry point

  • return: object which contains configuration values
  • access: public
static object an read (string $configFile, [boolean $allModuleInfo = false], [boolean $isCli = false], [string $pseudoScriptName = ''])
  • string $configFile: the config file name
  • boolean $allModuleInfo: may be true for the installer, which needs all informations else should be false, these extra informations are not needed to run the application
  • boolean $isCli: indicate if the configuration to read is for a CLI script or no
  • string $pseudoScriptName: the name of the entry point, relative to the base path, corresponding to the readed configuration
static readAndCache (line 84)

Identical to read(), but also stores the result in a temporary file

  • return: object which contains configuration values
  • access: public
static object an readAndCache (string $configFile, [boolean $isCli = null], [string $pseudoScriptName = ''])
  • string $configFile: the config file name
  • boolean $isCli
  • string $pseudoScriptName
static runConfigCompilerPlugins (line 163)
  • access: protected
static void runConfigCompilerPlugins ( $config)
  • $config
static _loadModuleInfo (line 208)

Analyse and check the "lib:" and "app:" path.

  • access: protected
static void _loadModuleInfo (object $config, boolean $allModuleInfo)
  • object $config: the config object
  • boolean $allModuleInfo: may be true for the installer, which needs all informations else should be false, these extra informations are not needed to run the application
static _loadPluginsPathList (line 339)

Analyse plugin paths

  • access: protected
static void _loadPluginsPathList (object $config)
  • object $config: the config container

Documentation generated on Wed, 04 Jan 2017 22:52:38 +0100 by phpDocumentor 1.4.3