TYPO3\CMS\Core\Utility\RootlineUtility Class Reference

Public Member Functions
	__construct ($uid, $mountPointParameter='', PageRepository $context=null)
	getCacheIdentifier ($otherUid=null)
	get ()
	isMountedPage ()

Static Public Member Functions
static	purgeCaches ()

Protected Member Functions
	initializeObject ()
	getRecordArray ($uid)
	columnHasRelationToResolve (array $configuration)
	processMountedPage (array $mountedPageData, array $mountPointPageData)
	parseMountPointParameter ()

Protected Attributes
	$pageUid
	$mountPointParameter
	$parsedMountPointParameters = []
	$languageUid = 0
	$workspaceUid = 0
	$versionPreview = false
	$pageContext
	$cacheIdentifier
	$databaseConnection

Static Protected Attributes
static	$cache = null
static	$localCache = []
static	$rootlineFields
static	$pageRecordCache = []

Detailed Description

A utility resolving and Caching the Rootline generation

Definition at line 22 of file RootlineUtility.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Core\Utility\RootlineUtility::__construct	(		$uid,
			$mountPointParameter = '',
		PageRepository	$context = null
	)

Parameters

int	$uid
string	$mountPointParameter
\TYPO3\CMS\Frontend\Page\PageRepository	$context

Exceptions

Definition at line 123 of file RootlineUtility.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\RootlineUtility\$mountPointParameter, $uid, TYPO3\CMS\Core\Utility\RootlineUtility\initializeObject(), and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Member Function Documentation

columnHasRelationToResolve()

TYPO3\CMS\Core\Utility\RootlineUtility::columnHasRelationToResolve ( array  $configuration )

protected

Checks whether the TCA Configuration array of a column describes a relation which is not stored as CSV in the record

Parameters

array

$configuration

TCA configuration to check

Returns

bool TRUE, if it describes a non-CSV relation

Definition at line 340 of file RootlineUtility.php.

References TYPO3\CMS\Core\Utility\RootlineUtility\$cacheIdentifier, TYPO3\CMS\Core\Utility\RootlineUtility\$mountPointParameter, TYPO3\CMS\Core\Utility\RootlineUtility\getRecordArray(), TYPO3\CMS\Core\Utility\RootlineUtility\isMountedPage(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), and TYPO3\CMS\Core\Utility\RootlineUtility\processMountedPage().

Referenced by TYPO3\CMS\Core\Utility\RootlineUtility\getRecordArray().

get()

TYPO3\CMS\Core\Utility\RootlineUtility::get

(

)

Returns the actual rootline

Returns

array

Definition at line 207 of file RootlineUtility.php.

References TYPO3\CMS\Core\Utility\RootlineUtility\$cacheIdentifier, and TYPO3\CMS\Core\Utility\RootlineUtility\getCacheIdentifier().

getCacheIdentifier()

TYPO3\CMS\Core\Utility\RootlineUtility::getCacheIdentifier

(

$otherUid = null

)

Constructs the cache Identifier

Parameters

int

$otherUid

Returns

string

Definition at line 186 of file RootlineUtility.php.

References TYPO3\CMS\Core\Utility\RootlineUtility\$mountPointParameter.

Referenced by TYPO3\CMS\Core\Utility\RootlineUtility\get(), TYPO3\CMS\Core\Utility\RootlineUtility\getRecordArray(), and TYPO3\CMS\Core\Utility\RootlineUtility\initializeObject().

getRecordArray()

TYPO3\CMS\Core\Utility\RootlineUtility::getRecordArray (   $uid )

protected

Queries the database for the page record and returns it.

Parameters

int

$uid

Page id

Exceptions

Definition at line 243 of file RootlineUtility.php.

References $GLOBALS, $uid, TYPO3\CMS\Core\Utility\RootlineUtility\columnHasRelationToResolve(), TYPO3\CMS\Frontend\Page\PageRepository\DOKTYPE_RECYCLER, TYPO3\CMS\Core\Utility\RootlineUtility\getCacheIdentifier(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Core\Utility\RootlineUtility\columnHasRelationToResolve().

initializeObject()

TYPO3\CMS\Core\Utility\RootlineUtility::initializeObject ( )

protected

Initialize a state to work with

Exceptions

Definition at line 145 of file RootlineUtility.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\RootlineUtility\getCacheIdentifier(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), TYPO3\CMS\Core\Utility\RootlineUtility\parseMountPointParameter(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Core\Utility\RootlineUtility\__construct().

isMountedPage()

TYPO3\CMS\Core\Utility\RootlineUtility::isMountedPage

(

)

Checks whether the current Page is a Mounted Page (according to the MP-URL-Parameter)

Returns

bool

Definition at line 400 of file RootlineUtility.php.

Referenced by TYPO3\CMS\Core\Utility\RootlineUtility\columnHasRelationToResolve().

parseMountPointParameter()

TYPO3\CMS\Core\Utility\RootlineUtility::parseMountPointParameter ( )

protected

Parse the MountPoint Parameters Splits the MP-Param via "," for several nested mountpoints and afterwords registers the mountpoint configurations

Returns

void

Definition at line 442 of file RootlineUtility.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\intExplode(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Core\Utility\RootlineUtility\initializeObject().

processMountedPage()

TYPO3\CMS\Core\Utility\RootlineUtility::processMountedPage ( array  $mountedPageData, array  $mountPointPageData  )

protected

Enhances with mount point information or replaces the node if needed

Parameters

array	$mountedPageData	page record array of mounted page
array	$mountPointPageData	page record array of mount point page

Exceptions

Definition at line 413 of file RootlineUtility.php.

References TYPO3\CMS\Core\Utility\RootlineUtility\$pageUid.

Referenced by TYPO3\CMS\Core\Utility\RootlineUtility\columnHasRelationToResolve().

purgeCaches()

static TYPO3\CMS\Core\Utility\RootlineUtility::purgeCaches ( )

static

Purges all rootline caches.

Note: This function is intended to be used in unit tests only.

Returns

void

Definition at line 174 of file RootlineUtility.php.

Referenced by TYPO3\CMS\Core\Tests\Unit\Utility\RootlineUtilityTest\tearDown().

Member Data Documentation

$cache

TYPO3\CMS\Core\Utility\RootlineUtility::$cache = null

staticprotected

Definition at line 57 of file RootlineUtility.php.

$cacheIdentifier

TYPO3\CMS\Core\Utility\RootlineUtility::$cacheIdentifier

protected

Definition at line 105 of file RootlineUtility.php.

Referenced by TYPO3\CMS\Core\Utility\RootlineUtility\columnHasRelationToResolve(), and TYPO3\CMS\Core\Utility\RootlineUtility\get().

$databaseConnection

TYPO3\CMS\Core\Utility\RootlineUtility::$databaseConnection

protected

Definition at line 115 of file RootlineUtility.php.

$languageUid

TYPO3\CMS\Core\Utility\RootlineUtility::$languageUid = 0

protected

Definition at line 42 of file RootlineUtility.php.

$localCache

TYPO3\CMS\Core\Utility\RootlineUtility::$localCache = []

staticprotected

Definition at line 62 of file RootlineUtility.php.

$mountPointParameter

TYPO3\CMS\Core\Utility\RootlineUtility::$mountPointParameter

protected

Definition at line 32 of file RootlineUtility.php.

Referenced by TYPO3\CMS\Core\Utility\RootlineUtility\__construct(), TYPO3\CMS\Core\Utility\RootlineUtility\columnHasRelationToResolve(), and TYPO3\CMS\Core\Utility\RootlineUtility\getCacheIdentifier().

$pageContext

TYPO3\CMS\Core\Utility\RootlineUtility::$pageContext

protected

Definition at line 100 of file RootlineUtility.php.

$pageRecordCache

TYPO3\CMS\Core\Utility\RootlineUtility::$pageRecordCache = []

staticprotected

Definition at line 110 of file RootlineUtility.php.

$pageUid

TYPO3\CMS\Core\Utility\RootlineUtility::$pageUid

protected

Definition at line 27 of file RootlineUtility.php.

Referenced by TYPO3\CMS\Core\Utility\RootlineUtility\processMountedPage().

$parsedMountPointParameters

TYPO3\CMS\Core\Utility\RootlineUtility::$parsedMountPointParameters = []

protected

Definition at line 37 of file RootlineUtility.php.

$rootlineFields

TYPO3\CMS\Core\Utility\RootlineUtility::$rootlineFields

staticprotected

Initial value:

= [
        'pid',
        'uid',
        't3ver_oid',
        't3ver_wsid',
        't3ver_state',
        'title',
        'alias',
        'nav_title',
        'media',
        'layout',
        'hidden',
        'starttime',
        'endtime',
        'fe_group',
        'extendToSubpages',
        'doktype',
        'TSconfig',
        'tsconfig_includes',
        'is_siteroot',
        'mount_pid',
        'mount_pid_ol',
        'fe_login_mode',
        'backend_layout_next_level'
    ]

Definition at line 69 of file RootlineUtility.php.

$versionPreview

TYPO3\CMS\Core\Utility\RootlineUtility::$versionPreview = false

protected

Definition at line 52 of file RootlineUtility.php.

$workspaceUid

TYPO3\CMS\Core\Utility\RootlineUtility::$workspaceUid = 0

protected

Definition at line 47 of file RootlineUtility.php.