From 6857a6f1a08242ac3531f5e77c192b3c5a599ff3 Mon Sep 17 00:00:00 2001 From: Silvio Date: Thu, 16 Sep 2010 11:13:14 -0300 Subject: Minor fix and doc update --- doc/html/classIsisMap.html | 114 ++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 108 insertions(+), 6 deletions(-) (limited to 'doc/html/classIsisMap.html') diff --git a/doc/html/classIsisMap.html b/doc/html/classIsisMap.html index c0459bc..a71e5f5 100644 --- a/doc/html/classIsisMap.html +++ b/doc/html/classIsisMap.html @@ -71,10 +71,13 @@ Inheritance diagram for IsisMap:  getItemKey ($field, $item)  getFieldKey ($field)  getFieldArray ($field_key) - getSubfieldName ($field_key, $subfield_key) + getSubfieldName ($field, $subfield_key, $by_key=FALSE)  getSubfieldNames ($field_key)  getFieldName ($field_key)  getFieldNames () + getFullMap ($field) + getAttributes ($field, $subfield=null) + getDeniedCombinations ($field)

Static Public Member Functions

static methodName ($type) static normalizeFieldName ($name) @@ -107,6 +110,72 @@ Inheritance diagram for IsisMap:
Returns:
TRUE if field has a map, FALSE otherwise.
+ + + +
+
+ + + + + + + + + + + + + + + + + + +
IsisMap::getAttributes ($  field,
$  subfield = null 
)
+
+
+

Get attributes based on field and subfield.

+
Parameters:
+ + + +
$field Field data from ISIS database schema.
$subfield Subfield name.
+
+
+
Returns:
Attributes.
+ +
+
+ +
+
+ + + + + + + + + +
IsisMap::getDeniedCombinations ($  field ) 
+
+
+

Defines the denied field combinations.

+
Parameters:
+ + +
$field Field data from ISIS database schema.
+
+
+
Returns:
Denied field combinations.
+ +

Sample denied combination.

+

$sample = array( 0 => array('a', 'b', 'c'), // a AND b AND c OR 1 => array('a', 'c', '!d'), // a AND b BUT WITHOUT d OR 2 => array('a', 'b', '*'), // a AND b AND any other item OR 3 => array('*2'), // ANY two items together OR 4 => array('main', '*'), // main AND ANY other item OR );

+

+
@@ -204,6 +273,32 @@ Inheritance diagram for IsisMap:

Get all field names.

Returns:
Array with field names.
+ + + +
+
+ + + + + + + + + +
IsisMap::getFullMap ($  field ) 
+
+
+

Get the full map.

+
Parameters:
+ + +
$field Field key.
+
+
+
Returns:
Array with full map or false if there is no map.
+
@@ -397,7 +492,7 @@ Inheritance diagram for IsisMap: - +
@@ -405,13 +500,19 @@ Inheritance diagram for IsisMap: - + + + + + + + - + @@ -424,8 +525,9 @@ Inheritance diagram for IsisMap:

Get a subfield name.

Parameters:
IsisMap::getSubfieldName ( $  field_key, field,
$  subfield_key,
$  subfield_key  by_key = FALSE 
- + +
$field_key Field key.
$field Field name or key.
$subfield_key Subfield key.
$by_key Set to true if you're passing the field key instead of it's name.
@@ -591,7 +693,7 @@ Inheritance diagram for IsisMap:
-
Generated on Thu Sep 2 12:20:42 2010 for Cinisis Database Reader by  +
Generated on Thu Sep 16 11:13:08 2010 for Cinisis Database Reader by  doxygen 1.6.3
-- cgit v1.2.3