Interface ConfigInterface - Stefanius67/Config GitHub Wiki
Full name: \SKien\Config\ConfigInterface
Interface for config components.
Overview
| Method | Description |
|---|---|
| getArray | Get the array specified by path. |
| getBool | Get the boolean value specified by path. |
| getDate | Get the date value specified by path as unix timestamp. |
| getDateTime | Get the date and time value specified by path as unix timestamp. |
| getFloat | Get the integer value specified by path. |
| getInt | Get the integer value specified by path. |
| getString | Get the string value specified by path. |
| getValue | Get the value specified by path. |
Methods
getArray
Get the array specified by path.
public ConfigInterface::getArray(string $strPath, array $aDefault = []) : array
Parameters:
| Parameter | Type | Description |
|---|---|---|
strPath |
string | |
aDefault |
array |
Return Type: array
go to top(#configinterface)
getBool
Get the boolean value specified by path.
public ConfigInterface::getBool(string $strPath, bool $bDefault = false) : bool
Parameters:
| Parameter | Type | Description |
|---|---|---|
strPath |
string | |
bDefault |
bool |
Return Type: bool
go to top(#configinterface)
getDate
Get the date value specified by path as unix timestamp.
public ConfigInterface::getDate(string $strPath, int $default) : int
Parameters:
| Parameter | Type | Description |
|---|---|---|
strPath |
string | |
default |
int | default value (unix timestamp) |
Return Type: int
unix timestamp
go to top(#configinterface)
getDateTime
Get the date and time value specified by path as unix timestamp.
public ConfigInterface::getDateTime(string $strPath, int $default) : int
Parameters:
| Parameter | Type | Description |
|---|---|---|
strPath |
string | |
default |
int | default value (unix timestamp) |
Return Type: int
unix timestamp
go to top(#configinterface)
getFloat
Get the integer value specified by path.
public ConfigInterface::getFloat(string $strPath, float $fltDefault = 0.0) : float
Parameters:
| Parameter | Type | Description |
|---|---|---|
strPath |
string | |
fltDefault |
float |
Return Type: float
go to top(#configinterface)
getInt
Get the integer value specified by path.
public ConfigInterface::getInt(string $strPath, int $iDefault) : int
Parameters:
| Parameter | Type | Description |
|---|---|---|
strPath |
string | |
iDefault |
int |
Return Type: int
go to top(#configinterface)
getString
Get the string value specified by path.
public ConfigInterface::getString(string $strPath, string $strDefault = '') : string
Parameters:
| Parameter | Type | Description |
|---|---|---|
strPath |
string | |
strDefault |
string |
Return Type: string
go to top(#configinterface)
getValue
Get the value specified by path.
public ConfigInterface::getValue(string $strPath, mixed $default = null) : mixed
Parameters:
| Parameter | Type | Description |
|---|---|---|
strPath |
string | |
default |
mixed |
Return Type: mixed
go to top(#configinterface)