Jelix 1.8.9

PreInstallHelpers
in package
Uses DbProfileHelpersTrait

Tags
since
1.7

Table of Contents

$databaseHelpers  : DatabaseHelpers
$globalSetup  : GlobalSetup
global setup.
__construct()  : mixed
database()  : DatabaseHelpers
declareDbProfile()  : bool
declare a new db profile. if the content of the section is not given, it will declare an alias to the default profile.
findDbProfile()  : array<string|int, mixed>
getConfigIni()  : IniModifierArray
default config, main config combined with local config. Read only.
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.
getEntryPointsById()  : EntryPoint
getEntryPointsByType()  : array<string|int, EntryPoint>
getEntryPointsList()  : array<string|int, EntryPoint>
List of entry points of the application.
getLocalConfigIni()  : IniModifierInterface|IniReaderInterface
local config ini file alone.
getMainEntryPoint()  : EntryPoint
Main entrypoint of the application (in most of case, index.php).
getProfilesIni()  : mixed
removeDbProfile()  : mixed
remove a db profile.

Properties

Methods

declareDbProfile()

declare a new db profile. if the content of the section is not given, it will declare an alias to the default profile.

public declareDbProfile(string $name[, null|array<string|int, mixed>|string $sectionContent = null ][, bool $force = true ]) : bool
Parameters
$name : string

the name of the new section/alias

$sectionContent : null|array<string|int, mixed>|string = null

the content of the new section, or null to create an alias

$force : bool = true

true:erase the existing profile

Tags
Return values
bool

true if the ini file has been changed

findDbProfile()

public findDbProfile( $name) : array<string|int, mixed>
Parameters
$name :
Tags
Return values
array<string|int, mixed>

the first item is the profile content as an array (which may be empty if the profile does not exist), the second item is the real profile name in case $name is an alias.

getConfigIni()

default config, main config combined with local config. Read only.

public getConfigIni() : IniModifierArray
Tags
Return values
IniModifierArray

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[, IniReaderInterface $config = null ]) : null|array<string|int, mixed>
Parameters
$pluginName : string
$config : IniReaderInterface = null

the configuration file from which we should extract the plugin configuration. default is the full configuration.

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)

getEntryPointsByType()

public getEntryPointsByType([string $type = 'classic' ]) : array<string|int, EntryPoint>
Parameters
$type : string = 'classic'
Tags
Return values
array<string|int, EntryPoint>

getLocalConfigIni()

local config ini file alone.

public getLocalConfigIni() : IniModifierInterface|IniReaderInterface
Tags
Return values
IniModifierInterface|IniReaderInterface

getProfilesIni()

public getProfilesIni() : mixed
Tags
Return values
mixed

removeDbProfile()

remove a db profile.

public removeDbProfile(string $name) : mixed
Parameters
$name : string

the name of the section/alias

Tags
Return values
mixed

Search results