RDBOneToManyRelationDescription Class Reference

Detailed Description

Instances of RDBOneToManyRelationDescription describe a one to many relation from 'this' end (one) to 'other' end (many) in a relational database.

Author
ingo herwig ingo@.nosp@m.wemo.nosp@m.ve.co.nosp@m.m

Definition at line 21 of file RDBOneToManyRelationDescription.php.

+ Inheritance diagram for RDBOneToManyRelationDescription:

Public Member Functions

 __construct ($thisType, $thisRole, $otherType, $otherRole, $thisMinMultiplicity, $thisMaxMultiplicity, $otherMinMultiplicity, $otherMaxMultiplicity, $thisAggregationKind, $otherAggregationKind, $thisNavigability, $otherNavigability, $hierarchyType, $idName, $fkName)
 
 getIdName ()
 
 getFkName ()
 
- Public Member Functions inherited from RelationDescription
 __construct ($thisType, $thisRole, $otherType, $otherRole, $thisMinMultiplicity, $thisMaxMultiplicity, $otherMinMultiplicity, $otherMaxMultiplicity, $thisAggregationKind, $otherAggregationKind, $thisNavigability, $otherNavigability, $hierarchyType)
 
 isMultiValued ()
 
 getThisType ()
 
 getThisMapper ()
 
 getThisRole ()
 
 getOtherType ()
 
 getOtherMapper ()
 
 getOtherRole ()
 
 getThisMinMultiplicity ()
 
 getThisMaxMultiplicity ()
 
 getOtherMinMultiplicity ()
 
 getOtherMaxMultiplicity ()
 
 getThisAggregationKind ()
 
 getOtherAggregationKind ()
 
 getThisNavigability ()
 
 getOtherNavigability ()
 
 getHierarchyType ()
 
 isSameRelation (RelationDescription $other)
 

Protected Attributes

 $idName = ''
 
 $fkName = ''
 
- Protected Attributes inherited from RelationDescription
 $thisType = ''
 
 $thisRole = ''
 
 $otherType = ''
 
 $otherRole = ''
 
 $thisMinMultiplicity = '0'
 
 $thisMaxMultiplicity = 'unbound'
 
 $otherMinMultiplicity = '0'
 
 $otherMaxMultiplicity = 'unbound'
 
 $thisAggregationKind = 'none'
 
 $otherAggregationKind = 'none'
 
 $thisNavigability = true
 
 $otherNavigability = true
 
 $hierarchyType = 'undefined'
 

Constructor & Destructor Documentation

__construct (   $thisType,
  $thisRole,
  $otherType,
  $otherRole,
  $thisMinMultiplicity,
  $thisMaxMultiplicity,
  $otherMinMultiplicity,
  $otherMaxMultiplicity,
  $thisAggregationKind,
  $otherAggregationKind,
  $thisNavigability,
  $otherNavigability,
  $hierarchyType,
  $idName,
  $fkName 
)

Constructor.

Parameters
$thisTypeThe PersistentObject type at this end
$thisRoleThe role name at this end
$otherTypeThe PersistentObject type at the other end
$otherRoleThe role name at the other end
$thisMinMultiplicityThe minimum number of instances at this end (number or 'unbound')
$thisMaxMultiplicityThe maximum number of instances at this end (number or 'unbound')
$otherMinMultiplicityThe minimum number of instances at the other end (number or 'unbound')
$otherMaxMultiplicityThe maximum number of instances at the other end (number or 'unbound')
$thisAggregationKindThe aggregation kind at this end ('none', 'shared' or 'composite')
$otherAggregationKindThe aggregation kind at the other end ('none', 'shared' or 'composite')
$thisNavigabilityBoolean whether this end is navigable from the other end or not
$otherNavigabilityBoolean whether the other end is navigable from this end or not
$hierarchyTypeThe hierarchy type that the other end has in relation to this end ('parent', 'child', 'undefined')
$idNameThe name of the attribute in 'this' end's type, that is referenced by the foreign key attribute in the 'other' end's type
$fkNameThe name of the foreign key attribute in the 'other' end's type

Definition at line 44 of file RDBOneToManyRelationDescription.php.

Member Function Documentation

getIdName ( )

Get the name of the attribute in 'this' end's type, that is referenced by the foreign key attribute in the 'other' end's type.

Returns
String

Definition at line 61 of file RDBOneToManyRelationDescription.php.

getFkName ( )

Get the name of the foreign key attribute in the 'other' end's type.

Returns
String

Definition at line 69 of file RDBOneToManyRelationDescription.php.

Member Data Documentation

$idName = ''
protected

Definition at line 23 of file RDBOneToManyRelationDescription.php.

$fkName = ''
protected

Definition at line 24 of file RDBOneToManyRelationDescription.php.