‪TYPO3CMS  10.4
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Core\DataHandling\Model\RecordState Class Reference

Public Member Functions

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

Static Public Member Functions

static withLanguageLink (?EntityPointerLink $languageLink)
 
static withVersionLink (?EntityPointerLink $versionLink)
 

Protected Attributes

EntityContext $context
 
EntityPointer $node
 
EntityUidPointer $subject
 
EntityPointerLink $languageLink
 
EntityPointerLink $versionLink
 

Detailed Description

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

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 
)
Parameters
EntityContext$context
EntityPointer$node
EntityUidPointer$subject

Definition at line 58 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()

EntityContext TYPO3\CMS\Core\DataHandling\Model\RecordState::getContext ( )
Returns
‪EntityContext

Definition at line 68 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 92 of file RecordState.php.

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

◆ getNode()

EntityPointer TYPO3\CMS\Core\DataHandling\Model\RecordState::getNode ( )
Returns
‪EntityPointer

Definition at line 76 of file RecordState.php.

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

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

◆ getSubject()

EntityUidPointer TYPO3\CMS\Core\DataHandling\Model\RecordState::getSubject ( )
Returns
‪EntityUidPointer

Definition at line 84 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 114 of file RecordState.php.

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

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

◆ isNew()

bool TYPO3\CMS\Core\DataHandling\Model\RecordState::isNew ( )
Returns
‪bool

Definition at line 136 of file RecordState.php.

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

◆ resolveNodeAggregateIdentifier()

string 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
Returns
‪string

Definition at line 180 of file RecordState.php.

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

◆ resolveNodeIdentifier()

string 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
Returns
‪string

Definition at line 155 of file RecordState.php.

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

◆ withLanguageLink()

static TYPO3\CMS\Core\DataHandling\Model\RecordState::withLanguageLink ( ?EntityPointerLink  $languageLink)
static
Parameters
EntityPointerLink | null$languageLink
Returns
‪static

Definition at line 101 of file RecordState.php.

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

◆ withVersionLink()

static TYPO3\CMS\Core\DataHandling\Model\RecordState::withVersionLink ( ?EntityPointerLink  $versionLink)
static
Parameters
EntityPointerLink | null$versionLink
Returns
‪static

Definition at line 123 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 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 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().