Public Member Functions
	__construct ()

	fetchConfigurationAction ()

	fetchReadOnlyConfigurationAction (ServerRequestInterface $request)

	fetchDataAction (ServerRequestInterface $request)

	filterDataAction (ServerRequestInterface $request)

	setTemporaryMountPointAction (ServerRequestInterface $request)

Protected Member Functions
	initializeConfiguration (ServerRequestInterface $request)

	getDokTypes ()

	pagesToFlatArray (array $page, int $entryPoint, int $depth=0)

	initializePageTreeRepository ()

	getAllEntryPointPageTrees (int $startPid=0, string $query='')

	getDomainNameForPage (int $pageId)

	getMountPointPath (int $uid)

	isDragMoveAllowed ()

int[]	getAllowedMountPoints ()

	getPostProcessedPageItems (ServerRequestInterface $request, array $items)

	getBackendUser ()

	getLanguageService ()

Protected Attributes
bool	$useNavTitle = false

bool	$addIdAsPrefix = false

bool	$addDomainName = false

bool	$showMountPathAboveMounts = false

array	$hiddenRecords = array( )

array	$backgroundColors = array( )

array	$labels = []

array	$expandedState = array( )

IconFactory	$iconFactory

int	$levelsToFetch = 2

bool	$expandAllNodes = false

array	$alternativeEntryPoints = []

UriBuilder	$uriBuilder

PageTreeRepository	$pageTreeRepository

bool	$userHasAccessToModifyPagesAndToDefaultLanguage = false

Detailed Description

Controller providing data to the page tree

This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.

Definition at line 47 of file TreeController.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Backend\Controller\Page\TreeController::__construct ( )

Constructor to set up common objects needed in various places.

Definition at line 131 of file TreeController.php.

Member Function Documentation

◆ fetchConfigurationAction()

TYPO3\CMS\Backend\Controller\Page\TreeController::fetchConfigurationAction ( )

Returns page tree configuration in JSON

Definition at line 168 of file TreeController.php.

References TYPO3\CMS\Core\Authentication\JsConfirmation\DELETE, TYPO3\CMS\Backend\Controller\Page\TreeController\getBackendUser(), TYPO3\CMS\Backend\Controller\Page\TreeController\getDokTypes(), TYPO3\CMS\Backend\Controller\Page\TreeController\getMountPointPath(), and TYPO3\CMS\Backend\Controller\Page\TreeController\isDragMoveAllowed().

◆ fetchDataAction()

TYPO3\CMS\Backend\Controller\Page\TreeController::fetchDataAction ( ServerRequestInterface $request )

Returns JSON representing page tree

Definition at line 248 of file TreeController.php.

References TYPO3\CMS\Backend\Controller\Page\TreeController\$levelsToFetch, TYPO3\CMS\Backend\Controller\Page\TreeController\getAllEntryPointPageTrees(), TYPO3\CMS\Backend\Controller\Page\TreeController\getPostProcessedPageItems(), TYPO3\CMS\Backend\Controller\Page\TreeController\initializeConfiguration(), and TYPO3\CMS\Backend\Controller\Page\TreeController\pagesToFlatArray().

◆ fetchReadOnlyConfigurationAction()

TYPO3\CMS\Backend\Controller\Page\TreeController::fetchReadOnlyConfigurationAction ( ServerRequestInterface $request )

Definition at line 184 of file TreeController.php.

References TYPO3\CMS\Core\Authentication\JsConfirmation\DELETE, TYPO3\CMS\Backend\Controller\Page\TreeController\getBackendUser(), TYPO3\CMS\Backend\Controller\Page\TreeController\getMountPointPath(), and TYPO3\CMS\Core\Utility\GeneralUtility\intExplode().

◆ filterDataAction()

TYPO3\CMS\Backend\Controller\Page\TreeController::filterDataAction ( ServerRequestInterface $request )

Returns JSON representing page tree filtered by keyword

Definition at line 277 of file TreeController.php.

References TYPO3\CMS\Backend\Controller\Page\TreeController\getAllEntryPointPageTrees(), TYPO3\CMS\Backend\Controller\Page\TreeController\getPostProcessedPageItems(), TYPO3\CMS\Backend\Controller\Page\TreeController\initializeConfiguration(), and TYPO3\CMS\Backend\Controller\Page\TreeController\pagesToFlatArray().

◆ getAllEntryPointPageTrees()

TYPO3\CMS\Backend\Controller\Page\TreeController::getAllEntryPointPageTrees	(	int	$startPid = `0`,
		string	$query = `''`
	)

protected

Fetches all pages for all tree entry points the user is allowed to see

Parameters

string $query ‪The search query can either be a string to be found in the title or the nav_title of a page or the uid of a page.

Definition at line 481 of file TreeController.php.

References TYPO3\CMS\Backend\Controller\Page\TreeController\$alternativeEntryPoints, $GLOBALS, TYPO3\CMS\Backend\Controller\Page\TreeController\getAllowedMountPoints(), TYPO3\CMS\Backend\Controller\Page\TreeController\getBackendUser(), TYPO3\CMS\Backend\Controller\Page\TreeController\initializePageTreeRepository(), and TYPO3\CMS\Core\Type\Bitmask\Permission\PAGE_SHOW.

Referenced by TYPO3\CMS\Backend\Controller\Page\TreeController\fetchDataAction(), and TYPO3\CMS\Backend\Controller\Page\TreeController\filterDataAction().

◆ getAllowedMountPoints()

int [] TYPO3\CMS\Backend\Controller\Page\TreeController::getAllowedMountPoints ( )

protected

Get allowed mountpoints. Returns temporary mountpoint when temporary mountpoint is used.

Returns: ‪int[]

Definition at line 625 of file TreeController.php.

References TYPO3\CMS\Backend\Controller\Page\TreeController\$alternativeEntryPoints, and TYPO3\CMS\Backend\Controller\Page\TreeController\getBackendUser().

Referenced by TYPO3\CMS\Backend\Controller\Page\TreeController\getAllEntryPointPageTrees().

◆ getBackendUser()

TYPO3\CMS\Backend\Controller\Page\TreeController::getBackendUser ( )

protected

Definition at line 679 of file TreeController.php.

References $GLOBALS.

◆ getDokTypes()

TYPO3\CMS\Backend\Controller\Page\TreeController::getDokTypes ( )

protected

Returns the list of doktypes to display in page tree toolbar drag area

Note: The list can be filtered by the user TypoScript option "options.pageTree.doktypesToShowInNewPageDragArea".

Definition at line 211 of file TreeController.php.

References $GLOBALS, $output, TYPO3\CMS\Core\Schema\Struct\SelectItem\fromTcaItemArray(), TYPO3\CMS\Backend\Controller\Page\TreeController\getBackendUser(), TYPO3\CMS\Backend\Controller\Page\TreeController\getLanguageService(), and TYPO3\CMS\Core\Utility\GeneralUtility\intExplode().

Referenced by TYPO3\CMS\Backend\Controller\Page\TreeController\fetchConfigurationAction().

◆ getDomainNameForPage()

TYPO3\CMS\Backend\Controller\Page\TreeController::getDomainNameForPage ( int $pageId )

protected

Returns the first configured domain name for a page

Definition at line 574 of file TreeController.php.

Referenced by TYPO3\CMS\Backend\Controller\Page\TreeController\pagesToFlatArray().

◆ getLanguageService()

TYPO3\CMS\Backend\Controller\Page\TreeController::getLanguageService ( )

protected

Definition at line 684 of file TreeController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Controller\Page\TreeController\getDokTypes(), and TYPO3\CMS\Backend\Controller\Page\TreeController\pagesToFlatArray().

◆ getMountPointPath()

TYPO3\CMS\Backend\Controller\Page\TreeController::getMountPointPath ( int $uid )

protected

Returns the mount point path for a temporary mount or the given id

Definition at line 591 of file TreeController.php.

References TYPO3\CMS\Webhooks\Message\$record, and TYPO3\CMS\Webhooks\Message\$uid.

Referenced by TYPO3\CMS\Backend\Controller\Page\TreeController\fetchConfigurationAction(), TYPO3\CMS\Backend\Controller\Page\TreeController\fetchReadOnlyConfigurationAction(), TYPO3\CMS\Backend\Controller\Page\TreeController\pagesToFlatArray(), and TYPO3\CMS\Backend\Controller\Page\TreeController\setTemporaryMountPointAction().

◆ getPostProcessedPageItems()

TYPO3\CMS\Backend\Controller\Page\TreeController::getPostProcessedPageItems	(	ServerRequestInterface	$request,
		array	$items
	)

protected

Definition at line 638 of file TreeController.php.

References TYPO3\CMS\Extbase\Security\prefix.

Referenced by TYPO3\CMS\Backend\Controller\Page\TreeController\fetchDataAction(), and TYPO3\CMS\Backend\Controller\Page\TreeController\filterDataAction().

◆ initializeConfiguration()

TYPO3\CMS\Backend\Controller\Page\TreeController::initializeConfiguration ( ServerRequestInterface $request )

protected

Definition at line 137 of file TreeController.php.

References TYPO3\CMS\Backend\Controller\Page\TreeController\getBackendUser(), and TYPO3\CMS\Core\Utility\GeneralUtility\intExplode().

Referenced by TYPO3\CMS\Backend\Controller\Page\TreeController\fetchDataAction(), and TYPO3\CMS\Backend\Controller\Page\TreeController\filterDataAction().

◆ initializePageTreeRepository()

TYPO3\CMS\Backend\Controller\Page\TreeController::initializePageTreeRepository ( )

protected

Definition at line 455 of file TreeController.php.

References TYPO3\CMS\Backend\Controller\Page\TreeController\$pageTreeRepository, TYPO3\CMS\Backend\Controller\Page\TreeController\getBackendUser(), TYPO3\CMS\Core\Utility\GeneralUtility\intExplode(), TYPO3\CMS\Core\Type\Bitmask\Permission\PAGE_SHOW, and TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository\setAdditionalWhereClause().

Referenced by TYPO3\CMS\Backend\Controller\Page\TreeController\getAllEntryPointPageTrees().

◆ isDragMoveAllowed()

TYPO3\CMS\Backend\Controller\Page\TreeController::isDragMoveAllowed ( )

protected

Check if drag-move in the svg tree is allowed for the user

Definition at line 613 of file TreeController.php.

References TYPO3\CMS\Backend\Controller\Page\TreeController\getBackendUser().

Referenced by TYPO3\CMS\Backend\Controller\Page\TreeController\fetchConfigurationAction().

◆ pagesToFlatArray()

TYPO3\CMS\Backend\Controller\Page\TreeController::pagesToFlatArray	(	array	$page,
		int	$entryPoint,
		int	$depth = `0`
	)

protected

Converts nested tree structure produced by PageTreeRepository to a flat, one level array and also adds visual representation information to the data.

The result is intended to be used as JSON result - dumping data directly to HTML might lead to XSS!

Parameters

array	$page
int	$entryPoint
int	$depth

Definition at line 333 of file TreeController.php.

References TYPO3\CMS\Webhooks\Message\$identifier, TYPO3\CMS\Backend\Controller\Page\TreeController\$labels, TYPO3\CMS\Backend\Controller\Page\TreeController\getBackendUser(), TYPO3\CMS\Backend\Controller\Page\TreeController\getDomainNameForPage(), TYPO3\CMS\Backend\Controller\Page\TreeController\getLanguageService(), TYPO3\CMS\Backend\Controller\Page\TreeController\getMountPointPath(), TYPO3\CMS\Core\Type\Bitmask\Permission\PAGE_DELETE, and TYPO3\CMS\Core\Type\Bitmask\Permission\PAGE_EDIT.

Referenced by TYPO3\CMS\Backend\Controller\Page\TreeController\fetchDataAction(), and TYPO3\CMS\Backend\Controller\Page\TreeController\filterDataAction().

◆ setTemporaryMountPointAction()

TYPO3\CMS\Backend\Controller\Page\TreeController::setTemporaryMountPointAction ( ServerRequestInterface $request )

Sets a temporary mount point

Exceptions

Definition at line 305 of file TreeController.php.

References TYPO3\CMS\Backend\Controller\Page\TreeController\getBackendUser(), and TYPO3\CMS\Backend\Controller\Page\TreeController\getMountPointPath().

Member Data Documentation

◆ $addDomainName

bool TYPO3\CMS\Backend\Controller\Page\TreeController::$addDomainName = false

protected

Option to prefix the domain name of sys_domains when outputting the tree items, set via userTS.

Definition at line 65 of file TreeController.php.

◆ $addIdAsPrefix

bool TYPO3\CMS\Backend\Controller\Page\TreeController::$addIdAsPrefix = false

protected

Option to prefix the page ID when outputting the tree items, set via userTS.

Definition at line 59 of file TreeController.php.

◆ $alternativeEntryPoints

array TYPO3\CMS\Backend\Controller\Page\TreeController::$alternativeEntryPoints = []

protected

Used in the record link picker to limit the page tree only to a specific list of alternative entry points for selecting only from a list of pages

Definition at line 120 of file TreeController.php.

Referenced by TYPO3\CMS\Backend\Controller\Page\TreeController\getAllEntryPointPageTrees(), and TYPO3\CMS\Backend\Controller\Page\TreeController\getAllowedMountPoints().

◆ $backgroundColors

array TYPO3\CMS\Backend\Controller\Page\TreeController::$backgroundColors = array( )

protected

An array of background colors for a branch in the tree, set via userTS.

Deprecated:: ‪will be removed in TYPO3 v14.0, please use labels instead

Definition at line 84 of file TreeController.php.

◆ $expandAllNodes

bool TYPO3\CMS\Backend\Controller\Page\TreeController::$expandAllNodes = false

protected

When set to true all nodes returend by API will be expanded

Definition at line 114 of file TreeController.php.

◆ $expandedState

array TYPO3\CMS\Backend\Controller\Page\TreeController::$expandedState = array( )

protected

Contains the state of all items that are expanded.

Definition at line 97 of file TreeController.php.

◆ $hiddenRecords

array TYPO3\CMS\Backend\Controller\Page\TreeController::$hiddenRecords = array( )

protected

A list of pages not to be shown.

Definition at line 77 of file TreeController.php.

◆ $iconFactory

IconFactory TYPO3\CMS\Backend\Controller\Page\TreeController::$iconFactory

protected

Instance of the icon factory, to be used for generating the items.

Definition at line 103 of file TreeController.php.

◆ $labels

array TYPO3\CMS\Backend\Controller\Page\TreeController::$labels = []

protected

Definition at line 91 of file TreeController.php.

Referenced by TYPO3\CMS\Backend\Controller\Page\TreeController\pagesToFlatArray().

◆ $levelsToFetch

int TYPO3\CMS\Backend\Controller\Page\TreeController::$levelsToFetch = 2

protected

Number of tree levels which should be returned on the first page tree load

Definition at line 109 of file TreeController.php.

Referenced by TYPO3\CMS\Backend\Controller\Page\TreeController\fetchDataAction().

◆ $pageTreeRepository

PageTreeRepository TYPO3\CMS\Backend\Controller\Page\TreeController::$pageTreeRepository

protected

Definition at line 124 of file TreeController.php.

Referenced by TYPO3\CMS\Backend\Controller\Page\TreeController\initializePageTreeRepository().

◆ $showMountPathAboveMounts

bool TYPO3\CMS\Backend\Controller\Page\TreeController::$showMountPathAboveMounts = false

protected

Option to add the rootline path above each mount point, set via userTS.

Definition at line 71 of file TreeController.php.

◆ $uriBuilder

UriBuilder TYPO3\CMS\Backend\Controller\Page\TreeController::$uriBuilder

protected

Definition at line 122 of file TreeController.php.

◆ $useNavTitle

bool TYPO3\CMS\Backend\Controller\Page\TreeController::$useNavTitle = false

protected

Option to use the nav_title field for outputting in the tree items, set via userTS.

Definition at line 53 of file TreeController.php.

◆ $userHasAccessToModifyPagesAndToDefaultLanguage

bool TYPO3\CMS\Backend\Controller\Page\TreeController::$userHasAccessToModifyPagesAndToDefaultLanguage = false

protected

Definition at line 126 of file TreeController.php.

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ fetchConfigurationAction()

◆ fetchDataAction()

◆ fetchReadOnlyConfigurationAction()

◆ filterDataAction()

◆ getAllEntryPointPageTrees()

◆ getAllowedMountPoints()

◆ getBackendUser()

◆ getDokTypes()

◆ getDomainNameForPage()

◆ getLanguageService()

◆ getMountPointPath()

◆ getPostProcessedPageItems()

◆ initializeConfiguration()

◆ initializePageTreeRepository()

◆ isDragMoveAllowed()

◆ pagesToFlatArray()

◆ setTemporaryMountPointAction()

Member Data Documentation

◆ $addDomainName

◆ $addIdAsPrefix

◆ $alternativeEntryPoints

◆ $backgroundColors

◆ $expandAllNodes

◆ $expandedState

◆ $hiddenRecords

◆ $iconFactory

◆ $labels

◆ $levelsToFetch

◆ $pageTreeRepository

◆ $showMountPathAboveMounts

◆ $uriBuilder

◆ $useNavTitle

◆ $userHasAccessToModifyPagesAndToDefaultLanguage