Class JSONConfig - Stefanius67/Config GitHub Wiki

Full name:     \SKien\Config\JSONConfig
Parent class:    \SKien\Config\AbstractConfig

The constructor expects an valid filename/path to the JSON file.

public JSONConfig::__construct(string $strConfigFile)

Parameters:

[go to top]

Get the array specified by path.

public AbstractConfig::getArray(string $strPath, array $aDefault = []) : array

Parameters:

Return Type: array

[go to top]

Get the boolean value specified by path.

public AbstractConfig::getBool(string $strPath, bool $bDefault = false) : bool

Parameters:

Return Type: bool

[go to top]

Returns the internal array.

public AbstractConfig::getConfig() : array

Return Type: array

[go to top]

Get the date value specified by path.

public AbstractConfig::getDate(string $strPath, int $default) : int

If the config file contains an integer, it is seen as unix timestamp. If the config file contains the date as string, it is parsed with the internal date format set by setDateFormat() (default: 'Y-m-d')

Parameters:

Return Type: int

date as unix timestamp

[go to top]

Get the date and time value specified by path as unix timestamp.

public AbstractConfig::getDateTime(string $strPath, int $default) : int

If the config file contains an integer, it is seen as unix timestamp. If the config file contains the date-time as string, it is parsed with the internal date format set by setDateTimeFormat() (default: 'Y-m-d H:i')

Parameters:

Return Type: int

unix timestamp

[go to top]

Get the float value specified by path.

public AbstractConfig::getFloat(string $strPath, float $fltDefault = 0.0) : float

Parameters:

Return Type: float

[go to top]

Get the integer value specified by path.

public AbstractConfig::getInt(string $strPath, int $iDefault) : int

Parameters:

Return Type: int

[go to top]

Get the string value specified by path.

public AbstractConfig::getString(string $strPath, string $strDefault = '') : string

Parameters:

Return Type: string

[go to top]

Get the value specified by path.

public AbstractConfig::getValue(string $strPath, mixed $default = null) : mixed

The path addresses a value within the configuration, which can be nested at any depth (depending on the file format). The individual levels are specified separated by a separator (default is '.'). The separator can be changed with setPathSeparator ().

Parameters:

Return Type: mixed

See Also:

• \SKien\Config\setPathSeparator()

[go to top]

Merge this instance with values from onather config.

public AbstractConfig::mergeWith(\SKien\Config\AbstractConfig $oMerge) : void

Note that the elemenst of the config to merge with has allways higher priority than the elements of this instance.
If both config contains elements with the same key, the value of this instance will be replaced with the value of the config we merge with.
So keep allways the order in wich you merge several configs together in mind.

Parameters:

[go to top]

Set the format for date parameters.

public AbstractConfig::setDateFormat(string $strFormat) : void

See the formatting options DateTime::createFromFormat. In most cases, the same letters as for the date() can be used.

Parameters:

See Also:

• https://www.php.net/manual/en/datetime.createfromformat.php

[go to top]

Set the format for datetime parameters.

public AbstractConfig::setDateTimeFormat(string $strFormat) : void

See the formatting options DateTime::createFromFormat. In most cases, the same letters as for the date() can be used.

Parameters:

See Also:

• https://www.php.net/manual/en/datetime.createfromformat.php

[go to top]

Set the separator character.

public AbstractConfig::setPathSeparator(string $strSeparator) : void

Default the '.' is used as separator.

Parameters:

[go to top]