PHP Interface Storm\Core\Object\IEntityMap

Author: Elliot Levin ([email protected])
Afficher le fichier Open project: timetoogo/penumbra Interface Usage Examples

Méthodes publiques

Méthode Description
Apply ( Domain $Domain, object $Entity, PropertyData $PropertyData ) : void Applies the supplied property data to the supplied entity instance.
Discard ( UnitOfWork $UnitOfWork, object $Entity ) : DiscardenceData Discards an entity's relationships to the supplied unit of work and returns the discardence data.
DiscardenceData ( array $DiscardenceData = [] ) : DiscardenceData
GetCollectionProperties ( ) : Storm\Core\Object\ICollectionProperty[]
GetDataProperties ( ) : Storm\Core\Object\IDataProperty[]
GetEntityProperties ( ) : Storm\Core\Object\IEntityProperty[]
GetEntityType ( ) : string
GetIdentityProperties ( ) : Storm\Core\Object\IProperty[]
GetProperties ( ) : Storm\Core\Object\IProperty[]
GetProperty ( string $Identifier ) : Storm\Core\Object\IProperty | null Gets a property by its identifier
GetRelationshipProperties ( ) : Storm\Core\Object\IRelationshipProperty[]
HasIdentity ( object $Entity ) : boolean Whether or not the entity has a full identity.
HasIdentityProperty ( string $Identifier ) : boolean Whether or not this map contains a property with the supplied identifier
HasProperty ( string $Identifier ) : boolean Whether or not this map contains a property withthe supplied identifier
HasRelationshipProperty ( string $Identifier ) : void Whether or not this map contains a relationship property with the supplied identifier
Identity ( object | null $Entity = null ) : Identity If the entity is null returns a new blank identity otherwise returns the identity of the supplied entity.
InititalizeProperties ( Domain $Domain ) : void Initializes the properties of the entity within the context of the parent domain.
Is ( Storm\Core\Object\IEntityMap $OtherEntityMap ) : boolean Whether or not this and the supplied entity map represent the same entity.
LoadEntity ( Domain $Domain, RevivalData $RevivalData, object $Entity ) : void Loads an entity instance with the supplied revival data.
Persist ( UnitOfWork $UnitOfWork, object $Entity ) : PersistenceData Persists an entity's relationships to the supplied unit of work and returns the persistence data.
PersistRelationships ( UnitOfWork $UnitOfWork, object $Entity ) : PersistenceData Persists an entity's relationships to the supplied unit of work.
PersistanceData ( array $PersistanceData = [] ) : PersistenceData
RevivalData ( array $RevivalData = [] ) : RevivalData
ReviveEntities ( Domain $Domain, array $RevivalDataArray ) : object[] Revives an array of entities from the supplied array of revival data.

Method Details

Apply() public méthode

Applies the supplied property data to the supplied entity instance.
public Apply ( Domain $Domain, object $Entity, PropertyData $PropertyData ) : void
$Domain Domain The object domain to revive in entity in.
$Entity object The entity to apply the property data
$PropertyData PropertyData The property data apply
Résultat void

Discard() public méthode

Discards an entity's relationships to the supplied unit of work and returns the discardence data.
public Discard ( UnitOfWork $UnitOfWork, object $Entity ) : DiscardenceData
$UnitOfWork UnitOfWork The unit of work to discard from
$Entity object The entity to discard
Résultat DiscardenceData The discardence data of the entity

DiscardenceData() public méthode

public DiscardenceData ( array $DiscardenceData = [] ) : DiscardenceData
$DiscardenceData array
Résultat DiscardenceData

GetCollectionProperties() public méthode

public GetCollectionProperties ( ) : Storm\Core\Object\ICollectionProperty[]
Résultat Storm\Core\Object\ICollectionProperty[]

GetDataProperties() public méthode

public GetDataProperties ( ) : Storm\Core\Object\IDataProperty[]
Résultat Storm\Core\Object\IDataProperty[]

GetEntityProperties() public méthode

public GetEntityProperties ( ) : Storm\Core\Object\IEntityProperty[]
Résultat Storm\Core\Object\IEntityProperty[]

GetEntityType() public méthode

public GetEntityType ( ) : string
Résultat string

GetIdentityProperties() public méthode

public GetIdentityProperties ( ) : Storm\Core\Object\IProperty[]
Résultat Storm\Core\Object\IProperty[]

GetProperties() public méthode

public GetProperties ( ) : Storm\Core\Object\IProperty[]
Résultat Storm\Core\Object\IProperty[]

GetProperty() public méthode

Gets a property by its identifier
public GetProperty ( string $Identifier ) : Storm\Core\Object\IProperty | null
$Identifier string The property identifier
Résultat Storm\Core\Object\IProperty | null The matched property

GetRelationshipProperties() public méthode

public GetRelationshipProperties ( ) : Storm\Core\Object\IRelationshipProperty[]
Résultat Storm\Core\Object\IRelationshipProperty[]

HasIdentity() public méthode

Whether or not the entity has a full identity.
public HasIdentity ( object $Entity ) : boolean
$Entity object The entity to check
Résultat boolean

HasIdentityProperty() public méthode

Whether or not this map contains a property with the supplied identifier
public HasIdentityProperty ( string $Identifier ) : boolean
$Identifier string The property identifier
Résultat boolean

HasProperty() public méthode

Whether or not this map contains a property withthe supplied identifier
public HasProperty ( string $Identifier ) : boolean
$Identifier string The property identifier
Résultat boolean

HasRelationshipProperty() public méthode

Whether or not this map contains a relationship property with the supplied identifier
public HasRelationshipProperty ( string $Identifier ) : void
$Identifier string The property identifier
Résultat void

Identity() public méthode

If the entity is null returns a new blank identity otherwise returns the identity of the supplied entity.
public Identity ( object | null $Entity = null ) : Identity
$Entity object | null
Résultat Identity The entity's identity

InititalizeProperties() public méthode

Initializes the properties of the entity within the context of the parent domain.
public InititalizeProperties ( Domain $Domain ) : void
$Domain Domain The parent domain
Résultat void

Is() public méthode

Whether or not this and the supplied entity map represent the same entity.
public Is ( Storm\Core\Object\IEntityMap $OtherEntityMap ) : boolean
$OtherEntityMap Storm\Core\Object\IEntityMap Another entity map
Résultat boolean

LoadEntity() public méthode

Loads an entity instance with the supplied revival data.
public LoadEntity ( Domain $Domain, RevivalData $RevivalData, object $Entity ) : void
$Domain Domain
$RevivalData RevivalData The revival data to load the entity with
$Entity object The entity to load
Résultat void

Persist() public méthode

Persists an entity's relationships to the supplied unit of work and returns the persistence data.
public Persist ( UnitOfWork $UnitOfWork, object $Entity ) : PersistenceData
$UnitOfWork UnitOfWork The unit of work to persist to
$Entity object The entity to persist
Résultat PersistenceData The persistence data of the entity

PersistRelationships() public méthode

Persists an entity's relationships to the supplied unit of work.
public PersistRelationships ( UnitOfWork $UnitOfWork, object $Entity ) : PersistenceData
$UnitOfWork UnitOfWork The unit of work to persist to
$Entity object The entity to persist
Résultat PersistenceData The persistence data of the entity

PersistanceData() public méthode

public PersistanceData ( array $PersistanceData = [] ) : PersistenceData
$PersistanceData array
Résultat PersistenceData

RevivalData() public méthode

public RevivalData ( array $RevivalData = [] ) : RevivalData
$RevivalData array
Résultat RevivalData

ReviveEntities() public méthode

Revives an array of entities from the supplied array of revival data.
public ReviveEntities ( Domain $Domain, array $RevivalDataArray ) : object[]
$Domain Domain
$RevivalDataArray array The array of revival data
Résultat object[] The revived entities