PersistenceManagerInterface

interface \TYPO3\CMS\Extbase\Persistence\PersistenceManagerInterface

The Extbase Persistence Manager interface

Table of Contents

Methods

add()  : mixed
Adds an object to the persistence.
clearState()  : mixed
Clears the in-memory state of the persistence.
createQueryForType()  : QueryInterface
Return a query object for the given type.
getIdentifierByObject()  : mixed
Returns the (internal) identifier for the object, if it is known to the backend. Otherwise NULL is returned.
getObjectByIdentifier()  : object|null
Returns the object with the (internal) identifier, if it is known to the backend. Otherwise NULL is returned.
getObjectCountByQuery()  : int
Returns the number of records matching the query.
getObjectDataByQuery()  : array
Returns the object data matching the $query.
isNewObject()  : bool
Checks if the given object has ever been persisted.
persistAll()  : mixed
Commits new objects and changes to objects in the current persistence session into the backend
registerRepositoryClassName()  : mixed
Registers a repository
remove()  : mixed
Removes an object to the persistence.
update()  : mixed
Update an object in the persistence.

Methods

add()

Adds an object to the persistence.

public add(object $object) : mixed

Parameters

$object : object

The object to add

clearState()

Clears the in-memory state of the persistence.

public clearState() : mixed

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

getIdentifierByObject()

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

public getIdentifierByObject(object $object) : mixed

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

Return values

mixed —

The identifier for the object if it is known, or NULL

getObjectByIdentifier()

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 ][, bool $useLazyLoading = false ]) : object|null

Parameters

$identifier : mixed
$objectType : string = null
$useLazyLoading : bool = false

Set to TRUE if you want to use lazy loading for this object

Return values

object|null —

The object for the identifier if it is known, or NULL

getObjectCountByQuery()

Returns the number of records matching the query.

public getObjectCountByQuery(QueryInterface $query) : int

Parameters

$query : QueryInterface

Return values

int

isNewObject()

Checks if the given object has ever been persisted.

public isNewObject(object $object) : bool

Parameters

$object : object

The object to check

Return values

bool —

TRUE if the object is new, FALSE if the object exists in the repository

persistAll()

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

public persistAll() : mixed

registerRepositoryClassName()

Registers a repository

public registerRepositoryClassName(string $className) : mixed

Parameters

$className : string

The class name of the repository to be registered

remove()

Removes an object to the persistence.

public remove(object $object) : mixed

Parameters

$object : object

The object to remove

update()

Update an object in the persistence.

public update(object $object) : mixed

Parameters

$object : object

The modified object

Tags

throws
UnknownObjectException
On this page