Cinisis Class Reference

List of all members.

Public Member Functions

 __construct ($config=NULL)
 open ($config)
 load ($file)
 parse ($config, $class=__CLASS__)

Static Public Member Functions

static yaml ($file)
static check ($config)
static base ()
static file ($config=NULL, $section= 'config')
static join_subfields ($format)
static main_field_name ($format, $key)

Public Attributes

 $db
 $implementation

Detailed Description

Cinisis main class.


Constructor & Destructor Documentation

Cinisis::__construct ( config = NULL  ) 

Constructor.

Parameters:
$config Optional parameter to set alternative config file or array with configuration.

Member Function Documentation

static Cinisis::base (  )  [static]

Get library base folder.

Returns:
Return base folder.
static Cinisis::check ( config  )  [static]

Check configuration.

Parameters:
$config Config file or array with configuration.
Returns:
Array with configuration or FALSE on error.
static Cinisis::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 Cinisis::join_subfields ( format  )  [static]

Whether to join field and subfields in a single array.

Parameters:
$format Database format.
Returns:
Boolean.
Cinisis::load ( file  ) 

Config file load.

Parameters:
$file Config file.
Returns:
Array with configuration or FALSE if error.
static Cinisis::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.
Cinisis::open ( config  ) 

Open an ISIS database.

Parameters:
$config Optional parameter to set alternative config file or array with configuration.
Cinisis::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.
static Cinisis::yaml ( file  )  [static]

Load YAML into array using backend libraries.

Parameters:
$file Config file.
Returns:
Array with configuration or FALSE if error.

Member Data Documentation

Cinisis::$db

Database resource.

Cinisis::$implementation

Database implementation.


The documentation for this class was generated from the following file:
 All Classes Functions Variables
Generated on Mon Sep 20 13:53:31 2010 for Cinisis Database Reader by  doxygen 1.6.3