YANA 4 PHP FrameworkDocs for page config.php
/includes/config.php
Description
Handling of Config- and SML-Files
Functions
Read variables from an encoded string
array
decodeConfigString
(
string $input, [int $mode = CASE_UPPER]
)
List of parameters:
| Name | Type | Description |
|---|---|---|
| $input | string | |
| $mode | int |
Description:
This function has been superceeded by the OO-style implementation SML::decode() and since version 2.8.5 has been marked deprecated.
Read a config file and return its contents
array
getConfigFile
(
array|string $input, [int $mode = CASE_UPPER]
)
List of parameters:
| Name | Type | Description |
|---|---|---|
| $input | array|string | |
| $mode | int |
Description:
This function has been superceeded by the OO-style implementation SML::getFile() and since version 2.8.5 has been marked deprecated.
Read a config file and copy its contents to the global scope
bool
importConfigFile
(
string $filename, [int $mode = CASE_UPPER]
)
List of parameters:
| Name | Type | Description |
|---|---|---|
| $filename | string | |
| $mode | int |
Description:
The argument $mode can be used to decide how keys should be treated.
Valid values for $mode are:
- CASE_UPPER upper-case all keys
- CASE_LOWER lower-case all keys
- CASE_MIXED leave keys in mixed case
Returns bool(true) on success and bool(false) on error.
Create a config file from scalar variable or array data.
void
makeConfig
(
scalar|array $data, [string $name = null], [int $mode = CASE_UPPER]
)
List of parameters:
| Name | Type | Description |
|---|---|---|
| $data | scalar|array | |
| $name | string | |
| $mode | int |
Description:
This function has been superceeded by the OO-style implementation SML::encode() and since version 2.8.5 has been marked deprecated.
Documentation generated on Sun, 11 Mar 2007 15:02:51 +0100 by phpDocumentor 1.3.1
www.yanaframework.net