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

Inheritance diagram for TYPO3\CMS\Core\DataHandling\Model\CorrelationId:

Public Member Functions
	__toString ()
	jsonSerialize ()
	withSubject (string $subject)
	withAspects (string ... $aspects)
string null	getScope ()
string null	getSubject ()
string[]	getAspects ()

Static Public Member Functions
static static	forScope (string $scope)
static	forSubject (string $subject, string ... $aspects)
static static	fromString (string $correlationId)

Protected Member Functions
	serialize ()

Static Protected Member Functions
static static	create ()

Protected Attributes
const	DEFAULT_VERSION = 1
const	PATTERN_V1 = '#^(?P<flags>[[:xdigit:]]{4})\$(?:(?P<scope>[[:alnum:]]+):)?(?P<subject>[[:alnum:]]+)(?P<aspects>(?:\/[[:alnum:]._-]+)*)$#'
int	$version = self::DEFAULT_VERSION
string	$scope
int	$capabilities = 0
string	$subject
string[]	$aspects = array( )

Detailed Description

CorrelationId representation

Todo:

‪Check internal state during v10 development

Definition at line 28 of file CorrelationId.php.

Member Function Documentation

__toString()

TYPO3\CMS\Core\DataHandling\Model\CorrelationId::__toString

(

)

Definition at line 100 of file CorrelationId.php.

References TYPO3\CMS\Core\DataHandling\Model\CorrelationId\serialize().

create()

static static TYPO3\CMS\Core\DataHandling\Model\CorrelationId::create ( )

staticprotected

Returns

‪static

Definition at line 95 of file CorrelationId.php.

forScope()

static static TYPO3\CMS\Core\DataHandling\Model\CorrelationId::forScope ( string  $scope )

static

Parameters

string

$scope

Returns

‪static

Definition at line 57 of file CorrelationId.php.

References TYPO3\CMS\Core\DataHandling\Model\CorrelationId\$scope.

Referenced by TYPO3\CMS\Core\Tests\Unit\DataHandling\Model\CorrelationIdTest\scopeIsConsidered(), TYPO3\CMS\Redirects\Tests\Functional\Service\SlugServiceTest\setUp(), and TYPO3\CMS\Core\DataHandling\DataHandler\start().

forSubject()

static TYPO3\CMS\Core\DataHandling\Model\CorrelationId::forSubject ( string  $subject, string ...  $aspects  )

static

Definition at line 64 of file CorrelationId.php.

References TYPO3\CMS\Core\DataHandling\Model\CorrelationId\$aspects, and TYPO3\CMS\Core\DataHandling\Model\CorrelationId\$subject.

Referenced by TYPO3\CMS\Backend\Tests\Functional\History\RecordHistoryStoreTest\addRecordAddsARecordToTheDatabase(), TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\createCorrelationId(), TYPO3\CMS\Backend\Tests\Functional\History\RecordHistoryStoreTest\deleteRecordAddsARecordToTheDatabase(), TYPO3\CMS\Backend\Tests\Functional\History\RecordHistoryStoreTest\modifyRecordAddsARecordToTheDatabase(), TYPO3\CMS\Backend\Tests\Functional\History\RecordHistoryStoreTest\moveRecordAddsARecordToTheDatabase(), TYPO3\CMS\Core\Tests\Unit\DataHandling\Model\CorrelationIdTest\subjectIsConsidered(), and TYPO3\CMS\Backend\Tests\Functional\History\RecordHistoryStoreTest\undeleteRecordAddsARecordToTheDatabase().

fromString()

static static TYPO3\CMS\Core\DataHandling\Model\CorrelationId::fromString ( string  $correlationId )

static

Parameters

string

$correlationId

Returns

‪static

Definition at line 75 of file CorrelationId.php.

References TYPO3\CMS\Core\DataHandling\Model\CorrelationId\$aspects.

Referenced by TYPO3\CMS\Core\Tests\Unit\DataHandling\Model\CorrelationIdTest\canBeParsed(), TYPO3\CMS\Core\Tests\Unit\DataHandling\Model\CorrelationIdTest\doesNotVary(), and TYPO3\CMS\Redirects\Controller\RecordHistoryRollbackController\revertCorrelation().

getAspects()

string [] TYPO3\CMS\Core\DataHandling\Model\CorrelationId::getAspects

(

)

Returns

‪string[]

Definition at line 152 of file CorrelationId.php.

References TYPO3\CMS\Core\DataHandling\Model\CorrelationId\$aspects.

Referenced by TYPO3\CMS\Redirects\Hooks\DataHandlerSlugUpdateHook\isNestedHookInvocation().

getScope()

string null TYPO3\CMS\Core\DataHandling\Model\CorrelationId::getScope

(

)

Returns

‪string|null

Definition at line 136 of file CorrelationId.php.

References TYPO3\CMS\Core\DataHandling\Model\CorrelationId\$scope.

getSubject()

string null TYPO3\CMS\Core\DataHandling\Model\CorrelationId::getSubject

(

)

Returns

‪string|null

Definition at line 144 of file CorrelationId.php.

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

Referenced by TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\createCorrelationId(), and TYPO3\CMS\Redirects\Service\SlugService\createCorrelationIds().

jsonSerialize()

TYPO3\CMS\Core\DataHandling\Model\CorrelationId::jsonSerialize

(

)

Definition at line 108 of file CorrelationId.php.

serialize()

TYPO3\CMS\Core\DataHandling\Model\CorrelationId::serialize ( )

protected

v1 specs (eBNF)

• ‪FLAGS "$" [ SCOPE ":" ] SUBJECT { "/" ASPECT }
  • ‪FLAGS ::= XDIGIT (* 16-bit integer big-endian)
  • ‪SCOPE ::= ALNUM { ALNUM }
  • ‪SUBJECT ::= ALNUM { ALNUM }
  • ‪ASPECT ::= ( ALNUM | '.' | '_' | '-' ) { ( ALNUM | '.' | '_' | '-' ) }

Definition at line 165 of file CorrelationId.php.

References TYPO3\CMS\Core\DataHandling\Model\CorrelationId\$capabilities.

Referenced by TYPO3\CMS\Core\DataHandling\Model\CorrelationId\__toString().

withAspects()

TYPO3\CMS\Core\DataHandling\Model\CorrelationId::withAspects

(

string ...

$aspects

)

Definition at line 123 of file CorrelationId.php.

References TYPO3\CMS\Core\DataHandling\Model\CorrelationId\$aspects.

Referenced by TYPO3\CMS\Redirects\Service\SlugService\createCorrelationIds().

withSubject()

TYPO3\CMS\Core\DataHandling\Model\CorrelationId::withSubject

(

string

$subject

)

Definition at line 113 of file CorrelationId.php.

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

Referenced by TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore\createCorrelationId(), and TYPO3\CMS\Redirects\Service\SlugService\createCorrelationIds().

Member Data Documentation

$aspects

string [] TYPO3\CMS\Core\DataHandling\Model\CorrelationId::$aspects = array( )

protected

Definition at line 51 of file CorrelationId.php.

Referenced by TYPO3\CMS\Core\DataHandling\Model\CorrelationId\forSubject(), TYPO3\CMS\Core\DataHandling\Model\CorrelationId\fromString(), TYPO3\CMS\Core\DataHandling\Model\CorrelationId\getAspects(), and TYPO3\CMS\Core\DataHandling\Model\CorrelationId\withAspects().

$capabilities

int TYPO3\CMS\Core\DataHandling\Model\CorrelationId::$capabilities = 0

protected

Definition at line 43 of file CorrelationId.php.

Referenced by TYPO3\CMS\Core\DataHandling\Model\CorrelationId\serialize().

$scope

string TYPO3\CMS\Core\DataHandling\Model\CorrelationId::$scope

protected

Definition at line 39 of file CorrelationId.php.

Referenced by TYPO3\CMS\Core\DataHandling\Model\CorrelationId\forScope(), and TYPO3\CMS\Core\DataHandling\Model\CorrelationId\getScope().

$subject

string TYPO3\CMS\Core\DataHandling\Model\CorrelationId::$subject

protected

Definition at line 47 of file CorrelationId.php.

Referenced by TYPO3\CMS\Core\DataHandling\Model\CorrelationId\forSubject(), TYPO3\CMS\Core\DataHandling\Model\CorrelationId\getSubject(), and TYPO3\CMS\Core\DataHandling\Model\CorrelationId\withSubject().

$version

int TYPO3\CMS\Core\DataHandling\Model\CorrelationId::$version = self::DEFAULT_VERSION

protected

Definition at line 35 of file CorrelationId.php.

DEFAULT_VERSION

const TYPO3\CMS\Core\DataHandling\Model\CorrelationId::DEFAULT_VERSION = 1

protected

Definition at line 30 of file CorrelationId.php.

PATTERN_V1

const TYPO3\CMS\Core\DataHandling\Model\CorrelationId::PATTERN_V1 = '#^(?P<flags>[[:xdigit:]]{4})\$(?:(?P<scope>[[:alnum:]]+):)?(?P<subject>[[:alnum:]]+)(?P<aspects>(?:\/[[:alnum:]._-]+)*)$#'

protected

Definition at line 31 of file CorrelationId.php.