PHP Class Neos\Flow\Persistence\Doctrine\PersistenceManager

Inheritance: extends Neos\Flow\Persistence\AbstractPersistenceManager
ファイルを表示 Open project: neos/flow-development-collection Class Usage Examples

Protected Properties

Property Type Description
$entityManager Doctrine\Common\Persistence\ObjectManager
$reflectionService Neos\Flow\Reflection\ReflectionService
$systemLogger Neos\Flow\Log\SystemLoggerInterface
$validatorResolver Neos\Flow\Validation\ValidatorResolver

Public Methods

Method Description
add ( object $object ) : void Adds an object to the persistence.
clearState ( ) : void Clears the in-memory state of the persistence.
compile ( ) : boolean Called from functional tests, creates/updates database tables and compiles proxies.
createQueryForType ( string $type ) : Query Return a query object for the given type.
getIdentifierByObject ( object $object ) : mixed Returns the (internal) identifier for the object, if it is known to the backend. Otherwise NULL is returned.
getObjectByIdentifier ( mixed $identifier, string $objectType = null, boolean $useLazyLoading = false ) : object Returns the object with the (internal) identifier, if it is known to the backend. Otherwise NULL is returned.
hasUnpersistedChanges ( ) : boolean Gives feedback if the persistence Manager has unpersisted changes.
initializeObject ( ) : void Initializes the persistence manager, called by Flow.
isConnected ( ) : boolean Returns TRUE, if an active connection to the persistence backend has been established, e.g. entities can be persisted.
isNewObject ( object $object ) : boolean Checks if the given object has ever been persisted.
onFlush ( Doctrine\ORM\Event\OnFlushEventArgs $eventArgs ) : void An onFlush event listener used to validate entities upon persistence.
persistAll ( boolean $onlyWhitelistedObjects = false ) : void Commits new objects and changes to objects in the current persistence session into the backend
remove ( object $object ) : void Removes an object to the persistence.
tearDown ( ) : void Called after a functional test in Flow, dumps everything in the database.
update ( object $object ) : void Update an object in the persistence.

Protected Methods

Method Description
emitAllObjectsPersisted ( ) : void Signals that all persistAll() has been executed successfully.
validateObject ( object $object, SplObjectStorage $validatedInstancesContainer ) : void Validates the given object and throws an exception if validation fails.

Method Details

add() public method

Adds an object to the persistence.
public add ( object $object ) : void
$object object The object to add
return void

clearState() public method

Managed instances become detached, any fetches will return data directly from the persistence "backend".
public clearState ( ) : void
return void

compile() public method

Called from functional tests, creates/updates database tables and compiles proxies.
public compile ( ) : boolean
return boolean

createQueryForType() public method

Return a query object for the given type.
public createQueryForType ( string $type ) : Query
$type string
return Query

emitAllObjectsPersisted() protected method

Signals that all persistAll() has been executed successfully.
protected emitAllObjectsPersisted ( ) : void
return void

getIdentifierByObject() public method

Note: this returns an identifier even if the object has not been persisted in case of AOP-managed entities. Use isNewObject() if you need to distinguish those cases.
public getIdentifierByObject ( object $object ) : mixed
$object object
return mixed The identifier for the object if it is known, or NULL

getObjectByIdentifier() public method

Returns the object with the (internal) identifier, if it is known to the backend. Otherwise NULL is returned.
public getObjectByIdentifier ( mixed $identifier, string $objectType = null, boolean $useLazyLoading = false ) : object
$identifier mixed
$objectType string
$useLazyLoading boolean Set to TRUE if you want to use lazy loading for this object
return object The object for the identifier if it is known, or NULL

hasUnpersistedChanges() public method

This is primarily used to inform the user if he tries to save data in an unsafe request.
public hasUnpersistedChanges ( ) : boolean
return boolean

initializeObject() public method

Initializes the persistence manager, called by Flow.
public initializeObject ( ) : void
return void

isConnected() public method

Returns TRUE, if an active connection to the persistence backend has been established, e.g. entities can be persisted.
public isConnected ( ) : boolean
return boolean TRUE, if an connection has been established, FALSE if add object will not be persisted by the backend

isNewObject() public method

Checks if the given object has ever been persisted.
public isNewObject ( object $object ) : boolean
$object object The object to check
return boolean TRUE if the object is new, FALSE if the object exists in the repository

onFlush() public method

An onFlush event listener used to validate entities upon persistence.
public onFlush ( Doctrine\ORM\Event\OnFlushEventArgs $eventArgs ) : void
$eventArgs Doctrine\ORM\Event\OnFlushEventArgs
return void

persistAll() public method

Commits new objects and changes to objects in the current persistence session into the backend
public persistAll ( boolean $onlyWhitelistedObjects = false ) : void
$onlyWhitelistedObjects boolean If TRUE an exception will be thrown if there are scheduled updates/deletes or insertions for objects that are not "whitelisted" (see AbstractPersistenceManager::whitelistObject())
return void

remove() public method

Removes an object to the persistence.
public remove ( object $object ) : void
$object object The object to remove
return void

tearDown() public method

Called after a functional test in Flow, dumps everything in the database.
public tearDown ( ) : void
return void

update() public method

Update an object in the persistence.
public update ( object $object ) : void
$object object The modified object
return void

validateObject() protected method

Validates the given object and throws an exception if validation fails.
protected validateObject ( object $object, SplObjectStorage $validatedInstancesContainer ) : void
$object object
$validatedInstancesContainer SplObjectStorage
return void

Property Details

$entityManager protected_oe property

protected ObjectManager,Doctrine\Common\Persistence $entityManager
return Doctrine\Common\Persistence\ObjectManager

$reflectionService protected_oe property

protected ReflectionService,Neos\Flow\Reflection $reflectionService
return Neos\Flow\Reflection\ReflectionService

$systemLogger protected_oe property

protected SystemLoggerInterface,Neos\Flow\Log $systemLogger
return Neos\Flow\Log\SystemLoggerInterface

$validatorResolver protected_oe property

protected ValidatorResolver,Neos\Flow\Validation $validatorResolver
return Neos\Flow\Validation\ValidatorResolver