IsisDb Interface Reference

Inheritance diagram for IsisDb:
BiblioIsisDb MaleteDb PhpIsisDb

List of all members.

Public Member Functions

 __construct ($schema)
 read ($id)
 entries ()
 example ()

Static Public Member Functions

static check ($schema, $section=NULL)

Detailed Description

Generic interface for reading Isis databases.


Constructor & Destructor Documentation

IsisDb::__construct ( schema  ) 

Constructor.

The implementation constructor should accept a database schema definition and setup the appropriate db resource.

Parameters:
$schema High level database schema description.
Returns:
Database resource or FALSE in case of error.
See also:
default_schema()

Implemented in BiblioIsisDb, MaleteDb, and PhpIsisDb.


Member Function Documentation

static IsisDb::check ( schema,
section = NULL 
) [static]

Configuration check.

Parameters:
$schema Database schema to check.
$section Configuration section.
Returns:
Database schema or FALSE if error.

Implemented in BiblioIsisDb, MaleteDb, and PhpIsisDb.

IsisDb::entries (  ) 

Return number of entries in the database.

Returns:
Number of entries in the database.

Implemented in BiblioIsisDb, MaleteDb, and PhpIsisDb.

IsisDb::example (  ) 

Return an example database schema.

The example schema should have all information the implementation needs to be able to open and read a database.

Returns:
Array with a sample database schema.

Implemented in BiblioIsisDb, MaleteDb, and PhpIsisDb.

IsisDb::read ( id  ) 

Read an entry from the database.

Parameters:
$id Database entry id.

Implemented in MaleteDb, and PhpIsisDb.


The documentation for this interface was generated from the following file:
 All Classes Functions Variables
Generated on Fri Aug 20 15:38:20 2010 for Cinisis Database Reader by  doxygen 1.6.3