PHP Class Storm\Core\Object\EntityMap

Inheritance: implements Storm\Core\Object\IEntityMap, use trait Storm\Core\Helpers\Type

Show file Open project: timetoogo/penumbra Class Usage Examples

Public Methods

Method	Description
Apply ( Domain $Domain, $Entity, PropertyData $PropertyData )	{@inheritDoc}
Discard ( UnitOfWork $UnitOfWork, $Entity )	{@inheritDoc}
DiscardenceData ( array $DiscardenceData = [] )	{@inheritDoc}
GetCollectionProperties ( )	{@inheritDoc}
GetDataProperties ( )	{@inheritDoc}
GetEntityProperties ( )	{@inheritDoc}
GetEntityType ( )	{@inheritDoc}
GetIdentityProperties ( ) : Storm\Core\Object\IProperty[]
GetProperties ( )	{@inheritDoc}
GetProperty ( $Identifier )	{@inheritDoc}
GetRelationshipProperties ( )	{@inheritDoc}
HasIdentity ( $Entity )	{@inheritDoc}
HasIdentityProperty ( $Identifier )	{@inheritDoc}
HasProperty ( $Identifier )	{@inheritDoc}
HasRelationshipProperty ( $Identifier )	{@inheritDoc}
Identity ( $Entity = null )	{@inheritDoc}
InititalizeProperties ( Domain $Domain )	{@inheritDoc}
Is ( Storm\Core\Object\IEntityMap $OtherEntityMap )	{@inheritDoc}
LoadEntity ( Domain $Domain, RevivalData $RevivalData, $Entity )	{@inheritDoc}
Persist ( UnitOfWork $UnitOfWork, $Entity )	{@inheritDoc}
PersistRelationships ( UnitOfWork $UnitOfWork, $Entity )	{@inheritDoc}
PersistanceData ( array $PersistanceData = [] )	{@inheritDoc}
RevivalData ( array $RevivalData = [] )	{@inheritDoc}
ReviveEntities ( Domain $Domain, array $RevivalDatas )	{@inheritDoc}
__construct ( )

Protected Methods

Method	Description
ConstructEntity ( RevivalData $RevivalData )	{@inheritDoc}
EntityType ( ) : string	This method should be implemented such that it returns the type of entity that this map represents.
RegisterProperties ( Domain $Domain, Registrar $Registrar ) : void	This method should be implemented such that it registers the properties of the entity.

Private Methods

Method	Description
AddProperty ( Storm\Core\Object\IProperty $Property ) : void	Adds a property to the given entity map.
VerifyEntity ( $Method, object $Entity )	Verifies an object to be of the type represented by this entity map.

Method Details

Apply() final public method

{@inheritDoc}

final public Apply ( Domain $Domain, $Entity, PropertyData $PropertyData )
$Domain	Domain
$PropertyData	PropertyData

ConstructEntity() abstract protected method

{@inheritDoc}

abstract protected ConstructEntity ( RevivalData $RevivalData )
$RevivalData	RevivalData

Discard() final public method

{@inheritDoc}

final public Discard ( UnitOfWork $UnitOfWork, $Entity )
$UnitOfWork	UnitOfWork

DiscardenceData() final public method

{@inheritDoc}

final public DiscardenceData ( array $DiscardenceData = [] )
$DiscardenceData	array

EntityType() abstract protected method

This method should be implemented such that it returns the type of entity that this map represents.

abstract protected EntityType ( ) : string
return	string

GetCollectionProperties() final public method

{@inheritDoc}

final public GetCollectionProperties ( )

GetDataProperties() final public method

{@inheritDoc}

final public GetDataProperties ( )

GetEntityProperties() final public method

{@inheritDoc}

final public GetEntityProperties ( )

GetEntityType() final public method

{@inheritDoc}

final public GetEntityType ( )

GetIdentityProperties() final public method

final public GetIdentityProperties ( ) : Storm\Core\Object\IProperty[]
return	Storm\Core\Object\IProperty[]

GetProperties() final public method

{@inheritDoc}

final public GetProperties ( )

GetProperty() final public method

{@inheritDoc}

final public GetProperty ( $Identifier )

GetRelationshipProperties() final public method

{@inheritDoc}

final public GetRelationshipProperties ( )

HasIdentity() final public method

{@inheritDoc}

final public HasIdentity ( $Entity )

HasIdentityProperty() final public method

{@inheritDoc}

final public HasIdentityProperty ( $Identifier )

HasProperty() final public method

{@inheritDoc}

final public HasProperty ( $Identifier )

HasRelationshipProperty() final public method

{@inheritDoc}

final public HasRelationshipProperty ( $Identifier )

Identity() final public method

{@inheritDoc}

final public Identity ( $Entity = null )

InititalizeProperties() final public method

{@inheritDoc}

final public InititalizeProperties ( Domain $Domain )
$Domain	Domain

Is() final public method

{@inheritDoc}

final public Is ( Storm\Core\Object\IEntityMap $OtherEntityMap )
$OtherEntityMap	Storm\Core\Object\IEntityMap

LoadEntity() final public method

{@inheritDoc}

final public LoadEntity ( Domain $Domain, RevivalData $RevivalData, $Entity )
$Domain	Domain
$RevivalData	RevivalData

Persist() final public method

{@inheritDoc}

final public Persist ( UnitOfWork $UnitOfWork, $Entity )
$UnitOfWork	UnitOfWork

PersistRelationships() final public method

{@inheritDoc}

final public PersistRelationships ( UnitOfWork $UnitOfWork, $Entity )
$UnitOfWork	UnitOfWork

PersistanceData() final public method

{@inheritDoc}

final public PersistanceData ( array $PersistanceData = [] )
$PersistanceData	array

RegisterProperties() abstract protected method

This method should be implemented such that it registers the properties of the entity.

abstract protected RegisterProperties ( Domain $Domain, Registrar $Registrar ) : void
$Domain	Domain
$Registrar	Storm\Core\Containers\Registrar
return	void

RevivalData() final public method

{@inheritDoc}

final public RevivalData ( array $RevivalData = [] )
$RevivalData	array

ReviveEntities() final public method

{@inheritDoc}

final public ReviveEntities ( Domain $Domain, array $RevivalDatas )
$Domain	Domain
$RevivalDatas	array

__construct() public method

public __construct ( )