IndexInfo Class Reference

List of all members.

Public Member Functions

 __construct ($name, $isUnique=false, $vendorInfo=array())
 isUnique ()
 getName ()
 getVendorSpecificInfo ()
 Get vendor specific optional information for this index.
 addColumn ($column)
 getColumns ()
 toString ()

Private Attributes

 $name
 name of the index
 $columns = array()
 columns in this index
 $isUnique = false
 uniqueness flag
 $vendorSpecificInfo = array()
 additional vendor specific information


Detailed Description

Definition at line 29 of file IndexInfo.php.


Constructor & Destructor Documentation

IndexInfo::__construct ( name,
isUnique = false,
vendorInfo = array() 
)

Definition at line 43 of file IndexInfo.php.

References $isUnique, $name, and isUnique().

00044     {
00045         $this->name = $name;
00046         $this->isUnique = $isUnique;
00047         $this->vendorSpecificInfo = $vendorInfo;
00048     }


Member Function Documentation

IndexInfo::addColumn ( column  ) 

Definition at line 69 of file IndexInfo.php.

00070     {
00071         $this->columns[] = $column;
00072     }

IndexInfo::getColumns (  ) 

Definition at line 74 of file IndexInfo.php.

00075     {
00076         return $this->columns;
00077     }

IndexInfo::getName (  ) 

Definition at line 55 of file IndexInfo.php.

00056     {
00057         return $this->name;
00058     }

IndexInfo::getVendorSpecificInfo (  ) 

Get vendor specific optional information for this index.

Returns:
array vendorSpecificInfo[]

Definition at line 64 of file IndexInfo.php.

00065     {
00066         return $this->vendorSpecificInfo;
00067     }

IndexInfo::isUnique (  ) 

Definition at line 50 of file IndexInfo.php.

Referenced by __construct().

00051     {
00052         return $this->isUnique;
00053     }

IndexInfo::toString (  ) 

Definition at line 79 of file IndexInfo.php.

00080     {
00081         return $this->name;
00082     }


Member Data Documentation

IndexInfo::$columns = array() [private]

columns in this index

Definition at line 35 of file IndexInfo.php.

IndexInfo::$isUnique = false [private]

uniqueness flag

Definition at line 38 of file IndexInfo.php.

Referenced by __construct().

IndexInfo::$name [private]

name of the index

Definition at line 32 of file IndexInfo.php.

Referenced by __construct().

IndexInfo::$vendorSpecificInfo = array() [private]

additional vendor specific information

Definition at line 41 of file IndexInfo.php.


The documentation for this class was generated from the following file:

Generated on Wed May 6 23:10:49 2009 for fareofficelib by  doxygen 1.5.8