jInstallerEntryPoint
in package
container for entry points properties.
Object for legacy installers
Tags
Table of Contents
- $config : StdObj
- $configFile : string
- $configIni : jIniMultiFilesModifier
- combination between mainconfig.ini.php (master) and entrypoint config (overrider).
- $file : string
- $isCliScript : bool
- $liveConfigIni : IniModifier
- liveconfig.ini.php.
- $localConfigIni : MultiIniModifier
- combination between mainconfig.ini.php, localconfig.ini.php (master) and entrypoint config (overrider).
- $scriptName : string
- $type : string
- $epConfigIni : IniModifier
- entrypoint config of app/system/.
- __construct() : mixed
- Creates a jInstallerEntryPoint object from a new \Jelix\Installer\EntryPoint object.
- getConfigFile() : string
- getConfigObj() : object
- getEpConfigIni() : IniModifier
- the static entry point config alone (in app/system).
- getEpId() : string
- getModule() : ModuleStatus
- 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
- setConfiguration() : 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
Tags
$configFile
public
string
$configFile
the filename of the configuration file dedicated to the entry point
ex:
Tags
$configIni
combination between mainconfig.ini.php (master) and entrypoint config (overrider).
public
jIniMultiFilesModifier
$configIni
Tags
$file
public
string
$file
the filename of the entry point
Tags
$isCliScript
public
bool
$isCliScript
true if the script corresponding to the configuration is a script for CLI
Tags
$liveConfigIni
liveconfig.ini.php.
public
IniModifier
$liveConfigIni
Tags
$localConfigIni
combination between mainconfig.ini.php, localconfig.ini.php (master) and entrypoint config (overrider).
public
MultiIniModifier
$localConfigIni
Tags
$scriptName
public
string
$scriptName
the url path of the entry point
Tags
$type
public
string
$type
the type of entry point
Tags
$epConfigIni
entrypoint config of app/system/.
protected
IniModifier
$epConfigIni
Tags
Methods
__construct()
Creates a jInstallerEntryPoint object from a new \Jelix\Installer\EntryPoint object.
public
__construct(EntryPoint $entryPoint, GlobalSetup $globalSetup) : mixed
Parameters
- $entryPoint : EntryPoint
- $globalSetup : GlobalSetup
Tags
Return values
mixed —getConfigFile()
public
getConfigFile() : string
Tags
Return values
string —the config file name of the entry point
getConfigObj()
public
getConfigObj() : object
Tags
Return values
object —the config content of the entry point, as seen when calling jApp::config()
getEpConfigIni()
the static entry point config alone (in app/system).
public
getEpConfigIni() : IniModifier
Tags
Return values
IniModifier —getEpId()
public
getEpId() : string
Tags
Return values
string —the entry point id (name of the entrypoint without .php)
getModule()
public
getModule(mixed $moduleName) : ModuleStatus
Parameters
- $moduleName : mixed
Tags
Return values
ModuleStatus —information about a specific module used by the entry point
getModulesList()
public
getModulesList() : array<string|int, mixed>
Tags
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
Tags
Return values
jIniFileModifier —getSingleMainConfigIni()
Give only the content of mainconfig.ini.php.
public
getSingleMainConfigIni() : jIniFileModifier
Tags
Return values
jIniFileModifier —setConfigObj()
public
setConfigObj(mixed $config) : mixed
Parameters
- $config : mixed
Tags
Return values
mixed —setConfiguration()
public
setConfiguration(EntryPoint $entryPoint, GlobalSetup $globalSetup) : mixed
Parameters
- $entryPoint : EntryPoint
- $globalSetup : GlobalSetup