TYPO3\CMS\Core\Utility\RootlineUtility Class Reference

Public Member Functions
	__construct ($uid, $mountPointParameter='', \TYPO3\CMS\Frontend\Page\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 = array()
	$languageUid = 0
	$workspaceUid = 0
	$versionPreview = FALSE
	$pageContext
	$cacheIdentifier
	$databaseConnection

Static Protected Attributes
static	$cache = NULL
static	$localCache = array()
static	$rootlineFields
static	$pageRecordCache = array()

Detailed Description

This file is part of the TYPO3 CMS project.

It is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, either version 2 of the License, or any later version.

For the full copyright and license information, please read the LICENSE.txt file that was distributed with this source code.

The TYPO3 project - inspiring people to share! A utility resolving and Caching the Rootline generation

Author

Steffen Ritter steff.nosp@m.en.r.nosp@m.itter.nosp@m.@typ.nosp@m.o3.or.nosp@m.g

Definition at line 21 of file RootlineUtility.php.

Constructor & Destructor Documentation

__construct()

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

Parameters

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

Exceptions

Definition at line 122 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

boolean TRUE, if it describes a non-CSV relation

Definition at line 333 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 203 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

integer

$otherUid

Returns

string

Definition at line 182 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

integer

$uid

Page id

Exceptions

Definition at line 238 of file RootlineUtility.php.

References $GLOBALS, $uid, TYPO3\CMS\Core\Utility\RootlineUtility\columnHasRelationToResolve(), 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 143 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

boolean

Definition at line 391 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 431 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 403 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 171 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 56 of file RootlineUtility.php.

$cacheIdentifier

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

protected

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

$languageUid

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

protected

Definition at line 41 of file RootlineUtility.php.

$localCache

TYPO3\CMS\Core\Utility\RootlineUtility::$localCache = array()

staticprotected

Definition at line 61 of file RootlineUtility.php.

$mountPointParameter

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

protected

Definition at line 31 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 99 of file RootlineUtility.php.

$pageRecordCache

TYPO3\CMS\Core\Utility\RootlineUtility::$pageRecordCache = array()

staticprotected

Definition at line 109 of file RootlineUtility.php.

$pageUid

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

protected

Definition at line 26 of file RootlineUtility.php.

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

$parsedMountPointParameters

TYPO3\CMS\Core\Utility\RootlineUtility::$parsedMountPointParameters = array()

protected

Definition at line 36 of file RootlineUtility.php.

$rootlineFields

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

staticprotected

Initial value:

= array(
        'pid',
        'uid',
        't3ver_oid',
        't3ver_wsid',
        't3ver_state',
        'title',
        'alias',
        'nav_title',
        'media',
        'layout',
        'hidden',
        'starttime',
        'endtime',
        'fe_group',
        'extendToSubpages',
        'doktype',
        'TSconfig',
        'storage_pid',
        'is_siteroot',
        'mount_pid',
        'mount_pid_ol',
        'fe_login_mode',
        'backend_layout_next_level'
    )

Definition at line 68 of file RootlineUtility.php.

$versionPreview

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

protected

Definition at line 51 of file RootlineUtility.php.

$workspaceUid

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

protected

Definition at line 46 of file RootlineUtility.php.