TYPO3\CMS\Core\DataHandling\Model\RecordState Class Reference

Public Member Functions
	__construct (EntityContext $context, EntityPointer $node, EntityUidPointer $subject)
	getContext ()
	getNode ()
	getSubject ()
EntityPointerLink	getLanguageLink ()
EntityPointerLink	getVersionLink ()
	isNew ()
	resolveNodeIdentifier ()
	resolveNodeAggregateIdentifier ()

Static Public Member Functions
static	withLanguageLink (?EntityPointerLink $languageLink)
static	withVersionLink (?EntityPointerLink $versionLink)

Protected Attributes
EntityContext	$context
EntityPointer	$node
EntityUidPointer	$subject
EntityPointerLink null	$languageLink
EntityPointerLink null	$versionLink

Detailed Description

A RecordState is an abstract description of a record that consists of

• ‪an EntityContext describing the "variant" of a record
• ‪an EntityPointer that describes the node where the record is stored
• ‪an EntityUidPointer of the record the RecordState instance represents

Instances of this class are created by the RecordStateFactory.

Definition at line 31 of file RecordState.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Core\DataHandling\Model\RecordState::__construct	(	EntityContext	$context,
		EntityPointer	$node,
		EntityUidPointer	$subject
	)

Definition at line 53 of file RecordState.php.

References TYPO3\CMS\Core\DataHandling\Model\RecordState\$context, TYPO3\CMS\Core\DataHandling\Model\RecordState\$node, and TYPO3\CMS\Core\DataHandling\Model\RecordState\$subject.

Member Function Documentation

getContext()

TYPO3\CMS\Core\DataHandling\Model\RecordState::getContext

(

)

Definition at line 60 of file RecordState.php.

References TYPO3\CMS\Core\DataHandling\Model\RecordState\$context.

Referenced by TYPO3\CMS\Core\DataHandling\SlugHelper\isUniqueInPid(), TYPO3\CMS\Core\DataHandling\SlugHelper\isUniqueInSite(), and TYPO3\CMS\Core\DataHandling\SlugHelper\isUniqueInTable().

getLanguageLink()

EntityPointerLink TYPO3\CMS\Core\DataHandling\Model\RecordState::getLanguageLink

(

)

Returns

‪EntityPointerLink

Definition at line 78 of file RecordState.php.

References TYPO3\CMS\Core\DataHandling\Model\RecordState\$languageLink.

getNode()

TYPO3\CMS\Core\DataHandling\Model\RecordState::getNode

(

)

Definition at line 65 of file RecordState.php.

References TYPO3\CMS\Core\DataHandling\Model\RecordState\$node.

Referenced by TYPO3\CMS\Core\DataHandling\SlugHelper\isUniqueInSite().

getSubject()

TYPO3\CMS\Core\DataHandling\Model\RecordState::getSubject

(

)

Definition at line 70 of file RecordState.php.

References TYPO3\CMS\Core\DataHandling\Model\RecordState\$subject.

Referenced by TYPO3\CMS\Core\DataHandling\SlugHelper\isUniqueInPid(), TYPO3\CMS\Core\DataHandling\SlugHelper\isUniqueInSite(), and TYPO3\CMS\Core\DataHandling\SlugHelper\isUniqueInTable().

getVersionLink()

EntityPointerLink TYPO3\CMS\Core\DataHandling\Model\RecordState::getVersionLink

(

)

Returns

‪EntityPointerLink

Definition at line 99 of file RecordState.php.

References TYPO3\CMS\Core\DataHandling\Model\RecordState\$versionLink.

Referenced by TYPO3\CMS\Core\DataHandling\SlugHelper\applyWorkspaceConstraint().

isNew()

TYPO3\CMS\Core\DataHandling\Model\RecordState::isNew

(

)

Definition at line 117 of file RecordState.php.

References TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger().

resolveNodeAggregateIdentifier()

TYPO3\CMS\Core\DataHandling\Model\RecordState::resolveNodeAggregateIdentifier

(

)

Resolves node identifier used as aggregate for current subject. For translated pages that would result in the uid of the outer-most language parent page, for pages it's the identifier of the current subject, otherwise it's the pid of the current subject.

Example:

• ‪pages: uid: 10, pid: 5, sys_language_uid: 0, l10n_parent: 0 -> returns 10
• ‪pages: uid: 11, pid: 5, sys_language_uid: 1, l10n_parent: 10 -> returns 10
• ‪pages in version, return online page ID
• ‪other: uid: 12, pid: 10 -> returns 10

Definition at line 157 of file RecordState.php.

Referenced by TYPO3\CMS\Core\DataHandling\SlugHelper\isUniqueInSite().

resolveNodeIdentifier()

TYPO3\CMS\Core\DataHandling\Model\RecordState::resolveNodeIdentifier

(

)

Resolves node identifier (pid) of current subject. For translated pages that would result in the uid of the outer-most language parent page otherwise it's the pid of the current subject.

Example:

• ‪pages: uid: 10, pid: 5, sys_language_uid: 0, l10n_parent: 0 -> returns 5
• ‪pages: uid: 11, pid: 5, sys_language_uid: 1, l10n_parent: 10 -> returns 10
• ‪other: uid: 12, pid: 10 -> returns 10

Definition at line 134 of file RecordState.php.

Referenced by TYPO3\CMS\Core\DataHandling\SlugHelper\isUniqueInPid().

withLanguageLink()

static TYPO3\CMS\Core\DataHandling\Model\RecordState::withLanguageLink ( ?EntityPointerLink  $languageLink )

static

Returns

‪static

Definition at line 86 of file RecordState.php.

References TYPO3\CMS\Core\DataHandling\Model\RecordState\$languageLink.

withVersionLink()

static TYPO3\CMS\Core\DataHandling\Model\RecordState::withVersionLink ( ?EntityPointerLink  $versionLink )

static

Returns

‪static

Definition at line 107 of file RecordState.php.

References TYPO3\CMS\Core\DataHandling\Model\RecordState\$versionLink.

Member Data Documentation

$context

EntityContext TYPO3\CMS\Core\DataHandling\Model\RecordState::$context

protected

Definition at line 35 of file RecordState.php.

Referenced by TYPO3\CMS\Core\DataHandling\Model\RecordState\__construct(), and TYPO3\CMS\Core\DataHandling\Model\RecordState\getContext().

$languageLink

EntityPointerLink null TYPO3\CMS\Core\DataHandling\Model\RecordState::$languageLink

protected

Definition at line 47 of file RecordState.php.

Referenced by TYPO3\CMS\Core\DataHandling\Model\RecordState\getLanguageLink(), and TYPO3\CMS\Core\DataHandling\Model\RecordState\withLanguageLink().

$node

EntityPointer TYPO3\CMS\Core\DataHandling\Model\RecordState::$node

protected

Definition at line 39 of file RecordState.php.

Referenced by TYPO3\CMS\Core\DataHandling\Model\RecordState\__construct(), and TYPO3\CMS\Core\DataHandling\Model\RecordState\getNode().

$subject

EntityUidPointer TYPO3\CMS\Core\DataHandling\Model\RecordState::$subject

protected

Definition at line 43 of file RecordState.php.

Referenced by TYPO3\CMS\Core\DataHandling\Model\RecordState\__construct(), and TYPO3\CMS\Core\DataHandling\Model\RecordState\getSubject().

$versionLink

EntityPointerLink null TYPO3\CMS\Core\DataHandling\Model\RecordState::$versionLink

protected

Definition at line 51 of file RecordState.php.

Referenced by TYPO3\CMS\Core\DataHandling\Model\RecordState\getVersionLink(), and TYPO3\CMS\Core\DataHandling\Model\RecordState\withVersionLink().