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/classMaleteDb.html | 329 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 329 insertions(+) create mode 100644 doc/html/classMaleteDb.html (limited to 'doc/html/classMaleteDb.html') diff --git a/doc/html/classMaleteDb.html b/doc/html/classMaleteDb.html new file mode 100644 index 0000000..eed9039 --- /dev/null +++ b/doc/html/classMaleteDb.html @@ -0,0 +1,329 @@ + + + + + +Cinisis Database Reader: MaleteDb Class Reference + + + + + + + + + +
+

MaleteDb Class Reference

+Inheritance diagram for MaleteDb:
+
+
+ + +IsisDb + +
+
+ +

List of all members.

+ + + + + + + + + + + + + + +

Public Member Functions

 __construct ($schema)
 read ($id)
 entries ()
 example ()
 check ($schema, $section=NULL)
 tag ($results)
 logger ($message)

Public Attributes

 $fdt
 $db
 $format
 $log
+

Detailed Description

+

Malete implementation of IsisDb.

+
Warning:
This implementation is currently outdated and lacks basic functionalities such as subfield handling and therefore it's use is not recommended.
+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + +
MaleteDb::__construct ($  schema ) 
+
+
+

Constructor.

+
See also:
IsisDb::__construct()
+ +

Implements IsisDb.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
MaleteDb::check ($  schema,
$  section = NULL 
)
+
+
+

Check configuration.

+
See also:
IsisDb::check()
+ +

Implements IsisDb.

+ +
+
+ +
+
+ + + + + + + + +
MaleteDb::entries ( ) 
+
+
+

Return number of entries in the database.

+

The Malete API doen't implement such feature so we have to emulate it by iterating over all entries until MaleteDb::read() returns FALSE.

+
See also:
IsisDb::entries()
+ +

Implements IsisDb.

+ +
+
+ +
+
+ + + + + + + + +
MaleteDb::example ( ) 
+
+
+

Return an example schema.

+
See also:
IsisDb::example()
+ +

Implements IsisDb.

+ +
+
+ +
+
+ + + + + + + + + +
MaleteDb::logger ($  message ) 
+
+
+

Class logger.

+
Parameters:
+ + +
$message Log message.
+
+
+ +
+
+ +
+
+ + + + + + + + + +
MaleteDb::read ($  id ) 
+
+
+

Read an entry.

+
See also:
IsisDb::read()
+
Todo:
Subfield handling.
+ +

Implements IsisDb.

+ +
+
+ +
+
+ + + + + + + + + +
MaleteDb::tag ($  results ) 
+
+
+

Tag results of a db query.

+

This function converts the keys of query result from field numbers to names and and also puts repetition fields into place as Malete deals with field repetition by using a 'tag' property in the resulting query object.

+
Parameters:
+ + +
$results Database query results.
+
+
+
Returns:
Tagged database result.
+ +
+
+

Member Data Documentation

+ +
+
+ + + + +
MaleteDb::$db
+
+
+

Database resource.

+ +
+
+ +
+
+ + + + +
MaleteDb::$fdt
+
+
+

Field description table.

+ +
+
+ +
+
+ + + + +
MaleteDb::$format
+
+
+

Database format, derived from $schema.

+ +
+
+ +
+
+ + + + +
MaleteDb::$log
+
+
+

Class action log.

+ +
+
+
The documentation for this class 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