Jelix 1.6
Back to top  

jInstallerEntryPoint

container for entry points properties

package

jelix

Methods

__construct

__construct(\jIniFileModifier $mainConfig, string $configFile, string $file, string $type)

Arguments

$mainConfig

\jIniFileModifier

the mainconfig.ini.php file

$configFile

string

the path of the configuration file, relative to the var/config directory

$file

string

the filename of the entry point

$type

string

type of the entry point ('classic', 'cli', 'xmlrpc'....)

getConfigFile

getConfigFile() : string

Response

string

the config file name of the entry point

getConfigObj

getConfigObj() : \stdObj

Response

\stdObj

the config content of the entry point, as seen when calling jApp::config()

the entry point config

getEpConfigIni() : \jIniFilesModifier
since 1.6.8

Response

\jIniFilesModifier

getEpId

getEpId() : string

Response

string

the entry point id

getModule

getModule( $moduleName) : \jInstallerModuleInfos

Arguments

$moduleName

Response

\jInstallerModuleInfos

informations about a specific module used by the entry point

getModulesList

getModulesList() : array

Response

array

the list of modules and their path, as stored in the compiled configuration file

setConfigObj

setConfigObj( $config)

Arguments

$config

Properties

configuration parameters. compiled content of config files result of the merge of entry point config, liveconfig.ini.php, localconfig.ini.php, mainconfig.ini.php and defaultconfig.ini.php @deprecated as public property

config : \StdObj
var

configuration parameters. compiled content of config files result of the merge of entry point config, liveconfig.ini.php, localconfig.ini.php, mainconfig.ini.php and defaultconfig.ini.php @deprecated as public property

Type(s)

\StdObj

the filename of the configuration file dedicated to the entry point ex: <apppath>/var/config/index/config.ini.php @deprecated as public property

configFile : string
var

the filename of the configuration file dedicated to the entry point ex: /var/config/index/config.ini.php @deprecated as public property

Type(s)

string

combination between mainconfig.ini.php (master) and entrypoint config (overrider)

configIni : \jIniMultiFilesModifier
var

@deprecated as public property

Type(s)

\jIniMultiFilesModifier

combination between mainconfig.ini.php, localconfig.ini.php (master) and entrypoint config (overrider)

localConfigIni : \jIniMultiFilesModifier
var
deprecated

as public property

Type(s)

\jIniMultiFilesModifier

liveconfig.ini.php

liveConfigIni : \jIniFileModifier
var
deprecated

as public property

Type(s)

\jIniFileModifier

entrypoint config

epConfigIni : \jIniFileModifier
var

Type(s)

\jIniFileModifier

true if the script corresponding to the configuration is a script for CLI

isCliScript : boolean
var

true if the script corresponding to the configuration is a script for CLI

Type(s)

boolean

the url path of the entry point

scriptName : string
var

the url path of the entry point

Type(s)

string

the filename of the entry point

file : string
var

the filename of the entry point

Type(s)

string

the type of entry point

type : string
var

the type of entry point

Type(s)

string