‪TYPO3CMS  9.5
Public Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager Class Reference
Inheritance diagram for TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager:
TYPO3\CMS\Extbase\Persistence\PersistenceManagerInterface TYPO3\CMS\Core\SingletonInterface

Public Member Functions

 injectQueryFactory (\TYPO3\CMS\Extbase\Persistence\Generic\QueryFactoryInterface $queryFactory)
 
 injectBackend (\TYPO3\CMS\Extbase\Persistence\Generic\BackendInterface $backend)
 
 injectPersistenceSession (\TYPO3\CMS\Extbase\Persistence\Generic\Session $persistenceSession)
 
 __construct ()
 
 registerRepositoryClassName ($className)
 
int getObjectCountByQuery (QueryInterface $query)
 
array getObjectDataByQuery (QueryInterface $query)
 
mixed getIdentifierByObject ($object)
 
object getObjectByIdentifier ($identifier, $objectType=null, $useLazyLoading=false)
 
 persistAll ()
 
QueryInterface createQueryForType ($type)
 
 add ($object)
 
 remove ($object)
 
 update ($object)
 
 injectSettings (array $settings)
 
 initializeObject ()
 
 clearState ()
 
bool isNewObject ($object)
 
 registerNewObject ($object)
 
 convertObjectToIdentityArray ($object)
 
 convertObjectsToIdentityArrays (array $array)
 
 tearDown ()
 

Protected Attributes

array $newObjects = array( )
 
ObjectStorage $changedObjects
 
ObjectStorage $addedObjects
 
ObjectStorage $removedObjects
 
TYPO3 CMS Extbase Persistence Generic QueryFactoryInterface $queryFactory
 
TYPO3 CMS Extbase Persistence Generic BackendInterface $backend
 
TYPO3 CMS Extbase Persistence Generic Session $persistenceSession
 

Detailed Description

The Extbase Persistence Manager

Definition at line 23 of file PersistenceManager.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager::__construct ( )

Create new instance

only to be used within Extbase, not part of TYPO3 Core API.

Definition at line 84 of file PersistenceManager.php.

Member Function Documentation

◆ add()

TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager::add (   $object)

Adds an object to the persistence.

Parameters
object$object‪The object to add

Implements TYPO3\CMS\Extbase\Persistence\PersistenceManagerInterface.

Definition at line 196 of file PersistenceManager.php.

◆ clearState()

TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager::clearState ( )

Clears the in-memory state of the persistence.

Managed instances become detached, any fetches will return data directly from the persistence "backend".

Exceptions

Implements TYPO3\CMS\Extbase\Persistence\PersistenceManagerInterface.

Definition at line 259 of file PersistenceManager.php.

◆ convertObjectsToIdentityArrays()

TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager::convertObjectsToIdentityArrays ( array  $array)

Recursively iterates through the given array and turns objects into arrays containing the identity of the domain object.

Exceptions

Implements TYPO3\CMS\Extbase\Persistence\PersistenceManagerInterface.

Definition at line 316 of file PersistenceManager.php.

◆ convertObjectToIdentityArray()

TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager::convertObjectToIdentityArray (   $object)

Converts the given object into an array containing the identity of the domain object.

Parameters
object$object‪The object to be converted
Exceptions
Exception

Implements TYPO3\CMS\Extbase\Persistence\PersistenceManagerInterface.

Definition at line 303 of file PersistenceManager.php.

◆ createQueryForType()

QueryInterface TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager::createQueryForType (   $type)

Return a query object for the given type.

Parameters
string$type
Returns
‪QueryInterface

only to be used within Extbase, not part of TYPO3 Core API.

Implements TYPO3\CMS\Extbase\Persistence\PersistenceManagerInterface.

Definition at line 186 of file PersistenceManager.php.

◆ getIdentifierByObject()

mixed TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager::getIdentifierByObject (   $object)

Returns the (internal) identifier for the object, if it is known to the backend. Otherwise NULL is returned.

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.

Parameters
object$object
Returns
‪mixed The identifier for the object if it is known, or NULL

Implements TYPO3\CMS\Extbase\Persistence\PersistenceManagerInterface.

Definition at line 134 of file PersistenceManager.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager\registerNewObject().

◆ getObjectByIdentifier()

object TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager::getObjectByIdentifier (   $identifier,
  $objectType = null,
  $useLazyLoading = false 
)

Returns the object with the (internal) identifier, if it is known to the backend. Otherwise NULL is returned.

Parameters
mixed$identifier
string$objectType
bool$useLazyLoading‪Set to TRUE if you want to use lazy loading for this object
Returns
‪object The object for the identifier if it is known, or NULL

Implements TYPO3\CMS\Extbase\Persistence\PersistenceManagerInterface.

Definition at line 148 of file PersistenceManager.php.

◆ getObjectCountByQuery()

int TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager::getObjectCountByQuery ( QueryInterface  $query)

Returns the number of records matching the query.

Parameters
QueryInterface$query
Returns
‪int

Implements TYPO3\CMS\Extbase\Persistence\PersistenceManagerInterface.

Definition at line 107 of file PersistenceManager.php.

◆ getObjectDataByQuery()

array TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager::getObjectDataByQuery ( QueryInterface  $query)

Returns the object data matching the $query.

Parameters
QueryInterface$query
Returns
‪array

Implements TYPO3\CMS\Extbase\Persistence\PersistenceManagerInterface.

Definition at line 118 of file PersistenceManager.php.

◆ initializeObject()

TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager::initializeObject ( )

Initializes the persistence manager, called by Extbase.

only to be used within Extbase, not part of TYPO3 Core API.

Definition at line 245 of file PersistenceManager.php.

◆ injectBackend()

TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager::injectBackend ( \TYPO3\CMS\Extbase\Persistence\Generic\BackendInterface  $backend)
Parameters
\TYPO3\CMS\Extbase\Persistence\Generic\BackendInterface$backend

only to be used within Extbase, not part of TYPO3 Core API.

Definition at line 66 of file PersistenceManager.php.

References TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager\$backend.

◆ injectPersistenceSession()

TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager::injectPersistenceSession ( \TYPO3\CMS\Extbase\Persistence\Generic\Session  $persistenceSession)
Parameters
\TYPO3\CMS\Extbase\Persistence\Generic\Session$persistenceSession

only to be used within Extbase, not part of TYPO3 Core API.

Definition at line 75 of file PersistenceManager.php.

References TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager\$persistenceSession.

◆ injectQueryFactory()

TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager::injectQueryFactory ( \TYPO3\CMS\Extbase\Persistence\Generic\QueryFactoryInterface  $queryFactory)
Parameters
\TYPO3\CMS\Extbase\Persistence\Generic\QueryFactoryInterface$queryFactory

only to be used within Extbase, not part of TYPO3 Core API.

Definition at line 57 of file PersistenceManager.php.

References TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager\$queryFactory.

◆ injectSettings()

TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager::injectSettings ( array  $settings)

Injects the Extbase settings, called by Extbase.

Parameters
array$settings
Exceptions

Implements TYPO3\CMS\Extbase\Persistence\PersistenceManagerInterface.

Definition at line 236 of file PersistenceManager.php.

◆ isNewObject()

bool TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager::isNewObject (   $object)

Checks if the given object has ever been persisted.

Parameters
object$object‪The object to check
Returns
‪bool TRUE if the object is new, FALSE if the object exists in the persistence session

Implements TYPO3\CMS\Extbase\Persistence\PersistenceManagerInterface.

Definition at line 274 of file PersistenceManager.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager\update().

◆ persistAll()

TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager::persistAll ( )

Commits new objects and changes to objects in the current persistence session into the backend.

Implements TYPO3\CMS\Extbase\Persistence\PersistenceManagerInterface.

Definition at line 163 of file PersistenceManager.php.

◆ registerNewObject()

TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager::registerNewObject (   $object)

Registers an object which has been created or cloned during this request.

A "new" object does not necessarily have to be known by any repository or be persisted in the end.

Objects registered with this method must be known to the getObjectByIdentifier() method.

Parameters
object$object‪The new object to register

only to be used within Extbase, not part of TYPO3 Core API.

Definition at line 291 of file PersistenceManager.php.

References TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager\getIdentifierByObject().

◆ registerRepositoryClassName()

TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager::registerRepositoryClassName (   $className)

Registers a repository

Parameters
string$className‪The class name of the repository to be registered

only to be used within Extbase, not part of TYPO3 Core API.

Implements TYPO3\CMS\Extbase\Persistence\PersistenceManagerInterface.

Definition at line 97 of file PersistenceManager.php.

◆ remove()

TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager::remove (   $object)

Removes an object to the persistence.

Parameters
object$object‪The object to remove

Implements TYPO3\CMS\Extbase\Persistence\PersistenceManagerInterface.

Definition at line 207 of file PersistenceManager.php.

◆ tearDown()

TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager::tearDown ( )

Tear down the persistence

This method is called in functional tests to reset the storage between tests. The implementation is optional and depends on the underlying persistence backend.

only to be used within Extbase, not part of TYPO3 Core API.

Definition at line 328 of file PersistenceManager.php.

◆ update()

TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager::update (   $object)

Update an object in the persistence.

Parameters
object$object‪The modified object
Exceptions

Implements TYPO3\CMS\Extbase\Persistence\PersistenceManagerInterface.

Definition at line 222 of file PersistenceManager.php.

References TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager\isNewObject().

Member Data Documentation

◆ $addedObjects

ObjectStorage TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager::$addedObjects
protected

Definition at line 35 of file PersistenceManager.php.

◆ $backend

TYPO3 CMS Extbase Persistence Generic BackendInterface TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager::$backend
protected

Definition at line 47 of file PersistenceManager.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager\injectBackend().

◆ $changedObjects

ObjectStorage TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager::$changedObjects
protected

Definition at line 31 of file PersistenceManager.php.

◆ $newObjects

array TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager::$newObjects = array( )
protected

Definition at line 27 of file PersistenceManager.php.

◆ $persistenceSession

TYPO3 CMS Extbase Persistence Generic Session TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager::$persistenceSession
protected

Definition at line 51 of file PersistenceManager.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager\injectPersistenceSession().

◆ $queryFactory

TYPO3 CMS Extbase Persistence Generic QueryFactoryInterface TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager::$queryFactory
protected

Definition at line 43 of file PersistenceManager.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager\injectQueryFactory().

◆ $removedObjects

ObjectStorage TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager::$removedObjects
protected

Definition at line 39 of file PersistenceManager.php.