Jelix 1.8.8

EntryPoint
in package

container for entry points properties, for installers.

Tags
since
1.7

Table of Contents

$legacyInstallerEntryPoint  : jInstallerEntryPoint
$_isCliScript  : bool
$appEpConfigIni  : mixed
application entry point configuration.
$config  : StdClass
$configFileName  : string
$file  : string
$globalSetup  : GlobalSetup
$isLocalEp  : bool
$localEpConfigIni  : IniModifier
local entry point configuration.
$scriptName  : string
$type  : string
__construct()  : mixed
getConfigFileName()  : string
getConfigIni()  : IniModifierArray
Return a reader/modifier of the list of file ini, depending of the context.
getConfigObj()  : StdClass
getCoordPluginConfig()  : null|array<string|int, mixed>
return the section name of configuration of a plugin for the coordinator or the IniModifier for the configuration file of the plugin if it exists.
getEpId()  : string
getFileName()  : string
getModulesList()  : array<string|int, string>
getScriptName()  : string
getSingleConfigIni()  : IniModifier|IniModifierReadOnly
getType()  : string
isCliScript()  : bool
setConfigObj()  : mixed

Properties

$_isCliScript

protected bool $_isCliScript

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

Tags

$appEpConfigIni

application entry point configuration.

protected mixed $appEpConfigIni
  • @var \Jelix\IniFile\IniModifier
Tags

$config

protected StdClass $config

configuration parameters. compiled content of config files result of the merge of entry point config, localconfig.ini.php, mainconfig.ini.php and defaultconfig.ini.php

Tags

$configFileName

protected string $configFileName

the filename of the configuration file dedicated to the entry point ex: /app/system/index/config.ini.php

Tags

$file

protected string $file

the filename of the entry point

Tags

$isLocalEp

protected bool $isLocalEp = false

true if the entrypoint is a local entrypoint

Tags

$localEpConfigIni

local entry point configuration.

protected IniModifier $localEpConfigIni
Tags

$scriptName

protected string $scriptName

the url path of the entry point

Tags

$type

protected string $type

the type of entry point

Tags

Methods

__construct()

public __construct(GlobalSetup $globalSetup, string $configFile, string $file, string $type, mixed $isLocalEp) : mixed
Parameters
$globalSetup : GlobalSetup
$configFile : string

the path of the configuration file, relative to the app/system directory

$file : string

the filename of the entry point

$type : string

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

$isLocalEp : mixed
Tags
Return values
mixed

getConfigFileName()

public getConfigFileName() : string
Tags
Return values
string

the config file name of the entry point

getConfigIni()

Return a reader/modifier of the list of file ini, depending of the context.

public getConfigIni() : IniModifierArray

In the context of dev, the list is:

  • 'default': defaultconfig.ini
  • 'main': mainconfig.ini
  • 'entrypoint' : app/system//config.ini

In the context of local configuration, the list is

  • 'default': defaultconfig.ini
  • 'main': mainconfig.ini
  • 'entrypoint': app/system//config.ini
  • 'local': localconfig.ini
  • 'localentrypoint': var/config//config.ini
Tags
Return values
IniModifierArray

list of ini content of the configuration

getConfigObj()

public getConfigObj() : StdClass
Tags
Return values
StdClass

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

getCoordPluginConfig()

return the section name of configuration of a plugin for the coordinator or the IniModifier for the configuration file of the plugin if it exists.

public getCoordPluginConfig(string $pluginName) : null|array<string|int, mixed>
Parameters
$pluginName : string
Tags
throws
Exception

when the configuration filename is not found

Return values
null|array<string|int, mixed>

null if plugin is unknown, else array($iniModifier, $section)

getEpId()

public getEpId() : string
Tags
Return values
string

the entry point id

getFileName()

public getFileName() : string
Tags
Return values
string

the filename of the entry point

getModulesList()

public getModulesList() : array<string|int, string>
Tags
Return values
array<string|int, string>

the list of all available modules (installed or not) and their path, as stored in the compiled configuration file

getScriptName()

public getScriptName() : string
Tags
Return values
string

the url path of the entry point

getSingleConfigIni()

public getSingleConfigIni() : IniModifier|IniModifierReadOnly
Tags
Return values
IniModifier|IniModifierReadOnly

ini content of the main configuration of the entry point, or its local configuration

getType()

public getType() : string
Tags
Return values
string

the type of entry point

isCliScript()

public isCliScript() : bool
Tags
Return values
bool

setConfigObj()

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

Search results