From b879f0fcc8651b49ae46a6db64d7eb1a27c7af1a Mon Sep 17 00:00:00 2001 From: Silvio Date: Fri, 20 Aug 2010 15:39:56 -0300 Subject: Adding generated docs --- doc/html/interfaceIsisDb.html | 234 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 234 insertions(+) create mode 100644 doc/html/interfaceIsisDb.html (limited to 'doc/html/interfaceIsisDb.html') diff --git a/doc/html/interfaceIsisDb.html b/doc/html/interfaceIsisDb.html new file mode 100644 index 0000000..7317e9e --- /dev/null +++ b/doc/html/interfaceIsisDb.html @@ -0,0 +1,234 @@ + + + + + +Cinisis Database Reader: IsisDb Interface Reference + + + + + + + + + +
+

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
+ + -- cgit v1.2.3