PHP Класс Bravo3\Orm\Services\EntityManager

Наследование: use trait Bravo3\Orm\Traits\ProxyAwareTrait
Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$cache Bravo3\Orm\Services\Cache\EntityCachingInterface
$config Bravo3\Orm\Config\Configuration
$dispatcher Symfony\Component\EventDispatcher\EventDispatcher
$driver Bravo3\Orm\Drivers\DriverInterface
$index_manager IndexManager
$key_scheme Bravo3\Orm\KeySchemes\KeySchemeInterface
$maintenance_mode boolean
$mapper Bravo3\Orm\Mappers\MapperInterface
$query_manager QueryManager
$relationship_manager RelationshipManager
$serialiser_map Bravo3\Orm\Serialisers\SerialiserMap

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

Метод Описание
addListener ( string $event_name, callable $listener, integer $priority ) Add an event listener
addSubscriber ( Symfony\Component\EventDispatcher\EventSubscriberInterface $subscriber ) Add an event subscriber
build ( Bravo3\Orm\Drivers\DriverInterface $driver, Bravo3\Orm\Mappers\MapperInterface $mapper, SerialiserMap $serialiser_map = null, Bravo3\Orm\KeySchemes\KeySchemeInterface $key_scheme = null, Configuration $configuration = null, Bravo3\Orm\Services\Cache\EntityCachingInterface $cache = null ) : EntityManager Create a new entity manager
delete ( object $entity ) Delete an entity
flush ( ) Execute the current unit of work
getCache ( ) : Bravo3\Orm\Services\Cache\EntityCachingInterface Get caching service
getConfig ( ) : Configuration Get Config
getDispatcher ( ) : EventDispatcher Get the event dispatcher, lazy-loading
getDriver ( ) : Bravo3\Orm\Drivers\DriverInterface Get the underlying driver
getKeyScheme ( ) : Bravo3\Orm\KeySchemes\KeySchemeInterface Get the key scheme
getMaintenanceMode ( ) : boolean Get the state of the maintenance mode
getMapper ( ) : Bravo3\Orm\Mappers\MapperInterface Get the entity mapper
getSerialiserMap ( ) : SerialiserMap Get the serialiser mappings
indexedQuery ( IndexedQuery $query, boolean $use_cache = true ) : QueryResult Create a query against a table matching one or more indices
persist ( object $entity, integer $ttl = null ) Persist an entity
purge ( ) Purge the current unit of work, clearing any unexecuted commands
refresh ( object &$entity ) : object Will force a database update of an entity
retrieve ( string $class_name, string $id, boolean $use_cache = true ) : object Retrieve an entity, throwing a NotFoundException if the entity is not found
retrieveByIndex ( string $class_name, string $index_name, string $index_key, boolean $use_cache = true ) : object Retrieve an entity by an index
retrieveEntityOrNew ( string $class_name, integer $id, boolean $use_cache = true ) : object Retrieve an entity, creating a new instance if the entity is not found
retrieveEntityOrNull ( string $class_name, integer $id, boolean $use_cache = true ) : null | object Retrieve an entity, returning null if the entity is not found
setCache ( Bravo3\Orm\Services\Cache\EntityCachingInterface $cache ) Set caching service
setConfig ( Configuration $config ) Set Config
setMaintenanceMode ( boolean $enabled = true ) Enable or disable maintenance mode
setSerialiserMap ( SerialiserMap $serialiser_map ) Set the serialiser map
sortedQuery ( SortedQuery $query, boolean $check_full_set_size = false, boolean $use_cache = true ) : QueryResult Get all foreign entities ordered by a sort column

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

Метод Описание
__construct ( Bravo3\Orm\Drivers\DriverInterface $driver, Bravo3\Orm\Mappers\MapperInterface $mapper, SerialiserMap $serialiser_map = null, Bravo3\Orm\KeySchemes\KeySchemeInterface $key_scheme = null, Configuration $configuration = null, Bravo3\Orm\Services\Cache\EntityCachingInterface $cache = null ) Create a raw entity manager
getIndexManager ( ) : IndexManager Lazy-loading index manager
getQueryManager ( ) : QueryManager Lazy-loading query manager
getRelationshipManager ( ) : RelationshipManager Lazy-loading relationship manager
registerDefaultSubscribers ( ) Register default event subscribers

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

Метод Описание
validateId ( string $id ) Throw an InvalidIdException if an ID contains illegal chars

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

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

Do not construct an entity manager directly or it will lack access interceptors which are responsible for caching and event dispatching.
См. также: EntityManager::build()
protected __construct ( Bravo3\Orm\Drivers\DriverInterface $driver, Bravo3\Orm\Mappers\MapperInterface $mapper, SerialiserMap $serialiser_map = null, Bravo3\Orm\KeySchemes\KeySchemeInterface $key_scheme = null, Configuration $configuration = null, Bravo3\Orm\Services\Cache\EntityCachingInterface $cache = null )
$driver Bravo3\Orm\Drivers\DriverInterface
$mapper Bravo3\Orm\Mappers\MapperInterface
$serialiser_map Bravo3\Orm\Serialisers\SerialiserMap
$key_scheme Bravo3\Orm\KeySchemes\KeySchemeInterface
$configuration Bravo3\Orm\Config\Configuration
$cache Bravo3\Orm\Services\Cache\EntityCachingInterface

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

Add an event listener
public addListener ( string $event_name, callable $listener, integer $priority )
$event_name string
$listener callable
$priority integer

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

Add an event subscriber
public addSubscriber ( Symfony\Component\EventDispatcher\EventSubscriberInterface $subscriber )
$subscriber Symfony\Component\EventDispatcher\EventSubscriberInterface

build() публичный статический Метод

Create a new entity manager
public static build ( Bravo3\Orm\Drivers\DriverInterface $driver, Bravo3\Orm\Mappers\MapperInterface $mapper, SerialiserMap $serialiser_map = null, Bravo3\Orm\KeySchemes\KeySchemeInterface $key_scheme = null, Configuration $configuration = null, Bravo3\Orm\Services\Cache\EntityCachingInterface $cache = null ) : EntityManager
$driver Bravo3\Orm\Drivers\DriverInterface
$mapper Bravo3\Orm\Mappers\MapperInterface
$serialiser_map Bravo3\Orm\Serialisers\SerialiserMap
$key_scheme Bravo3\Orm\KeySchemes\KeySchemeInterface
$configuration Bravo3\Orm\Config\Configuration
$cache Bravo3\Orm\Services\Cache\EntityCachingInterface
Результат EntityManager

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

Any modifications to the entity will be ignored; the persisted state (ID, relationships) of the entity will be deleted. If a new entity is passed to this function, any persisted entity with matching ID & class will be deleted. No error will be raised if a persisted entity is not matched.
public delete ( object $entity )
$entity object

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

Execute the current unit of work
public flush ( )

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

Get caching service
public getCache ( ) : Bravo3\Orm\Services\Cache\EntityCachingInterface
Результат Bravo3\Orm\Services\Cache\EntityCachingInterface

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

Get Config
public getConfig ( ) : Configuration
Результат Bravo3\Orm\Config\Configuration

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

Get the event dispatcher, lazy-loading
public getDispatcher ( ) : EventDispatcher
Результат Symfony\Component\EventDispatcher\EventDispatcher

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

Get the underlying driver
public getDriver ( ) : Bravo3\Orm\Drivers\DriverInterface
Результат Bravo3\Orm\Drivers\DriverInterface

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

Lazy-loading index manager
protected getIndexManager ( ) : IndexManager
Результат IndexManager

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

Get the key scheme
public getKeyScheme ( ) : Bravo3\Orm\KeySchemes\KeySchemeInterface
Результат Bravo3\Orm\KeySchemes\KeySchemeInterface

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

Get the state of the maintenance mode
public getMaintenanceMode ( ) : boolean
Результат boolean

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

Get the entity mapper
public getMapper ( ) : Bravo3\Orm\Mappers\MapperInterface
Результат Bravo3\Orm\Mappers\MapperInterface

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

Lazy-loading query manager
protected getQueryManager ( ) : QueryManager
Результат QueryManager

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

Lazy-loading relationship manager
protected getRelationshipManager ( ) : RelationshipManager
Результат RelationshipManager

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

Get the serialiser mappings
public getSerialiserMap ( ) : SerialiserMap
Результат Bravo3\Orm\Serialisers\SerialiserMap

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

Create a query against a table matching one or more indices
public indexedQuery ( IndexedQuery $query, boolean $use_cache = true ) : QueryResult
$query Bravo3\Orm\Query\IndexedQuery
$use_cache boolean
Результат Bravo3\Orm\Query\QueryResult

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

Persist an entity
public persist ( object $entity, integer $ttl = null )
$entity object Entity object to persist
$ttl integer Optional TTL if the driver supports it, seconds past current time

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

Purge the current unit of work, clearing any unexecuted commands
public purge ( )

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

This will also convert a fresh entity to an OrmProxyInterface.
public refresh ( object &$entity ) : object
$entity object
Результат object

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

Register default event subscribers
protected registerDefaultSubscribers ( )

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

Retrieve an entity, throwing a NotFoundException if the entity is not found
public retrieve ( string $class_name, string $id, boolean $use_cache = true ) : object
$class_name string
$id string
$use_cache boolean
Результат object

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

Retrieve an entity by an index
public retrieveByIndex ( string $class_name, string $index_name, string $index_key, boolean $use_cache = true ) : object
$class_name string
$index_name string
$index_key string
$use_cache boolean
Результат object

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

NB: The entity must be able to be constructed without constructor arguments.
public retrieveEntityOrNew ( string $class_name, integer $id, boolean $use_cache = true ) : object
$class_name string
$id integer
$use_cache boolean
Результат object

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

Retrieve an entity, returning null if the entity is not found
public retrieveEntityOrNull ( string $class_name, integer $id, boolean $use_cache = true ) : null | object
$class_name string
$id integer
$use_cache boolean
Результат null | object

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

Set caching service
public setCache ( Bravo3\Orm\Services\Cache\EntityCachingInterface $cache )
$cache Bravo3\Orm\Services\Cache\EntityCachingInterface

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

Set Config
public setConfig ( Configuration $config )
$config Bravo3\Orm\Config\Configuration

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

Enable or disable maintenance mode
public setMaintenanceMode ( boolean $enabled = true )
$enabled boolean

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

Set the serialiser map
public setSerialiserMap ( SerialiserMap $serialiser_map )
$serialiser_map Bravo3\Orm\Serialisers\SerialiserMap

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

If you have applied a limit to the query but need to know the full size of the unfiltered set, you must set $check_full_set_size to true to gather this information at the expense of a second database query.
public sortedQuery ( SortedQuery $query, boolean $check_full_set_size = false, boolean $use_cache = true ) : QueryResult
$query Bravo3\Orm\Query\SortedQuery
$check_full_set_size boolean
$use_cache boolean
Результат Bravo3\Orm\Query\QueryResult

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

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

protected EntityCachingInterface,Bravo3\Orm\Services\Cache $cache
Результат Bravo3\Orm\Services\Cache\EntityCachingInterface

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

protected Configuration,Bravo3\Orm\Config $config
Результат Bravo3\Orm\Config\Configuration

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

protected EventDispatcher,Symfony\Component\EventDispatcher $dispatcher
Результат Symfony\Component\EventDispatcher\EventDispatcher

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

protected DriverInterface,Bravo3\Orm\Drivers $driver
Результат Bravo3\Orm\Drivers\DriverInterface

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

protected IndexManager,Bravo3\Orm\Services $index_manager
Результат IndexManager

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

protected KeySchemeInterface,Bravo3\Orm\KeySchemes $key_scheme
Результат Bravo3\Orm\KeySchemes\KeySchemeInterface

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

protected bool $maintenance_mode
Результат boolean

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

protected MapperInterface,Bravo3\Orm\Mappers $mapper
Результат Bravo3\Orm\Mappers\MapperInterface

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

protected QueryManager,Bravo3\Orm\Services $query_manager
Результат QueryManager

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

protected RelationshipManager,Bravo3\Orm\Services $relationship_manager
Результат RelationshipManager

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

protected SerialiserMap,Bravo3\Orm\Serialisers $serialiser_map
Результат Bravo3\Orm\Serialisers\SerialiserMap