jInstallerEntryPoint
in package
container for entry points properties
Table of Contents
- $config : StdObj
- $configFile : string
- $configIni : jIniMultiFilesModifier
- combination between mainconfig.ini.php (master) and entrypoint config (overrider)
- $file : string
- $isCliScript : bool
- $liveConfigIni : jIniFileModifier
- liveconfig.ini.php
- $localConfigIni : jIniMultiFilesModifier
- combination between mainconfig.ini.php, localconfig.ini.php (master) and entrypoint config (overrider)
- $scriptName : string
- $type : string
- $epConfigIni : jIniFileModifier
- entrypoint config
- __construct() : mixed
- getConfigFile() : string
- getConfigObj() : object
- getEpConfigIni() : jIniFileModifier
- the entry point config
- getEpId() : string
- getModule() : jInstallerModuleInfos
- getModulesList() : array<string|int, mixed>
- getSingleLocalConfigIni() : jIniFileModifier
- Give only the content of localconfig.ini.php
- getSingleMainConfigIni() : jIniFileModifier
- Give only the content of mainconfig.ini.php
- setConfigObj() : mixed
Properties
$config
public
StdObj
$config
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
$configFile
public
string
$configFile
the filename of the configuration file dedicated to the entry point
ex:
$configIni
combination between mainconfig.ini.php (master) and entrypoint config (overrider)
public
jIniMultiFilesModifier
$configIni
@deprecated as public property
$file
public
string
$file
the filename of the entry point
$isCliScript
public
bool
$isCliScript
true if the script corresponding to the configuration is a script for CLI
$liveConfigIni
liveconfig.ini.php
public
jIniFileModifier
$liveConfigIni
Tags
$localConfigIni
combination between mainconfig.ini.php, localconfig.ini.php (master) and entrypoint config (overrider)
public
jIniMultiFilesModifier
$localConfigIni
Tags
$scriptName
public
string
$scriptName
the url path of the entry point
$type
public
string
$type
the type of entry point
$epConfigIni
entrypoint config
protected
jIniFileModifier
$epConfigIni
Methods
__construct()
public
__construct(jIniFileModifier $mainConfig, string $configFile, string $file, string $type) : mixed
Parameters
- $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'....)
Return values
mixed —getConfigFile()
public
getConfigFile() : string
Return values
string —the config file name of the entry point
getConfigObj()
public
getConfigObj() : object
Return values
object —the config content of the entry point, as seen when calling jApp::config()
getEpConfigIni()
the entry point config
public
getEpConfigIni() : jIniFileModifier
Tags
Return values
jIniFileModifier —getEpId()
public
getEpId() : string
Return values
string —the entry point id (name of the entrypoint without .php)
getModule()
public
getModule(mixed $moduleName) : jInstallerModuleInfos
Parameters
- $moduleName : mixed
Return values
jInstallerModuleInfos —information about a specific module used by the entry point
getModulesList()
public
getModulesList() : array<string|int, mixed>
Return values
array<string|int, mixed> —the list of modules and their path, as stored in the compiled configuration file
getSingleLocalConfigIni()
Give only the content of localconfig.ini.php
public
getSingleLocalConfigIni() : jIniFileModifier
Return values
jIniFileModifier —getSingleMainConfigIni()
Give only the content of mainconfig.ini.php
public
getSingleMainConfigIni() : jIniFileModifier
Return values
jIniFileModifier —setConfigObj()
public
setConfigObj(mixed $config) : mixed
Parameters
- $config : mixed