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

CinIsis Class Reference

+

List of all members.

+ + + + + + + + + +

Public Member Functions

 __construct ($config= 'config/config.yaml')
 load ($file)
 parse ($config, $type= 'cinisis')
 check ($config)

Public Attributes

 $db
 $implementation
+

Detailed Description

+

CinIsis main class.

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + +
CinIsis::__construct ($  config = 'config/config.yaml' ) 
+
+
+

Constructor.

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

Member Function Documentation

+ +
+
+ + + + + + + + + +
CinIsis::check ($  config ) 
+
+
+

Check configuration.

+
Parameters:
+ + +
$config Config file or array with configuration.
+
+
+
Returns:
Array with configuration or FALSE on error.
+ +
+
+ +
+
+ + + + + + + + + +
CinIsis::load ($  file ) 
+
+
+

Config file load.

+
Parameters:
+ + +
$file Config file.
+
+
+
Returns:
Array with configuration.
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
CinIsis::parse ($  config,
$  type = 'cinisis' 
)
+
+
+

Parse configuration.

+
Parameters:
+ + + +
$config Config file or array with configuration.
$type Configuration type (either 'cinisis' or 'schema').
+
+
+
Returns:
Array with configuration or FALSE on error.
+
Todo:
Config and system check.
+ +
+
+

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 Tue Apr 6 12:36:23 2010 for CinIsis Database Reader by  + +doxygen 1.6.1
+ + -- cgit v1.2.3