TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository Class Reference

Public Member Functions
	__construct (int $workspaceId=0, array $additionalFieldsToQuery=[], array $additionalQueryRestrictions=[])
array	getTree (int $entryPoint, callable $callback=null, array $dbMounts=[], $resolveUserPermissions=false)
array	getTreeLevels (array $pageTree, int $depth, array $entryPointIds=[])
	hasChildren (int $pid)
array	fetchFilteredTree (string $searchFilter, array $allowedMountPointPageIds, string $additionalWhereClause)

Protected Member Functions
	applyCallbackToChildren (array &$tree, callable $callback)
	getChildPageRecords (array $parentPageIds)
array	getPageRecords (array $pageIds=[], array $parentPageIds=[])
array	fetchAllPages (array $dbMounts, bool $resolveUserPermissions=false)
	addChildrenToPage (array &$page, array &$groupedAndSortedPagesByPid)
array	findInPageTree (int $pageId, array $pages)
array	filterPagesOnMountPoints (array $pages, array $mountPoints)
array	groupAndSortPages (array $pages, $groupedAndSortedPagesByPid=[])
BackendUserAuthentication	getBackendUser ()

Protected Attributes
string[]	$fields
int	$currentWorkspace = 0
array	$fullPageTree = array( )
array	$additionalQueryRestrictions = array( )

Detailed Description

Fetches ALL pages in the page tree, possibly overlaid with the workspace in a sorted way.

This works agnostic of the Backend User, allows to be used in FE as well in the future.

this class is not public API yet, as it needs to be proven stable enough first.

Definition at line 40 of file PageTreeRepository.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository::__construct	(	int	$workspaceId = 0,
		array	$additionalFieldsToQuery = [],
		array	$additionalQueryRestrictions = []
	)

Parameters

int	$workspaceId	‪the workspace ID to be checked for.
array	$additionalFieldsToQuery	‪an array with more fields that should be accessed.
array	$additionalQueryRestrictions	‪an array with more restrictions to add

Definition at line 104 of file PageTreeRepository.php.

References TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository\$additionalQueryRestrictions.

Member Function Documentation

addChildrenToPage()

TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository::addChildrenToPage ( array &  $page, array &  $groupedAndSortedPagesByPid  )

protected

Adds the property "_children" to a page record with the child pages

Parameters

array	$page
array[]	$groupedAndSortedPagesByPid

Definition at line 468 of file PageTreeRepository.php.

Referenced by TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository\fetchAllPages(), TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository\fetchFilteredTree(), and TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository\getTreeLevels().

applyCallbackToChildren()

TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository::applyCallbackToChildren ( array &  $tree, callable  $callback  )

protected

Removes items from a tree based on a callback, usually used for permission checks

Parameters

array	$tree
callable	$callback

Definition at line 150 of file PageTreeRepository.php.

Referenced by TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository\getTree().

fetchAllPages()

array TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository::fetchAllPages ( array  $dbMounts, bool  $resolveUserPermissions = false  )

protected

Fetch all non-deleted pages, regardless of permissions. That's why it's internal.

Parameters

array	$dbMounts
bool	$resolveUserPermissions

Returns

‪array the full page tree of the whole installation

Definition at line 338 of file PageTreeRepository.php.

References TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository\$fullPageTree, $GLOBALS, TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository\addChildrenToPage(), TYPO3\CMS\Backend\Utility\BackendUtility\BEgetRootLine(), TYPO3\CMS\Core\Versioning\VersionState\MOVE_PLACEHOLDER, TYPO3\CMS\Core\Versioning\VersionState\MOVE_POINTER, TYPO3\CMS\Core\Type\Bitmask\Permission\PAGE_SHOW, and TYPO3\CMS\Core\Database\Query\QueryHelper\stripLogicalOperatorPrefix().

Referenced by TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository\getTree().

fetchFilteredTree()

array TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository::fetchFilteredTree	(	string	$searchFilter,
		array	$allowedMountPointPageIds,
		string	$additionalWhereClause
	)

Retrieve the page tree based on the given search filter

Parameters

string	$searchFilter
array	$allowedMountPointPageIds
string	$additionalWhereClause

Returns

‪array

Definition at line 506 of file PageTreeRepository.php.

References TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository\$fullPageTree, $GLOBALS, TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository\addChildrenToPage(), TYPO3\CMS\Core\Versioning\VersionState\DELETE_PLACEHOLDER, TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository\filterPagesOnMountPoints(), TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository\groupAndSortPages(), TYPO3\CMS\Core\Versioning\VersionState\MOVE_PLACEHOLDER, TYPO3\CMS\Core\Versioning\VersionState\MOVE_POINTER, and TYPO3\CMS\Core\Database\Query\QueryHelper\stripLogicalOperatorPrefix().

filterPagesOnMountPoints()

array TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository::filterPagesOnMountPoints ( array  $pages, array  $mountPoints  )

protected

Filter all records outside of the allowed mount points

Parameters

array	$pages
array	$mountPoints

Returns

‪array

Definition at line 661 of file PageTreeRepository.php.

References TYPO3\CMS\Backend\Utility\BackendUtility\BEgetRootLine(), TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository\getBackendUser(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecord(), TYPO3\CMS\Core\Authentication\BackendUserAuthentication\isAdmin(), and TYPO3\CMS\Core\Authentication\BackendUserAuthentication\isInWebMount().

Referenced by TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository\fetchFilteredTree().

findInPageTree()

array TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository::findInPageTree ( int  $pageId, array  $pages  )

protected

Looking for a page by traversing the tree

Parameters

int	$pageId	‪the page ID to search for
array	$pages	‪the page tree to look for the page

Returns

‪array Array of the tree data, empty array if nothing was found

Definition at line 484 of file PageTreeRepository.php.

Referenced by TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository\getTree().

getBackendUser()

BackendUserAuthentication TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository::getBackendUser ( )

protected

Returns

‪BackendUserAuthentication

Definition at line 757 of file PageTreeRepository.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository\filterPagesOnMountPoints().

getChildPageRecords()

TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository::getChildPageRecords ( array  $parentPageIds )

protected

Definition at line 198 of file PageTreeRepository.php.

References TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository\getPageRecords().

Referenced by TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository\getTreeLevels(), and TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository\hasChildren().

getPageRecords()

array TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository::getPageRecords ( array  $pageIds = [], array  $parentPageIds = []  )

protected

Retrieve the page records based on the given page or parent page ids

Parameters

array	$pageIds
array	$parentPageIds

Returns

‪array

Definition at line 210 of file PageTreeRepository.php.

References $GLOBALS, TYPO3\CMS\Backend\Utility\BackendUtility\getRecord(), TYPO3\CMS\Core\Versioning\VersionState\MOVE_PLACEHOLDER, TYPO3\CMS\Core\Versioning\VersionState\MOVE_POINTER, TYPO3\CMS\Core\Type\Bitmask\Permission\PAGE_SHOW, and TYPO3\CMS\Core\Database\Query\QueryHelper\stripLogicalOperatorPrefix().

Referenced by TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository\getChildPageRecords(), and TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository\getTreeLevels().

getTree()

array TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository::getTree	(	int	$entryPoint,
		callable	$callback = null,
		array	$dbMounts = [],
			$resolveUserPermissions = false
	)

Main entry point for this repository, to fetch the tree data for a page. Basically the page record, plus all child pages and their child pages recursively, stored within "_children" item.

Parameters

int	$entryPoint	‪the page ID to fetch the tree for
callable	$callback	‪a callback to be used to check for permissions and filter out pages not to be included.
array	$dbMounts
bool	$resolveUserPermissions

Returns

‪array

Definition at line 126 of file PageTreeRepository.php.

References TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository\$fullPageTree, TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository\applyCallbackToChildren(), TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository\fetchAllPages(), and TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository\findInPageTree().

getTreeLevels()

array TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository::getTreeLevels	(	array	$pageTree,
		int	$depth,
		array	$entryPointIds = []
	)

Get the page tree based on a given page record and a given depth

Parameters

array	$pageTree	‪The page record of the top level page you want to get the page tree of
int	$depth	‪Number of levels to fetch
array	$entryPointIds	‪entryPointIds to include

Returns

‪array An array with page records and their children

Definition at line 172 of file PageTreeRepository.php.

References TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository\addChildrenToPage(), TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository\getChildPageRecords(), TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository\getPageRecords(), and TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository\groupAndSortPages().

groupAndSortPages()

array TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository::groupAndSortPages ( array  $pages,   $groupedAndSortedPagesByPid = []  )

protected

Group pages by parent page and sort pages based on sorting property

Parameters

array	$pages
array	$groupedAndSortedPagesByPid

Returns

‪array

Definition at line 735 of file PageTreeRepository.php.

Referenced by TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository\fetchFilteredTree(), and TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository\getTreeLevels().

hasChildren()

TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository::hasChildren

(

int

$pid

)

Definition at line 325 of file PageTreeRepository.php.

References TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository\getChildPageRecords().

Member Data Documentation

$additionalQueryRestrictions

array TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository::$additionalQueryRestrictions = array( )

protected

Definition at line 97 of file PageTreeRepository.php.

Referenced by TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository\__construct().

$currentWorkspace

int TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository::$currentWorkspace = 0

protected

The workspace ID to operate on

Definition at line 87 of file PageTreeRepository.php.

$fields

string [] TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository::$fields

protected

Fields to be queried from the database

Definition at line 46 of file PageTreeRepository.php.

$fullPageTree

array TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository::$fullPageTree = array( )

protected

Full page tree when selected without permissions applied.

Definition at line 93 of file PageTreeRepository.php.

Referenced by TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository\fetchAllPages(), TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository\fetchFilteredTree(), and TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository\getTree().