FrameworkInfos
in package
Table of Contents
- $defaultEntryPoint : string
- $entrypoints : array<string|int, EntryPoint>
- $iniFile : IniModifier
- $iniLocalFile : IniModifier
- $localEntrypoints : array<string|int, EntryPoint>
- __construct() : mixed
- FrameworkInfos constructor.
- addEntryPointInfo() : mixed
- addLocalEntryPointInfo() : mixed
- getDefaultEntryPointInfo() : null|EntryPoint
- getEntryPointInfo() : null|EntryPoint
- getEntryPoints() : array<string|int, EntryPoint>
- load() : FrameworkInfos
- create a new FrameworkInfos object.
- removeEntryPointInfo() : mixed
- save() : mixed
- readIniFile() : mixed
- updateFrameworkIniSection() : void
- updateIni() : mixed
Properties
$defaultEntryPoint
protected
string
$defaultEntryPoint
= ''
$entrypoints
protected
array<string|int, EntryPoint>
$entrypoints
= array()
keys are filename
$iniFile
protected
IniModifier
$iniFile
$iniLocalFile
protected
IniModifier
$iniLocalFile
$localEntrypoints
protected
array<string|int, EntryPoint>
$localEntrypoints
= array()
keys are filename
Methods
__construct()
FrameworkInfos constructor.
public
__construct(string $frameworkFile[, mixed $localFrameworkFile = '' ]) : mixed
Parameters
- $frameworkFile : string
-
the path to the localframework.ini.php file
- $localFrameworkFile : mixed = ''
Return values
mixed —addEntryPointInfo()
public
addEntryPointInfo(mixed $fileName, mixed $configFileName[, mixed $type = 'classic' ]) : mixed
Parameters
- $fileName : mixed
- $configFileName : mixed
- $type : mixed = 'classic'
Return values
mixed —addLocalEntryPointInfo()
public
addLocalEntryPointInfo(mixed $fileName, mixed $configFileName[, mixed $type = 'classic' ]) : mixed
Parameters
- $fileName : mixed
- $configFileName : mixed
- $type : mixed = 'classic'
Return values
mixed —getDefaultEntryPointInfo()
public
getDefaultEntryPointInfo() : null|EntryPoint
Return values
null|EntryPoint —getEntryPointInfo()
public
getEntryPointInfo(mixed $id) : null|EntryPoint
Parameters
- $id : mixed
Return values
null|EntryPoint —getEntryPoints()
public
getEntryPoints() : array<string|int, EntryPoint>
Return values
array<string|int, EntryPoint> —load()
create a new FrameworkInfos object.
public
static load() : FrameworkInfos
Return values
FrameworkInfos —removeEntryPointInfo()
public
removeEntryPointInfo(mixed $fileName) : mixed
Parameters
- $fileName : mixed
Return values
mixed —save()
public
save() : mixed
Return values
mixed —readIniFile()
protected
readIniFile(IniModifier $iniFile[, mixed $isLocal = false ]) : mixed
Parameters
- $iniFile : IniModifier
- $isLocal : mixed = false
Return values
mixed —updateFrameworkIniSection()
protected
updateFrameworkIniSection(IniModifier $ini, EntryPoint $ep) : void
Parameters
- $ini : IniModifier
- $ep : EntryPoint
Return values
void —updateIni()
protected
updateIni() : mixed