PagePositionMap
Position map class - generating a page tree / content element list which links for inserting (copy/move) of records.
Used for pages / tt_content element wizards of various kinds.
Moving of Content to a certain position of a page happens in the ContentMovingPagePositionMap.
This class is a TYPO3 Backend implementation and is not considered part of the Public TYPO3 API.
Table of Contents
Properties
- $checkNewPageCache : array<string|int, mixed>
- $depth : int
- $dontPrintPageInsertIcons : int
- $moveOrCopy : string
- $moveUid : int
- $R_URI : string
- $iconFactory : IconFactory
- $pageTreeClassName : string
- Page tree implementation class name
Methods
- __construct() : mixed
- Constructor allowing to set pageTreeImplementation
- boldTitle() : string
- Wrap $t_code in bold IF the $dat uid matches $id
- checkNewPageInPid() : bool
- Checks if the user has permission to created pages inside of the $pid page.
- getActionLink() : string
- Creates the onclick event for the insert-icons.
- linkPageTitle() : string
- Wrapping page title.
- positionTree() : string
- Creates a "position tree" based on the page tree.
- getBackendUser() : BackendUserAuthentication
- getLanguageService() : LanguageService
- insertlabel() : string
- Get label, htmlspecialchars()'ed
Properties
$checkNewPageCache
public
array<string|int, mixed>
$checkNewPageCache
= []
$depth
public
int
$depth
= 2
$dontPrintPageInsertIcons
public
int
$dontPrintPageInsertIcons
= 0
$moveOrCopy
public
string
$moveOrCopy
= 'move'
$moveUid
public
int
$moveUid
$R_URI
public
string
$R_URI
= ''
$iconFactory
protected
IconFactory
$iconFactory
$pageTreeClassName
Page tree implementation class name
protected
string
$pageTreeClassName
= \TYPO3\CMS\Backend\Tree\View\PageTreeView::class
Methods
__construct()
Constructor allowing to set pageTreeImplementation
public
__construct([string|null $pageTreeClassName = null ]) : mixed
Parameters
- $pageTreeClassName : string|null = null
boldTitle()
Wrap $t_code in bold IF the $dat uid matches $id
public
boldTitle(string $t_code, array<string|int, mixed> $dat, int $id) : string
Parameters
- $t_code : string
-
Title string
- $dat : array<string|int, mixed>
-
Information array with record array inside.
- $id : int
-
The current id.
Return values
string —The title string.
checkNewPageInPid()
Checks if the user has permission to created pages inside of the $pid page.
public
checkNewPageInPid(int $pid) : bool
Uses caching so only one regular lookup is made - hence you can call the function multiple times without worrying about performance.
Parameters
- $pid : int
-
Page id for which to test.
Return values
boolgetActionLink()
Creates the onclick event for the insert-icons.
public
getActionLink(int $pid, int $newPagePID) : string
TSconfig mod.newPageWizard.override may contain an alternative module / route which can be used instead of the normal create new page wizard.
Parameters
- $pid : int
-
The pid.
- $newPagePID : int
-
New page id.
Return values
string —Onclick attribute content
linkPageTitle()
Wrapping page title.
public
linkPageTitle(string $str, array<string|int, mixed> $rec, ServerRequestInterface $request) : string
Parameters
- $str : string
-
Page title.
- $rec : array<string|int, mixed>
-
Page record (?)
- $request : ServerRequestInterface
Return values
string —Wrapped title.
positionTree()
Creates a "position tree" based on the page tree.
public
positionTree(int $id, array<string|int, mixed> $pageinfo, string $perms_clause, string $R_URI, ServerRequestInterface $request) : string
Parameters
- $id : int
-
Current page id
- $pageinfo : array<string|int, mixed>
-
Current page record.
- $perms_clause : string
-
Page selection permission clause.
- $R_URI : string
-
Current REQUEST_URI
- $request : ServerRequestInterface
Return values
string —HTML code for the tree.
getBackendUser()
protected
getBackendUser() : BackendUserAuthentication
Return values
BackendUserAuthenticationgetLanguageService()
protected
getLanguageService() : LanguageService
Return values
LanguageServiceinsertlabel()
Get label, htmlspecialchars()'ed
protected
insertlabel() : string
Return values
string —The localized label for "insert new page here"