PHP Класс Storm\Api\Base\Repository

Автор: Elliot Levin ([email protected])
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$DomainDatabaseMap Storm\Core\Mapping\DomainDatabaseMap The DomainDatabaseMap to query.
$EntityMap Storm\Core\Object\IEntityMap The EntityMap for this repository.
$EntityType string The type of entity represented by this repository.
$FunctionToASTConverter FunctionToASTConverter
$IdentityProperties The properties representing the identity of the entity.

Открытые методы

Метод Описание
ClearChanges ( ) : void Clears all the pending changes awaiting to be commited to underlying DomainDatabaseMap.
Criterion ( ) : CriterionBuilder Quick access to a new CriterionBuilder instance.
Discard ( object | CriterionBuilder | Storm\Core\Object\ICriterion $EntityOrCriterion ) : void Adds an entity or criterion to the discardence queue.
DiscardAll ( array $Entities ) : void Adds an array of entities to the discardence queue.
Execute ( ProcedureBuilder $ProcedureBuilder ) : void Adds a procedure to the execution queue directly from the builder.
ExecuteProcedure ( Storm\Core\Object\IProcedure $Procedure ) : void Adds a procedure to the execution queue.
GetChanges ( ) : array Gets the pending changes.
GetIdentityMap ( ) : IdentityMap Gets the identity map used for this repository.
Load ( RequestBuilder $RequestBuilder ) : object | null | array Load a request directly from the builder instance.
LoadById ( $_ ) : object | null Loads an entity from given identity values or null if entity does not exist.
LoadRequest ( Storm\Core\Object\IRequest $Request ) : object | null | array Load entities specified by a request instance.
Persist ( object $Entity ) : void Adds an entity to the persistence queue.
PersistAll ( array $Entities ) : void Adds an array of entities to the persistence queue.
Procedure ( callable $ProcedureClosure ) : ProcedureBuilder Quick access to a new ProcedureBuilder instance.
Request ( ) : RequestBuilder Quick access to a new RequestBuilder instance.
SaveChanges ( ) : void Commits all specified changes to the underlying DomainDatabaseMap.
SetAutoSave ( boolean $AutoSave ) : void Set whether or not to automatically commit every change.
__construct ( DomainDatabaseMap $DomainDatabaseMap, FunctionToASTConverter $FunctionToASTConverter, $EntityType )

Защищенные методы

Метод Описание
LoadByIdentity ( Identity $Identity ) : object | null Loads an entity from an identity instance.
VerifyEntity ( string $Method, object $Entity ) Verifies an entity to be valid for use in this repository.

Приватные методы

Метод Описание
AutoSave ( ) : void Commits changes if AutoSave is enabled.

Описание методов

ClearChanges() закрытый публичный Метод

Clears all the pending changes awaiting to be commited to underlying DomainDatabaseMap.
final public ClearChanges ( ) : void
Результат void

Criterion() закрытый публичный Метод

Quick access to a new CriterionBuilder instance.
final public Criterion ( ) : CriterionBuilder
Результат Storm\Api\Base\Fluent\CriterionBuilder

Discard() публичный Метод

If AutoSave is enabled, the action will be commited.
public Discard ( object | CriterionBuilder | Storm\Core\Object\ICriterion $EntityOrCriterion ) : void
$EntityOrCriterion object | Storm\Api\Base\Fluent\CriterionBuilder | Storm\Core\Object\ICriterion The entity or criterion to discard
Результат void

DiscardAll() публичный Метод

If AutoSave is enabled, the action will be commited.
public DiscardAll ( array $Entities ) : void
$Entities array The entities to discard
Результат void

Execute() публичный Метод

If AutoSave is enabled, the action will be commited.
public Execute ( ProcedureBuilder $ProcedureBuilder ) : void
$ProcedureBuilder Storm\Api\Base\Fluent\ProcedureBuilder The procedure to build and execute
Результат void

ExecuteProcedure() публичный Метод

If AutoSave is enabled, the action will be commited.
public ExecuteProcedure ( Storm\Core\Object\IProcedure $Procedure ) : void
$Procedure Storm\Core\Object\IProcedure
Результат void

GetChanges() закрытый публичный Метод

Gets the pending changes.
final public GetChanges ( ) : array
Результат array An array containing all the operations queues

GetIdentityMap() публичный Метод

Gets the identity map used for this repository.
public GetIdentityMap ( ) : IdentityMap
Результат IdentityMap

Load() публичный Метод

Load a request directly from the builder instance.
public Load ( RequestBuilder $RequestBuilder ) : object | null | array
$RequestBuilder Storm\Api\Base\Fluent\RequestBuilder The builder representing the request to load
Результат object | null | array The returned results

LoadById() публичный Метод

Loads an entity from given identity values or null if entity does not exist.
public LoadById ( $_ ) : object | null
Результат object | null The returned entity or null

LoadByIdentity() защищенный Метод

Loads an entity from an identity instance.
protected LoadByIdentity ( Identity $Identity ) : object | null
$Identity Storm\Core\Object\Identity The identity of the entity
Результат object | null

LoadRequest() публичный Метод

Load entities specified by a request instance.
public LoadRequest ( Storm\Core\Object\IRequest $Request ) : object | null | array
$Request Storm\Core\Object\IRequest The request to load
Результат object | null | array

Persist() публичный Метод

If AutoSave is enabled, the action will be commited.
public Persist ( object $Entity ) : void
$Entity object The entity to persist
Результат void

PersistAll() публичный Метод

If AutoSave is enabled, the action will be commited.
public PersistAll ( array $Entities ) : void
$Entities array The entities to persist
Результат void

Procedure() закрытый публичный Метод

Quick access to a new ProcedureBuilder instance.
final public Procedure ( callable $ProcedureClosure ) : ProcedureBuilder
$ProcedureClosure callable
Результат Storm\Api\Base\Fluent\ProcedureBuilder

Request() закрытый публичный Метод

Quick access to a new RequestBuilder instance.
final public Request ( ) : RequestBuilder
Результат Storm\Api\Base\Fluent\RequestBuilder

SaveChanges() публичный Метод

Commits all specified changes to the underlying DomainDatabaseMap.
public SaveChanges ( ) : void
Результат void

SetAutoSave() закрытый публичный Метод

Set whether or not to automatically commit every change.
final public SetAutoSave ( boolean $AutoSave ) : void
$AutoSave boolean
Результат void

VerifyEntity() закрытый защищенный Метод

Verifies an entity to be valid for use in this repository.
final protected VerifyEntity ( string $Method, object $Entity )
$Method string __METHOD__
$Entity object The entity to verify

__construct() публичный Метод

public __construct ( DomainDatabaseMap $DomainDatabaseMap, FunctionToASTConverter $FunctionToASTConverter, $EntityType )
$DomainDatabaseMap Storm\Core\Mapping\DomainDatabaseMap
$FunctionToASTConverter FunctionToASTConverter

Описание свойств

$DomainDatabaseMap защищенное свойство

The DomainDatabaseMap to query.
protected DomainDatabaseMap,Storm\Core\Mapping $DomainDatabaseMap
Результат Storm\Core\Mapping\DomainDatabaseMap

$EntityMap защищенное свойство

The EntityMap for this repository.
protected IEntityMap,Storm\Core\Object $EntityMap
Результат Storm\Core\Object\IEntityMap

$EntityType защищенное свойство

The type of entity represented by this repository.
protected string $EntityType
Результат string

$FunctionToASTConverter защищенное свойство

protected FunctionToASTConverter,Storm\Api\Base $FunctionToASTConverter
Результат FunctionToASTConverter

$IdentityProperties защищенное свойство

The properties representing the identity of the entity.
protected $IdentityProperties