CinisisDb Class Reference
List of all members.
Detailed Description
CinisisDb main class.
Constructor & Destructor Documentation
CinisisDb::__construct |
( |
$ |
config = NULL |
) |
|
Constructor.
- Parameters:
-
| $config | Optional parameter to set alternative config file or array with configuration. |
Member Function Documentation
static CinisisDb::base |
( |
|
) |
[static] |
Get library base folder.
- Returns:
- Return base folder.
static CinisisDb::check |
( |
$ |
config |
) |
[static] |
Check configuration.
- Parameters:
-
| $config | Config file or array with configuration. |
- Returns:
- Array with configuration or FALSE on error.
static CinisisDb::file |
( |
$ |
config = NULL , |
|
|
$ |
section = 'config' | |
|
) |
| | [static] |
Get a file path.
- Parameters:
-
| $config | Config file name (either relative to the library or absolute) or array with configuration. |
| $section | Config file section (ignored for absolute files). |
- Returns:
- Return the assembled file path.
static CinisisDb::join_subfields |
( |
$ |
format |
) |
[static] |
Whether to join field and subfields in a single array.
- Parameters:
-
- Returns:
- Boolean.
CinisisDb::load |
( |
$ |
file |
) |
|
Config file load.
- Parameters:
-
- Returns:
- Array with configuration or FALSE if error.
static CinisisDb::main_field_name |
( |
$ |
format, |
|
|
$ |
key | |
|
) |
| | [static] |
Determine the main field name depending on db configuration.
- Parameters:
-
| $key | Field key. |
| $format | Database format. |
- Returns:
- Main field name, 'field' by default.
CinisisDb::open |
( |
$ |
config |
) |
|
Open an ISIS database.
- Parameters:
-
| $config | Optional parameter to set alternative config file or array with configuration. |
CinisisDb::parse |
( |
$ |
config, |
|
|
$ |
class = __CLASS__ | |
|
) |
| | |
Parse configuration.
- Parameters:
-
| $config | Config file or array with configuration. |
| $class | Configuration class name. |
- Returns:
- Array with configuration or FALSE on error.
Member Data Documentation
CinisisDb::$implementation |
The documentation for this class was generated from the following file: