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

IsisReader Class Reference

+Inheritance diagram for IsisReader:
+
+
+ + +IsisMap +IsisConnector +IsisFinder +IsisAudit + +
+
+ +

List of all members.

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

Public Member Functions

 __construct ($config=null)
 open ($config)
 read ($entry)
 removeBrackets ($value)
 removeBracketsFromArray (&$values)
 explodeBrackets ($subject)
 filterBrackets ($values)
 hasBrackets ($value)
 explodeValue ($value)
 joinSubfields ()
+

Detailed Description

+

Provides basic Isis read capabilities around Cinisis.

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + +
IsisReader::__construct ($  config = null ) 
+
+
+

Constructor.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + + + + + +
IsisReader::explodeBrackets ($  subject ) 
+
+
+

Explode a bracketed string into values. Just strings inside brackets are returned.

+
Parameters:
+ + +
$subject Strings containing brackets.
+
+
+
Returns:
Array of matched strings.
+ +
+
+ +
+
+ + + + + + + + + +
IsisReader::explodeValue ($  value ) 
+
+
+

Explode values from fields or subfields. Split values inside brackets if needed, but then doesn't return any value outside brackets.

+
Parameters:
+ + +
$value String with values.
+
+
+
Returns:
Array with values.
+ +
+
+ +
+
+ + + + + + + + + +
IsisReader::filterBrackets ($  values ) 
+
+
+

Filter out brackets from strings.

+
Parameters:
+ + +
$values String (or array filled with strings) to be filtered.
+
+
+
Returns:
Filtered string or array.
+ +
+
+ +
+
+ + + + + + + + + +
IsisReader::hasBrackets ($  value ) 
+
+
+

Check if a string has brackets.

+
Parameters:
+ + +
$value String to be compared.
+
+
+
Returns:
True if string has brackets, false otherwise.
+ +
+
+ +
+
+ + + + + + + + +
IsisReader::joinSubfields ( ) 
+
+
+

Whether to join field and subfields in a single array.

+
Returns:
Boolean.
+ +
+
+ +
+
+ + + + + + + + + +
IsisReader::open ($  config ) 
+
+
+

Open a database.

+
Parameters:
+ + +
$config Config file or array.
+
+
+ +
+
+ +
+
+ + + + + + + + + +
IsisReader::read ($  entry ) 
+
+
+

Alias to $isis->db->read().

+
Parameters:
+ + +
$entry Row number.
+
+
+
Returns:
Resulting data.
+ +
+
+ +
+
+ + + + + + + + + +
IsisReader::removeBrackets ($  value ) 
+
+
+

Remove brackets from strings whithin an array.

+
Parameters:
+ + +
$value Array with bracketed strings.
+
+
+ +
+
+ +
+
+ + + + + + + + + +
IsisReader::removeBracketsFromArray (&$  values ) 
+
+
+

Remove brackets from strings whithin an array.

+
Parameters:
+ + +
&$values Array with bracketed strings.
+
+
+ +
+
+
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