PHP Interface Storm\Core\Mapping\ICollectionPropertyToManyRelationMapping

Author: Elliot Levin ([email protected])
Inheritance: extends Storm\Core\Mapping\IPropertyMapping
Show file Open project: timetoogo/penumbra

Public Methods

Method Description
AddToRelationalRequest ( DomainDatabaseMap $DomainDatabaseMap, Request $RelationalRequest ) : void Adds any constraints and/or properties to the reqeuest required for loading the relation.
GetCollectionProperty ( ) : Object\ICollectionProperty The mapped collection property.
GetToManyRelation ( ) : Storm\Core\Relational\IToManyRelation The mapped to many relation.
Persist ( Transaction $Transaction, ResultRow $ParentData, array $RelationshipChanges ) : void This method should be implemented such that it saves the relationships between the parent data and related data in the supplied transaction.
Revive ( DomainDatabaseMap $DomainDatabaseMap, array $ResultRowArray, array $RevivalDataArray ) : void This method should be implemented such that it sets the revival data of the mapped property with the appropriate data to revive the related entity.

Method Details

AddToRelationalRequest() public method

Adds any constraints and/or properties to the reqeuest required for loading the relation.
public AddToRelationalRequest ( DomainDatabaseMap $DomainDatabaseMap, Request $RelationalRequest ) : void
$DomainDatabaseMap DomainDatabaseMap The parent domain database map
$RelationalRequest Storm\Core\Relational\Request The request to map to
return void

GetCollectionProperty() public method

The mapped collection property.
public GetCollectionProperty ( ) : Object\ICollectionProperty
return Object\ICollectionProperty

GetToManyRelation() public method

The mapped to many relation.
public GetToManyRelation ( ) : Storm\Core\Relational\IToManyRelation
return Storm\Core\Relational\IToManyRelation

Persist() public method

This method should be implemented such that it saves the relationships between the parent data and related data in the supplied transaction.
public Persist ( Transaction $Transaction, ResultRow $ParentData, array $RelationshipChanges ) : void
$Transaction Storm\Core\Relational\Transaction The transaction context
$ParentData Storm\Core\Relational\ResultRow The column data of the parent
$RelationshipChanges array The change in the relationship state
return void

Revive() public method

This method should be implemented such that it sets the revival data of the mapped property with the appropriate data to revive the related entity.
public Revive ( DomainDatabaseMap $DomainDatabaseMap, array $ResultRowArray, array $RevivalDataArray ) : void
$DomainDatabaseMap DomainDatabaseMap The parent domain database map
$ResultRowArray array
$RevivalDataArray array
return void