PHP Class Jelix\Installer\EntryPoint

Mostrar archivo Open project: jelix/jelix Class Usage Examples

Public Properties

Property Type Description
$file the filename of the entry point
$isCliScript true if the script corresponding to the configuration is a script for CLI
$sameConfigAs entrypoint id of the entrypoint that have the same config
$scriptName the url path of the entry point
$type the type of entry point

Protected Properties

Property Type Description
$appInfos Jelix\Core\Infos\AppInfos
$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
$configFile the filename of the configuration file dedicated to the entry point ex: /app/config/index/config.ini.php
$epConfigIni Jelix\IniFile\IniModifier entrypoint config of app/config/
$fullConfigIni Jelix\IniFile\MultiIniModifier the entry point config combined with $localConfigIni
$localConfigIni Jelix\IniFile\MultiIniModifier the localconfig.ini.php file combined with $mainConfigIni
$localEpConfigIni Jelix\IniFile\IniModifier + * entrypoint config of var/config/ + * @var \Jelix\IniFile\IniModifier +
$mainConfigIni Jelix\IniFile\MultiIniModifier the mainconfig.ini.php file combined with defaultconfig.ini.php
$moduleLaunchers AbstractInstallLauncher[] key is module name
$modulesInfos Jelix\Core\Infos\ModuleInfos[]
$urlMap Jelix\Routing\UrlMapping\XmlEntryPoint

Public Methods

Method Description
__construct ( Jelix\IniFile\MultiIniModifier $mainConfig, Jelix\IniFile\MultiIniModifier $localConfig, string $configFile, string $file, string $type )
createInstallLaunchers ( callable $launcherGetter )
getAppInfos ( ) : Jelix\Core\Infos\AppInfos
getConfigFile ( ) : string
getConfigIni ( ) : Jelix\IniFile\MultiIniModifier the entry point config (static and local) combined with $localConfigIni
getConfigObj ( ) : stdObj
getEpConfigIni ( ) * he static entry point config alone (in app/config)
getEpId ( ) : string
getLauncher ( $moduleName ) : AbstractInstallLauncher
getLaunchers ( ) : AbstractInstallLauncher[]
getLocalConfigIni ( ) : Jelix\IniFile\MultiIniModifier the localconfig.ini.php file combined with $mainConfigIni
getLocalEpConfigIni ( ) * the local entry point config alone (in var/config)
getMainConfigIni ( ) : Jelix\IniFile\MultiIniModifier the mainconfig.ini.php file combined with defaultconfig.ini.php
getModule ( $moduleName )
getModulesList ( ) : array
getUrlMap ( )
setAppInfos ( Jelix\Core\Infos\AppInfos $app )
setConfigObj ( $config )
setUrlMap ( Jelix\Routing\UrlMapping\XmlEntryPoint $urlEp )

Method Details

__construct() public method

public __construct ( Jelix\IniFile\MultiIniModifier $mainConfig, Jelix\IniFile\MultiIniModifier $localConfig, string $configFile, string $file, string $type )
$mainConfig Jelix\IniFile\MultiIniModifier the mainconfig.ini.php file combined with defaultconfig.ini.php
$localConfig Jelix\IniFile\MultiIniModifier the localconfig.ini.php file combined with $mainConfig
$configFile string the path of the configuration file, relative to the app/config directory
$file string the filename of the entry point
$type string type of the entry point ('classic', 'cli', 'xmlrpc'....)

createInstallLaunchers() public method

public createInstallLaunchers ( callable $launcherGetter )
$launcherGetter callable

getAppInfos() public method

public getAppInfos ( ) : Jelix\Core\Infos\AppInfos
return Jelix\Core\Infos\AppInfos

getConfigFile() public method

public getConfigFile ( ) : string
return string the config file name of the entry point

getConfigIni() public method

the entry point config (static and local) combined with $localConfigIni
Since: 1.7
public getConfigIni ( ) : Jelix\IniFile\MultiIniModifier
return Jelix\IniFile\MultiIniModifier

getConfigObj() public method

public getConfigObj ( ) : stdObj
return stdObj the config content of the entry point, as seen when calling App::config()

getEpConfigIni() public method

* he static entry point config alone (in app/config)
Since: 1.6.8
public getEpConfigIni ( )

getEpId() public method

public getEpId ( ) : string
return string the entry point id

getLauncher() public method

public getLauncher ( $moduleName ) : AbstractInstallLauncher
return AbstractInstallLauncher

getLaunchers() public method

public getLaunchers ( ) : AbstractInstallLauncher[]
return AbstractInstallLauncher[]

getLocalConfigIni() public method

the localconfig.ini.php file combined with $mainConfigIni
Since: 1.7
public getLocalConfigIni ( ) : Jelix\IniFile\MultiIniModifier
return Jelix\IniFile\MultiIniModifier

getLocalEpConfigIni() public method

* the local entry point config alone (in var/config)
Since: 1.7
public getLocalEpConfigIni ( )

getMainConfigIni() public method

the mainconfig.ini.php file combined with defaultconfig.ini.php
Since: 1.7
public getMainConfigIni ( ) : Jelix\IniFile\MultiIniModifier
return Jelix\IniFile\MultiIniModifier

getModule() public method

See also: getModuleStatus()
Deprecation:
public getModule ( $moduleName )

getModulesList() public method

public getModulesList ( ) : array
return array the list of modules and their path, as stored in the compiled configuration file

getUrlMap() public method

public getUrlMap ( )

setAppInfos() public method

public setAppInfos ( Jelix\Core\Infos\AppInfos $app )
$app Jelix\Core\Infos\AppInfos

setConfigObj() public method

public setConfigObj ( $config )

setUrlMap() public method

public setUrlMap ( Jelix\Routing\UrlMapping\XmlEntryPoint $urlEp )
$urlEp Jelix\Routing\UrlMapping\XmlEntryPoint

Property Details

$appInfos protected_oe property

protected AppInfos,Jelix\Core\Infos $appInfos
return Jelix\Core\Infos\AppInfos

$config protected_oe property

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
protected $config

$configFile protected_oe property

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

$epConfigIni protected_oe property

entrypoint config of app/config/
protected IniModifier,Jelix\IniFile $epConfigIni
return Jelix\IniFile\IniModifier

$file public_oe property

the filename of the entry point
public $file

$fullConfigIni protected_oe property

the entry point config combined with $localConfigIni
protected MultiIniModifier,Jelix\IniFile $fullConfigIni
return Jelix\IniFile\MultiIniModifier

$isCliScript public_oe property

true if the script corresponding to the configuration is a script for CLI
public $isCliScript

$localConfigIni protected_oe property

the localconfig.ini.php file combined with $mainConfigIni
protected MultiIniModifier,Jelix\IniFile $localConfigIni
return Jelix\IniFile\MultiIniModifier

$localEpConfigIni protected_oe property

+ * entrypoint config of var/config/ + * @var \Jelix\IniFile\IniModifier +
protected IniModifier,Jelix\IniFile $localEpConfigIni
return Jelix\IniFile\IniModifier

$mainConfigIni protected_oe property

the mainconfig.ini.php file combined with defaultconfig.ini.php
protected MultiIniModifier,Jelix\IniFile $mainConfigIni
return Jelix\IniFile\MultiIniModifier

$moduleLaunchers protected_oe property

key is module name
protected AbstractInstallLauncher[],Jelix\Installer $moduleLaunchers
return AbstractInstallLauncher[]

$modulesInfos protected_oe property

protected ModuleInfos[],Jelix\Core\Infos $modulesInfos
return Jelix\Core\Infos\ModuleInfos[]

$sameConfigAs public_oe property

entrypoint id of the entrypoint that have the same config
public $sameConfigAs

$scriptName public_oe property

the url path of the entry point
public $scriptName

$type public_oe property

the type of entry point
public $type

$urlMap protected_oe property

protected XmlEntryPoint,Jelix\Routing\UrlMapping $urlMap
return Jelix\Routing\UrlMapping\XmlEntryPoint