Jet\DataModel_Definition_Relation

This abstract class is the common base for classes representing the definition of internal and external relation. Thus, the Jet\DataModel_Definition_Relation_Internal and Jet\DataModel_Definition_Relation_External classes inherit from this class.

Overview of methods

Method Meaning of
public setThisToClass(
string $this_to_class_name
) : void		 Sets the name of the class to which the relation belongs.
public getThisDataModelClassName(
) : string		 Returns the name of the class to which the relation belongs.
public getThisDataModelName(
) : string		 Returns the name of the entity to which the relation belongs.
public getThisDataModelDefinition(
) : DataModel_Definition_Model		 Returns the definition of the entity to which the relation belongs.
public setRelatedToClass(
string $related_to_class_name
)		 Sets the name of the class that the session references.
public getRelatedDataModelClassName(
) : string		 Returns the name of the class to which the relation refers.
public getRelatedDataModelName(
) : string		 Returns the name of the entity that the relation references.
public getRelatedDataModelDefinition(
) : DataModel_Definition_Model		 Returns the definition of the entity referenced by the relation.
public setJoinType(
string $join_type
) : void		 Sets the join type.
public getJoinType(
) : string		 Returns the join type.
public setJoinBy(
DataModel_Definition_Relation_Join_Item[] $items
) : void		 Sets the relation jumper items.
public getJoinBy(
) : DataModel_Definition_Relation_Join_Item[]		 Returns the relation jumper items.
public addJoinBy(
DataModel_Definition_Relation_Join_Item $item
) : void		 Adds a jumper item.
public addJoinCondition(
DataModel_Definition_Relation_Join_Condition $condition
) : void		 Adds a jumper expression. This means that the join can be bound not only to a property of the other entity, but also to a specific value.
public setRequiredRelations(
array $required_relations
) : void		 Sets the list of relations that are required for the relation. A relation list is a simple list of names of related entities.
public getRequiredRelations(
) : array		 Returns the list of required relations - see the setRequiredRelations method.
Previous chapter
Jet\DataModel_Relations
Next chapter
Jet\DataModel_Definition_Relation_Internal
GitHub