PrimaryKeyInfo Class Reference

List of all members.

Public Member Functions

 __construct ($name, $vendorInfo=array())
 getName ()
 Get foreign key name.
 addColumn ($column)
 getColumns ()
 getVendorSpecificInfo ()
 Get vendor specific optional information for this primary key.
 toString ()

Private Attributes

 $name
 name of the primary key
 $columns = array()
 columns in the primary key
 $vendorSpecificInfo = array()
 additional vendor specific information


Detailed Description

Definition at line 29 of file PrimaryKeyInfo.php.


Constructor & Destructor Documentation

PrimaryKeyInfo::__construct ( name,
vendorInfo = array() 
)

Parameters:
string $name The name of the foreign key.

Definition at line 43 of file PrimaryKeyInfo.php.

References $name.

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


Member Function Documentation

PrimaryKeyInfo::addColumn ( column  ) 

Parameters:
Column $column
Returns:
void

Definition at line 62 of file PrimaryKeyInfo.php.

00063     {
00064         $this->columns[] = $column;
00065     }

PrimaryKeyInfo::getColumns (  ) 

Returns:
array Column[]

Definition at line 70 of file PrimaryKeyInfo.php.

00071     {
00072         return $this->columns;
00073     }

PrimaryKeyInfo::getName (  ) 

Get foreign key name.

Returns:
string

Definition at line 53 of file PrimaryKeyInfo.php.

00054     {
00055         return $this->name;
00056     }

PrimaryKeyInfo::getVendorSpecificInfo (  ) 

Get vendor specific optional information for this primary key.

Returns:
array vendorSpecificInfo[]

Definition at line 79 of file PrimaryKeyInfo.php.

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

PrimaryKeyInfo::toString (  ) 

Returns:
string

Definition at line 87 of file PrimaryKeyInfo.php.

00088     {
00089         return $this->name;
00090     }


Member Data Documentation

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

columns in the primary key

Definition at line 35 of file PrimaryKeyInfo.php.

PrimaryKeyInfo::$name [private]

name of the primary key

Definition at line 32 of file PrimaryKeyInfo.php.

Referenced by __construct().

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

additional vendor specific information

Definition at line 38 of file PrimaryKeyInfo.php.


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

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