PHP Interface Storm\Core\Mapping\IEntityRelationalMap

Author: Elliot Levin ([email protected])
Mostrar archivo Open project: timetoogo/penumbra Interface Usage Examples

Public Methods

Method Description
GetAllMappedPersistColumns ( array $Properties = null ) : Storm\Core\Relational\IColumn[]
GetAllMappedReviveColumns ( array $Properties = null ) : Storm\Core\Relational\IColumn[]
GetCollectionPropertyToManyRelationMappings ( ) : Storm\Core\Mapping\ICollectionPropertyToManyRelationMapping[]
GetCriterion ( ) : Criterion Get the criterion that must be included for every request.
GetDataPropertyColumnMappings ( ) : Storm\Core\Mapping\IDataPropertyColumnMapping[]
GetEntityMap ( ) : Storm\Core\Object\IEntityMap The entity map of represented entity.
GetEntityPropertyToOneRelationMappings ( ) : Storm\Core\Mapping\IEntityPropertyToOneRelationMapping[]
GetEntityType ( ) : string The type of entity that this relational map is representing.
GetIdentityPropertyPrimaryKeyMappings ( ) : Storm\Core\Mapping\IDataPropertyColumnMapping[]
GetMappedPersistColumns ( Storm\Core\Object\IProperty $Property ) : Storm\Core\Relational\IColumn[]
GetMappedPersistTables ( ) : Storm\Core\Relational\ITable[] The tables that are mapped to for persistence.
GetMappedProperties ( ) : Storm\Core\Object\IProperties[] The properties that mapped.
GetMappedReviveColumns ( Storm\Core\Object\IProperty $Property ) : Storm\Core\Relational\IColumn[]
GetMappedReviveTables ( ) : Storm\Core\Relational\ITable[] The tables that are mapped from for revival.
GetPrimaryKeyTable ( ) : Storm\Core\Relational\ITable The table in which the identity is stored.
GetPropertyMappings ( ) : Storm\Core\Mapping\IPropertyMapping[]
Initialize ( DomainDatabaseMap $DomainDatabaseMap ) : void Intialize the property mapping in the context of the parent domain database map.
MapIdentitiesToPrimaryKeys ( array $Identities ) : PrimaryKey[] Maps an array of identities to the equivalent primary keys.
MapIdentityToPrimaryKey ( Identity $Identity ) : PrimaryKey Maps an identity to the equivalent primary key.
MapPrimaryKeyToIdentity ( PrimaryKey $PrimaryKey ) : Identity Map a primary key to the equivalent identity.
MapPrimaryKeysToIdentities ( array $PrimaryKeys ) : Identity[] Maps an array of primary keysto the equivalent identities.
ResultRow ( array $ColumnData = [] ) : ResultRow Instantiate a new result row for the given column data.

Method Details

GetAllMappedPersistColumns() public method

public GetAllMappedPersistColumns ( array $Properties = null ) : Storm\Core\Relational\IColumn[]
$Properties array The mapped properties
return Storm\Core\Relational\IColumn[]

GetAllMappedReviveColumns() public method

public GetAllMappedReviveColumns ( array $Properties = null ) : Storm\Core\Relational\IColumn[]
$Properties array The mapped properties
return Storm\Core\Relational\IColumn[]

GetCollectionPropertyToManyRelationMappings() public method

public GetCollectionPropertyToManyRelationMappings ( ) : Storm\Core\Mapping\ICollectionPropertyToManyRelationMapping[]
return Storm\Core\Mapping\ICollectionPropertyToManyRelationMapping[]

GetCriterion() public method

Get the criterion that must be included for every request.
public GetCriterion ( ) : Criterion
return Storm\Core\Relational\Criterion

GetDataPropertyColumnMappings() public method

public GetDataPropertyColumnMappings ( ) : Storm\Core\Mapping\IDataPropertyColumnMapping[]
return Storm\Core\Mapping\IDataPropertyColumnMapping[]

GetEntityMap() public method

The entity map of represented entity.
public GetEntityMap ( ) : Storm\Core\Object\IEntityMap
return Storm\Core\Object\IEntityMap

GetEntityPropertyToOneRelationMappings() public method

public GetEntityPropertyToOneRelationMappings ( ) : Storm\Core\Mapping\IEntityPropertyToOneRelationMapping[]
return Storm\Core\Mapping\IEntityPropertyToOneRelationMapping[]

GetEntityType() public method

The type of entity that this relational map is representing.
public GetEntityType ( ) : string
return string

GetIdentityPropertyPrimaryKeyMappings() public method

public GetIdentityPropertyPrimaryKeyMappings ( ) : Storm\Core\Mapping\IDataPropertyColumnMapping[]
return Storm\Core\Mapping\IDataPropertyColumnMapping[]

GetMappedPersistColumns() public method

public GetMappedPersistColumns ( Storm\Core\Object\IProperty $Property ) : Storm\Core\Relational\IColumn[]
$Property Storm\Core\Object\IProperty The mapped property
return Storm\Core\Relational\IColumn[]

GetMappedPersistTables() public method

The tables that are mapped to for persistence.
public GetMappedPersistTables ( ) : Storm\Core\Relational\ITable[]
return Storm\Core\Relational\ITable[]

GetMappedProperties() public method

The properties that mapped.
public GetMappedProperties ( ) : Storm\Core\Object\IProperties[]
return Storm\Core\Object\IProperties[]

GetMappedReviveColumns() public method

public GetMappedReviveColumns ( Storm\Core\Object\IProperty $Property ) : Storm\Core\Relational\IColumn[]
$Property Storm\Core\Object\IProperty The mapped property
return Storm\Core\Relational\IColumn[]

GetMappedReviveTables() public method

The tables that are mapped from for revival.
public GetMappedReviveTables ( ) : Storm\Core\Relational\ITable[]
return Storm\Core\Relational\ITable[]

GetPrimaryKeyTable() public method

The table in which the identity is stored.
public GetPrimaryKeyTable ( ) : Storm\Core\Relational\ITable
return Storm\Core\Relational\ITable

GetPropertyMappings() public method

public GetPropertyMappings ( ) : Storm\Core\Mapping\IPropertyMapping[]
return Storm\Core\Mapping\IPropertyMapping[]

Initialize() public method

Intialize the property mapping in the context of the parent domain database map.
public Initialize ( DomainDatabaseMap $DomainDatabaseMap ) : void
$DomainDatabaseMap DomainDatabaseMap The parent domain database map
return void

MapIdentitiesToPrimaryKeys() public method

NOTE: Keys are preserved
public MapIdentitiesToPrimaryKeys ( array $Identities ) : PrimaryKey[]
$Identities array
return Storm\Core\Relational\PrimaryKey[] The mapped primary keys

MapIdentityToPrimaryKey() public method

Maps an identity to the equivalent primary key.
public MapIdentityToPrimaryKey ( Identity $Identity ) : PrimaryKey
$Identity Storm\Core\Object\Identity The identity to map
return Storm\Core\Relational\PrimaryKey The mapped primary key

MapPrimaryKeyToIdentity() public method

Map a primary key to the equivalent identity.
public MapPrimaryKeyToIdentity ( PrimaryKey $PrimaryKey ) : Identity
$PrimaryKey Storm\Core\Relational\PrimaryKey
return Storm\Core\Object\Identity $Identity The mapped identity

MapPrimaryKeysToIdentities() public method

NOTE: Keys are preserved
public MapPrimaryKeysToIdentities ( array $PrimaryKeys ) : Identity[]
$PrimaryKeys array
return Storm\Core\Object\Identity[] $Identity The mapped identities

ResultRow() public method

Instantiate a new result row for the given column data.
public ResultRow ( array $ColumnData = [] ) : ResultRow
$ColumnData array the column data
return Storm\Core\Relational\ResultRow