Docs For Class SchemaRelationship

Description

The base SchemaRelationship class contains and provides accessors to the local table object and key and the reference (foreign) table object and key.

author: Anthony Bush
todo: 2007-10-24/AWB: consider deprecating the "ObjectName" stuff as it doesn't get set at the schema level, but instead at the generation level (e.g. a config function might take one of the objects and return the "ObjectName" but it is not pre-filled here)

Located in /schema/SchemaRelationship.class.php (line 11)

Direct descendents

Class	Description
SchemaRelationshipHasMany	SchemaRelationshipHasMany adds methods to pull it's "has one" counterpart.
SchemaRelationshipHasOne	SchemaRelationshipHasOne adds methods to pull it's "has many" counterpart.

Variable Summary

mixed $localKey

mixed $localRefObjectName

mixed $localTable

mixed $refKey

mixed $refObjectName

mixed $refTable

Method Summary

void getLocalKey ()

void getLocalObjectName ()

void getLocalTable ()

void getLocalTableName ()

void getRefKey ()

void getRefObjectName ()

void getRefTable ()

void getRefTableName ()

boolean isKeyNullable ( $keySet)

void setLocalKey ( $localKey)

void setLocalObjectName ( $localObjectName)

void setLocalTable ( $localTable)

void setRefKey ( $key)

void setRefObjectName ( $objectName)

void setRefTable ( $table)

Variables

mixed $localKey = null (line 18)

access: protected

mixed $localRefObjectName = null (line 17)

access: protected

mixed $localTable = null (line 16)

access: protected

mixed $refKey = null (line 14)

access: protected

mixed $refObjectName = null (line 13)

access: protected

mixed $refTable = null (line 12)

access: protected

Methods

getLocalKey (line 50)

access: public

void getLocalKey ()

getLocalObjectName (line 46)

access: public

void getLocalObjectName ()

getLocalTable (line 38)

access: public

void getLocalTable ()

getLocalTableName (line 42)

access: public

void getLocalTableName ()

getRefKey (line 34)

access: public

void getRefKey ()

getRefObjectName (line 30)

access: public

void getRefObjectName ()

getRefTable (line 22)

access: public

void getRefTable ()

getRefTableName (line 26)

access: public

void getRefTableName ()

isKeyNullable (line 85)

Returns false if all keys are NOT NULL, true otherwise.

access: public

boolean isKeyNullable ( $keySet)

$keySet

setLocalKey (line 76)

access: public

void setLocalKey ( $localKey)

$localKey

setLocalObjectName (line 72)

access: public

void setLocalObjectName ( $localObjectName)

$localObjectName

setLocalTable (line 68)

access: public

void setLocalTable ( $localTable)

$localTable

setRefKey (line 60)

access: public

void setRefKey ( $key)

$key

setRefObjectName (line 64)

access: public

void setRefObjectName ( $objectName)

$objectName

setRefTable (line 56)

access: public

void setRefTable ( $table)

$table