PHP Класс Jelix\Installer\EntryPoint

Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство	Тип	Описание
$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)

Свойство	Тип	Описание
$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

Открытые методы

Метод	Описание
__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 )

Описание методов

__construct() публичный Метод

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 createInstallLaunchers ( callable $launcherGetter )
$launcherGetter	callable

getAppInfos() публичный Метод

public getAppInfos ( ) : Jelix\Core\Infos\AppInfos
Результат	Jelix\Core\Infos\AppInfos

getConfigFile() публичный Метод

public getConfigFile ( ) : string
Результат	string	the config file name of the entry point

getConfigIni() публичный Метод

the entry point config (static and local) combined with $localConfigIni

С версии: 1.7

public getConfigIni ( ) : Jelix\IniFile\MultiIniModifier
Результат	Jelix\IniFile\MultiIniModifier

getConfigObj() публичный Метод

public getConfigObj ( ) : stdObj
Результат	stdObj	the config content of the entry point, as seen when calling App::config()

getEpConfigIni() публичный Метод

* he static entry point config alone (in app/config)

С версии: 1.6.8

public getEpConfigIni ( )

getEpId() публичный Метод

public getEpId ( ) : string
Результат	string	the entry point id

getLauncher() публичный Метод

public getLauncher ( $moduleName ) : AbstractInstallLauncher
Результат	AbstractInstallLauncher

getLaunchers() публичный Метод

public getLaunchers ( ) : AbstractInstallLauncher[]
Результат	AbstractInstallLauncher[]

getLocalConfigIni() публичный Метод

the localconfig.ini.php file combined with $mainConfigIni

С версии: 1.7

public getLocalConfigIni ( ) : Jelix\IniFile\MultiIniModifier
Результат	Jelix\IniFile\MultiIniModifier

getLocalEpConfigIni() публичный Метод

* the local entry point config alone (in var/config)

С версии: 1.7

public getLocalEpConfigIni ( )

getMainConfigIni() публичный Метод

the mainconfig.ini.php file combined with defaultconfig.ini.php

С версии: 1.7

public getMainConfigIni ( ) : Jelix\IniFile\MultiIniModifier
Результат	Jelix\IniFile\MultiIniModifier

getModule() публичный Метод

См. также: getModuleStatus()

Устаревший:

public getModule ( $moduleName )

getModulesList() публичный Метод

public getModulesList ( ) : array
Результат	array	the list of modules and their path, as stored in the compiled configuration file

getUrlMap() публичный Метод

public getUrlMap ( )

setAppInfos() публичный Метод

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

setConfigObj() публичный Метод

public setConfigObj ( $config )

setUrlMap() публичный Метод

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

Описание свойств

$appInfos защищенное свойство

protected AppInfos,Jelix\Core\Infos $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

protected $config

$configFile защищенное свойство

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

protected $configFile

$epConfigIni защищенное свойство

entrypoint config of app/config/

protected IniModifier,Jelix\IniFile $epConfigIni
Результат	Jelix\IniFile\IniModifier

$file публичное свойство

the filename of the entry point

public $file

$fullConfigIni защищенное свойство

the entry point config combined with $localConfigIni

protected MultiIniModifier,Jelix\IniFile $fullConfigIni
Результат	Jelix\IniFile\MultiIniModifier

$isCliScript публичное свойство

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

public $isCliScript

$localConfigIni защищенное свойство

the localconfig.ini.php file combined with $mainConfigIni

protected MultiIniModifier,Jelix\IniFile $localConfigIni
Результат	Jelix\IniFile\MultiIniModifier

$localEpConfigIni защищенное свойство

+ * entrypoint config of var/config/ + * @var \Jelix\IniFile\IniModifier +

protected IniModifier,Jelix\IniFile $localEpConfigIni
Результат	Jelix\IniFile\IniModifier

$mainConfigIni защищенное свойство

the mainconfig.ini.php file combined with defaultconfig.ini.php

protected MultiIniModifier,Jelix\IniFile $mainConfigIni
Результат	Jelix\IniFile\MultiIniModifier

$moduleLaunchers защищенное свойство

key is module name

protected AbstractInstallLauncher[],Jelix\Installer $moduleLaunchers
Результат	AbstractInstallLauncher[]

$modulesInfos защищенное свойство

protected ModuleInfos[],Jelix\Core\Infos $modulesInfos
Результат	Jelix\Core\Infos\ModuleInfos[]

$sameConfigAs публичное свойство

entrypoint id of the entrypoint that have the same config

public $sameConfigAs

$scriptName публичное свойство

the url path of the entry point

public $scriptName

$type публичное свойство

the type of entry point

public $type

$urlMap защищенное свойство

protected XmlEntryPoint,Jelix\Routing\UrlMapping $urlMap
Результат	Jelix\Routing\UrlMapping\XmlEntryPoint