Inheritance diagram for TYPO3\CMS\Backend\Tree\View\PagePositionMap:

Public Member Functions
	__construct ($pageTreeClassName=null)

	boldTitle ($t_code, $dat, $id)

	onClickEvent ($pid, $newPagePID)

	insertlabel ()

	linkPageTitle ($str, $rec)

	checkNewPageInPid ($pid)

	getModConfig ($pid)

	printContentElementColumns ($pid, $moveUid, $colPosList, $showHidden, $R_URI)

	printRecordMap ($lines, $colPosArray, $pid=0)

	wrapColumnHeader ($str, $vv)

	insertPositionIcon ($row, $vv, $kk, $moveUid, $pid)

	onClickInsertRecord ($row, $vv, $moveUid, $pid, $sys_lang=0)

	wrapRecordHeader ($str, $row)

	getRecordHeader ($row)

	wrapRecordTitle ($str, $row)

Public Attributes
	$moveOrCopy = 'move'

	$dontPrintPageInsertIcons = 0

	$depth = 2

	$cur_sys_language

	$R_URI = ''

	$elUid = ''

	$moveUid = ''

	$getModConfigCache = []

	$checkNewPageCache = []

	$l_insertNewPageHere = 'insertNewPageHere'

	$l_insertNewRecordHere = 'insertNewRecordHere'

	$modConfigStr = 'mod.web_list.newPageWiz'

Protected Member Functions
	getBackendUser ()

	getLanguageService ()

	getDatabase ()

Protected Attributes
	$pageTreeClassName = ElementBrowserPageTreeView::class

	$iconFactory

Detailed Description

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.

Definition at line 30 of file PagePositionMap.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Backend\Tree\View\PagePositionMap::__construct ( $pageTreeClassName = null )

Constructor allowing to set pageTreeImplementation

Parameters

string $pageTreeClassName

Definition at line 118 of file PagePositionMap.php.

Member Function Documentation

◆ boldTitle()

TYPO3\CMS\Backend\Tree\View\PagePositionMap::boldTitle	(	$t_code,
		$dat,
		$id
	)

Wrap $t_code in bold IF the $dat uid matches $id

Parameters

string	$t_code	Title string
array	$dat	Infomation array with record array inside.
int	$id	The current id.

Returns: string The title string.

Definition at line 250 of file PagePositionMap.php.

Referenced by TYPO3\CMS\Backend\Tree\View\PagePositionMap\__construct().

◆ checkNewPageInPid()

TYPO3\CMS\Backend\Tree\View\PagePositionMap::checkNewPageInPid ( $pid )

Checks if the user has permission to created pages inside of the $pid page. Uses caching so only one regular lookup is made - hence you can call the function multiple times without worrying about performance.

Parameters

int $pid Page id for which to test.

Returns: bool

Definition at line 310 of file PagePositionMap.php.

References TYPO3\CMS\Backend\Tree\View\PagePositionMap\getBackendUser(), and TYPO3\CMS\Backend\Utility\BackendUtility\getRecord().

Referenced by TYPO3\CMS\Backend\Tree\View\PagePositionMap\__construct().

◆ getBackendUser()

TYPO3\CMS\Backend\Tree\View\PagePositionMap::getBackendUser ( )

protected

Returns the BackendUser

Returns: BackendUserAuthentication

Definition at line 583 of file PagePositionMap.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Tree\View\PagePositionMap\__construct(), TYPO3\CMS\Backend\Tree\View\PagePositionMap\checkNewPageInPid(), and TYPO3\CMS\Backend\Tree\View\PagePositionMap\onClickInsertRecord().

◆ getDatabase()

TYPO3\CMS\Backend\Tree\View\PagePositionMap::getDatabase ( )

protected

Returns: DatabaseConnection

Definition at line 601 of file PagePositionMap.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Tree\View\PagePositionMap\printContentElementColumns().

◆ getLanguageService()

TYPO3\CMS\Backend\Tree\View\PagePositionMap::getLanguageService ( )

protected

Returns the LanguageService

Returns: LanguageService

Definition at line 593 of file PagePositionMap.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Tree\View\PagePositionMap\insertlabel(), TYPO3\CMS\Backend\Tree\View\PagePositionMap\insertPositionIcon(), and TYPO3\CMS\Backend\Tree\View\PagePositionMap\printRecordMap().

◆ getModConfig()

TYPO3\CMS\Backend\Tree\View\PagePositionMap::getModConfig ( $pid )

Returns module configuration for a pid.

Parameters

int $pid Page id for which to get the module configuration.

Returns: array The properties of teh module configuration for the page id.

See also: onClickEvent()

Definition at line 326 of file PagePositionMap.php.

References TYPO3\CMS\Backend\Utility\BackendUtility\getModTSconfig().

Referenced by TYPO3\CMS\Backend\Tree\View\PagePositionMap\onClickEvent().

◆ getRecordHeader()

TYPO3\CMS\Backend\Tree\View\PagePositionMap::getRecordHeader ( $row )

Create record header (includes teh record icon, record title etc.)

Parameters

array $row Record row.

Returns: string HTML

Definition at line 557 of file PagePositionMap.php.

References TYPO3\CMS\Backend\Tree\View\PagePositionMap\$iconFactory, TYPO3\CMS\Backend\Utility\BackendUtility\getRecordIconAltText(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecordTitle(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecordToolTip(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL, and TYPO3\CMS\Backend\Tree\View\PagePositionMap\wrapRecordTitle().

Referenced by TYPO3\CMS\Backend\Tree\View\PagePositionMap\printContentElementColumns().

◆ insertlabel()

TYPO3\CMS\Backend\Tree\View\PagePositionMap::insertlabel ( )

Get label, htmlspecialchars()'ed

Returns: string The localized label for "insert new page here

Definition at line 286 of file PagePositionMap.php.

References TYPO3\CMS\Backend\Tree\View\PagePositionMap\getLanguageService().

Referenced by TYPO3\CMS\Backend\Tree\View\PagePositionMap\__construct().

◆ insertPositionIcon()

TYPO3\CMS\Backend\Tree\View\PagePositionMap::insertPositionIcon	(	$row,
		$vv,
		$kk,
		$moveUid,
		$pid
	)

Creates a linked position icon.

Parameters

mixed	$row	Element row. If this is an array the link will cause an insert after this content element, otherwise the link will insert at the first position in the column
string	$vv	Column position value.
int	$kk	Column key.
int	$moveUid	Move uid
int	$pid	PID value.

Returns: string

Definition at line 502 of file PagePositionMap.php.

References TYPO3\CMS\Backend\Tree\View\PagePositionMap\$moveUid, $uid, TYPO3\CMS\Backend\Tree\View\PagePositionMap\getLanguageService(), and TYPO3\CMS\Backend\Tree\View\PagePositionMap\onClickInsertRecord().

Referenced by TYPO3\CMS\Backend\Tree\View\PagePositionMap\printContentElementColumns().

◆ linkPageTitle()

TYPO3\CMS\Backend\Tree\View\PagePositionMap::linkPageTitle	(	$str,
		$rec
	)

Wrapping page title.

Parameters

string	$str	Page title.
array	$rec	Page record (?)

Returns: string Wrapped title.

Definition at line 298 of file PagePositionMap.php.

Referenced by TYPO3\CMS\Backend\Tree\View\PagePositionMap\__construct().

◆ onClickEvent()

TYPO3\CMS\Backend\Tree\View\PagePositionMap::onClickEvent	(	$pid,
		$newPagePID
	)

Creates the onclick event for the insert-icons.

TSconfig mod.web_list.newPageWiz.overrideWithExtension may contain an extension which provides a module to be used instead of the normal create new page wizard.

Parameters

int	$pid	The pid.
int	$newPagePID	New page id.

Returns: string Onclick attribute content

Definition at line 268 of file PagePositionMap.php.

References $params, TYPO3\CMS\Backend\Utility\BackendUtility\editOnClick(), TYPO3\CMS\Core\Utility\ExtensionManagementUtility\extRelPath(), TYPO3\CMS\Backend\Tree\View\PagePositionMap\getModConfig(), TYPO3\CMS\Core\Utility\ExtensionManagementUtility\isLoaded(), and TYPO3\CMS\Core\Utility\GeneralUtility\quoteJSvalue().

Referenced by TYPO3\CMS\Backend\Tree\View\PagePositionMap\__construct().

◆ onClickInsertRecord()

TYPO3\CMS\Backend\Tree\View\PagePositionMap::onClickInsertRecord	(	$row,
		$vv,
		$moveUid,
		$pid,
		$sys_lang = `0`
	)

Create on-click event value.

Parameters

mixed	$row	The record. If this is not an array with the record data the insert will be for the first position in the column
string	$vv	Column position value.
int	$moveUid	Move uid
int	$pid	PID value.
int	$sys_lang	System language (not used currently)

Returns: string

Definition at line 526 of file PagePositionMap.php.

References TYPO3\CMS\Backend\Tree\View\PagePositionMap\$moveUid, TYPO3\CMS\Backend\Tree\View\PagePositionMap\getBackendUser(), and TYPO3\CMS\Core\Utility\GeneralUtility\quoteJSvalue().

Referenced by TYPO3\CMS\Backend\Tree\View\PagePositionMap\insertPositionIcon().

◆ printContentElementColumns()

TYPO3\CMS\Backend\Tree\View\PagePositionMap::printContentElementColumns	(	$pid,
		$moveUid,
		$colPosList,
		$showHidden,
		$R_URI
	)

Creates HTML for inserting/moving content elements.

Parameters

int	$pid	page id onto which to insert content element.
int	$moveUid	Move-uid (tt_content element uid?)
string	$colPosList	List of columns to show
bool	$showHidden	If not set, then hidden/starttime/endtime records are filtered out.
string	$R_URI	Request URI

Returns: string HTML

Definition at line 350 of file PagePositionMap.php.

References TYPO3\CMS\Backend\Tree\View\PagePositionMap\$moveUid, TYPO3\CMS\Backend\Tree\View\PagePositionMap\$R_URI, TYPO3\CMS\Backend\Utility\BackendUtility\BEenableFields(), TYPO3\CMS\Backend\Utility\BackendUtility\deleteClause(), TYPO3\CMS\Backend\Tree\View\PagePositionMap\getDatabase(), TYPO3\CMS\Backend\Tree\View\PagePositionMap\getRecordHeader(), TYPO3\CMS\Backend\Tree\View\PagePositionMap\insertPositionIcon(), TYPO3\CMS\Backend\Tree\View\PagePositionMap\printRecordMap(), TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode(), TYPO3\CMS\Backend\Utility\BackendUtility\versioningPlaceholderClause(), TYPO3\CMS\Backend\Utility\BackendUtility\workspaceOL(), and TYPO3\CMS\Backend\Tree\View\PagePositionMap\wrapRecordHeader().

◆ printRecordMap()

TYPO3\CMS\Backend\Tree\View\PagePositionMap::printRecordMap	(	$lines,
		$colPosArray,
		$pid = `0`
	)

Creates the table with the content columns

Parameters

array	$lines	Array with arrays of lines for each column
array	$colPosArray	Column position array
int	$pid	The id of the page

Returns: string HTML

Definition at line 380 of file PagePositionMap.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\callUserFunction(), TYPO3\CMS\Core\Utility\MathUtility\forceIntegerInRange(), TYPO3\CMS\Backend\Utility\BackendUtility\getLabelFromItemlist(), TYPO3\CMS\Backend\Tree\View\PagePositionMap\getLanguageService(), and TYPO3\CMS\Backend\Tree\View\PagePositionMap\wrapColumnHeader().

Referenced by TYPO3\CMS\Backend\Tree\View\PagePositionMap\printContentElementColumns().

◆ wrapColumnHeader()

TYPO3\CMS\Backend\Tree\View\PagePositionMap::wrapColumnHeader	(	$str,
		$vv
	)

Wrapping the column header

Parameters

string	$str	Header value
string	$vv	Column info.

Returns: string

See also: printRecordMap()

Definition at line 486 of file PagePositionMap.php.

Referenced by TYPO3\CMS\Backend\Tree\View\PagePositionMap\printRecordMap().

◆ wrapRecordHeader()

TYPO3\CMS\Backend\Tree\View\PagePositionMap::wrapRecordHeader	(	$str,
		$row
	)

Wrapping the record header (from getRecordHeader())

Parameters

string	$str	HTML content
string	$row	Record array.

Returns: string HTML content

Definition at line 546 of file PagePositionMap.php.

Referenced by TYPO3\CMS\Backend\Tree\View\ContentLayoutPagePositionMap\onClickInsertRecord(), and TYPO3\CMS\Backend\Tree\View\PagePositionMap\printContentElementColumns().

◆ wrapRecordTitle()

TYPO3\CMS\Backend\Tree\View\PagePositionMap::wrapRecordTitle	(	$str,
		$row
	)

Wrapping the title of the record.

Parameters

string	$str	The title value.
array	$row	The record row.

Returns: string Wrapped title string.

Definition at line 573 of file PagePositionMap.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\linkThisScript().

Referenced by TYPO3\CMS\Backend\Tree\View\PagePositionMap\getRecordHeader().

Member Data Documentation

◆ $checkNewPageCache

TYPO3\CMS\Backend\Tree\View\PagePositionMap::$checkNewPageCache = []

Definition at line 83 of file PagePositionMap.php.

◆ $cur_sys_language

TYPO3\CMS\Backend\Tree\View\PagePositionMap::$cur_sys_language

Definition at line 53 of file PagePositionMap.php.

◆ $depth

TYPO3\CMS\Backend\Tree\View\PagePositionMap::$depth = 2

Definition at line 47 of file PagePositionMap.php.

Referenced by TYPO3\CMS\Backend\Tree\View\PagePositionMap\__construct().

◆ $dontPrintPageInsertIcons

TYPO3\CMS\Backend\Tree\View\PagePositionMap::$dontPrintPageInsertIcons = 0

Definition at line 41 of file PagePositionMap.php.

◆ $elUid

TYPO3\CMS\Backend\Tree\View\PagePositionMap::$elUid = ''

Definition at line 66 of file PagePositionMap.php.

◆ $getModConfigCache

TYPO3\CMS\Backend\Tree\View\PagePositionMap::$getModConfigCache = []

Definition at line 78 of file PagePositionMap.php.

◆ $iconFactory

TYPO3\CMS\Backend\Tree\View\PagePositionMap::$iconFactory

protected

Definition at line 111 of file PagePositionMap.php.

Referenced by TYPO3\CMS\Backend\Tree\View\PagePositionMap\getRecordHeader(), and TYPO3\CMS\Backend\Tree\View\ContentLayoutPagePositionMap\onClickInsertRecord().

◆ $l_insertNewPageHere

TYPO3\CMS\Backend\Tree\View\PagePositionMap::$l_insertNewPageHere = 'insertNewPageHere'

Definition at line 89 of file PagePositionMap.php.

◆ $l_insertNewRecordHere

TYPO3\CMS\Backend\Tree\View\PagePositionMap::$l_insertNewRecordHere = 'insertNewRecordHere'

Definition at line 94 of file PagePositionMap.php.

◆ $modConfigStr

TYPO3\CMS\Backend\Tree\View\PagePositionMap::$modConfigStr = 'mod.web_list.newPageWiz'

Definition at line 99 of file PagePositionMap.php.

◆ $moveOrCopy

TYPO3\CMS\Backend\Tree\View\PagePositionMap::$moveOrCopy = 'move'

Definition at line 36 of file PagePositionMap.php.

◆ $moveUid

TYPO3\CMS\Backend\Tree\View\PagePositionMap::$moveUid = ''

Definition at line 72 of file PagePositionMap.php.

Referenced by TYPO3\CMS\Backend\Tree\View\PagePositionMap\insertPositionIcon(), TYPO3\CMS\Backend\Tree\View\PagePositionMap\onClickInsertRecord(), and TYPO3\CMS\Backend\Tree\View\PagePositionMap\printContentElementColumns().

◆ $pageTreeClassName

TYPO3\CMS\Backend\Tree\View\PagePositionMap::$pageTreeClassName = ElementBrowserPageTreeView::class

protected

Definition at line 106 of file PagePositionMap.php.

Referenced by TYPO3\CMS\Backend\Tree\View\PagePositionMap\__construct().

◆ $R_URI

TYPO3\CMS\Backend\Tree\View\PagePositionMap::$R_URI = ''

Definition at line 60 of file PagePositionMap.php.

Referenced by TYPO3\CMS\Backend\Tree\View\PagePositionMap\__construct(), and TYPO3\CMS\Backend\Tree\View\PagePositionMap\printContentElementColumns().

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ boldTitle()

◆ checkNewPageInPid()

◆ getBackendUser()

◆ getDatabase()

◆ getLanguageService()

◆ getModConfig()

◆ getRecordHeader()

◆ insertlabel()

◆ insertPositionIcon()

◆ linkPageTitle()

◆ onClickEvent()

◆ onClickInsertRecord()

◆ printContentElementColumns()

◆ printRecordMap()

◆ wrapColumnHeader()

◆ wrapRecordHeader()

◆ wrapRecordTitle()

Member Data Documentation

◆ $checkNewPageCache

◆ $cur_sys_language

◆ $depth

◆ $dontPrintPageInsertIcons

◆ $elUid

◆ $getModConfigCache

◆ $iconFactory

◆ $l_insertNewPageHere

◆ $l_insertNewRecordHere

◆ $modConfigStr

◆ $moveOrCopy

◆ $moveUid

◆ $pageTreeClassName

◆ $R_URI