TYPO3\CMS\Extbase\Persistence\Generic\Session Class Reference

Inheritance diagram for TYPO3\CMS\Extbase\Persistence\Generic\Session:

Public Member Functions
	injectReflectionService (\TYPO3\CMS\Extbase\Reflection\ReflectionService $reflectionService)
	__construct ()
	registerReconstitutedEntity ($entity, array $entityData=[])
	replaceReconstitutedEntity ($oldEntity, $newEntity)
	unregisterReconstitutedEntity ($entity)
	getReconstitutedEntities ()
	isReconstitutedEntity ($entity)
	hasObject ($object)
	hasIdentifier ($identifier, $className)
	getObjectByIdentifier ($identifier, $className)
	getIdentifierByObject ($object)
	registerObject ($object, $identifier)
	unregisterObject ($object)
	destroy ()

Protected Attributes
	$reconstitutedEntities
	$reconstitutedEntitiesData = []
	$objectMap
	$identifierMap = []
	$reflectionService

Detailed Description

The persistence session - acts as a Unit of Work for Extbase persistence framework.

Definition at line 22 of file Session.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Extbase\Persistence\Generic\Session::__construct

(

)

Constructs a new Session

Definition at line 66 of file Session.php.

Member Function Documentation

destroy()

TYPO3\CMS\Extbase\Persistence\Generic\Session::destroy

(

)

Destroy the state of the persistence session and reset all internal data.

Returns

void

Definition at line 223 of file Session.php.

getIdentifierByObject()

TYPO3\CMS\Extbase\Persistence\Generic\Session::getIdentifierByObject

(

$object

)

Returns the identifier for the given object from the session, if the object was registered.

Parameters

object

$object

Returns

string

Definition at line 184 of file Session.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Session\hasObject().

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Session\unregisterReconstitutedEntity().

getObjectByIdentifier()

TYPO3\CMS\Extbase\Persistence\Generic\Session::getObjectByIdentifier	(		$identifier,
			$className
	)

Returns the object for the given identifier

Parameters

string	$identifier
string	$className

Returns

object

Definition at line 170 of file Session.php.

getReconstitutedEntities()

TYPO3\CMS\Extbase\Persistence\Generic\Session::getReconstitutedEntities

(

)

Returns all objects which have been registered as reconstituted

Returns

ObjectStorage All reconstituted objects

Definition at line 120 of file Session.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Session\$reconstitutedEntities.

hasIdentifier()

TYPO3\CMS\Extbase\Persistence\Generic\Session::hasIdentifier	(		$identifier,
			$className
	)

Checks whether the given identifier is known to the identity map

Parameters

string	$identifier
string	$className

Returns

bool

Definition at line 157 of file Session.php.

hasObject()

TYPO3\CMS\Extbase\Persistence\Generic\Session::hasObject

(

$object

)

Checks whether the given object is known to the identity map

Parameters

object

$object

Returns

bool

Definition at line 145 of file Session.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Session\getIdentifierByObject().

injectReflectionService()

TYPO3\CMS\Extbase\Persistence\Generic\Session::injectReflectionService

(

\TYPO3\CMS\Extbase\Reflection\ReflectionService

$reflectionService

)

Parameters

\TYPO3\CMS\Extbase\Reflection\ReflectionService

$reflectionService

Definition at line 58 of file Session.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Session\$reflectionService.

isReconstitutedEntity()

TYPO3\CMS\Extbase\Persistence\Generic\Session::isReconstitutedEntity

(

$entity

)

Tells whether the given object is a reconstituted entity.

Parameters

object

$entity

Returns

bool

Definition at line 131 of file Session.php.

registerObject()

TYPO3\CMS\Extbase\Persistence\Generic\Session::registerObject	(		$object,
			$identifier
	)

Register an identifier for an object

Parameters

object	$object
string	$identifier

Definition at line 199 of file Session.php.

registerReconstitutedEntity()

TYPO3\CMS\Extbase\Persistence\Generic\Session::registerReconstitutedEntity	(		$entity,
		array	$entityData = []
	)

Registers data for a reconstituted object.

$entityData format is described in "Documentation/PersistenceFramework object data format.txt"

Parameters

object	$entity
array	$entityData

Returns

void

Definition at line 82 of file Session.php.

replaceReconstitutedEntity()

TYPO3\CMS\Extbase\Persistence\Generic\Session::replaceReconstitutedEntity	(		$oldEntity,
			$newEntity
	)

Replace a reconstituted object, leaves the clean data unchanged.

Parameters

object	$oldEntity
object	$newEntity

Returns

void

Definition at line 95 of file Session.php.

unregisterObject()

TYPO3\CMS\Extbase\Persistence\Generic\Session::unregisterObject

(

$object

)

Unregister an object

Parameters

object

$object

Returns

void

Definition at line 211 of file Session.php.

unregisterReconstitutedEntity()

TYPO3\CMS\Extbase\Persistence\Generic\Session::unregisterReconstitutedEntity

(

$entity

)

Unregisters data for a reconstituted object

Parameters

object

$entity

Returns

void

Definition at line 107 of file Session.php.

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

Member Data Documentation

$identifierMap

TYPO3\CMS\Extbase\Persistence\Generic\Session::$identifierMap = []

protected

Definition at line 48 of file Session.php.

$objectMap

TYPO3\CMS\Extbase\Persistence\Generic\Session::$objectMap

protected

Definition at line 43 of file Session.php.

$reconstitutedEntities

TYPO3\CMS\Extbase\Persistence\Generic\Session::$reconstitutedEntities

protected

Definition at line 29 of file Session.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Session\getReconstitutedEntities().

$reconstitutedEntitiesData

TYPO3\CMS\Extbase\Persistence\Generic\Session::$reconstitutedEntitiesData = []

protected

Definition at line 38 of file Session.php.

$reflectionService

TYPO3\CMS\Extbase\Persistence\Generic\Session::$reflectionService

protected

Definition at line 53 of file Session.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Session\injectReflectionService().