Jelix 1.8.11-rc.1

jInstallerEntryPoint
in package

container for entry points properties.

Object for legacy installers

Tags
deprecated

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: /app/system/index/config.ini.php

Tags

$isCliScript

public bool $isCliScript

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

Tags

$localConfigIni

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

public MultiIniModifier $localConfigIni
Tags
deprecated

as public property

Methods

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
since
1.6.8
Return values
IniModifier

getEpId()

public getEpId() : string
Tags
Return values
string

the entry point id (name of the entrypoint without .php)

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

setConfigObj()

public setConfigObj(mixed $config) : mixed
Parameters
$config : mixed
Tags
Return values
mixed

Search results