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

Public Member Functions
	__construct ()

	init ($clause='', $orderByFields='')

	addField ($field, $noCheck=false)

	reset ()

string	getBrowsableTree ()

string	printTree ($treeArr='')

string	PMicon ($row, $a, $c, $nextCount, $isOpen)

string	PM_ATagWrap ($icon, $cmd, $bMark='', $isOpen=false)

string	wrapTitle ($title, $row, $bank=0)

string	wrapIcon ($icon, $row)

string	addTagAttributes ($icon, $attr)

string	wrapStop ($str, $row)

bool	expandNext ($id)

	initializePositionSaving ()

	savePosition ()

string	getRootIcon ($rec)

string	getIcon ($row)

string	getTitleStr ($row, $titleLen=30)

string	getTitleAttrib ($row)

int	getId ($row)

string	getJumpToParam ($row)

int	getTree ($uid, $depth=999, $depthData='')

int	getCount ($uid)

array	getRootRecord ()

array	getRecord ($uid)

mixed	getDataInit ($parentId)

int	getDataCount (&$res)

array bool	getDataNext (&$res)

	getDataFree (&$res)

	setDataFromArray (&$dataArr, $traverse=false, $pid=0)

	setDataFromTreeArray (&$treeArr, &$treeLookupArr)

Public Attributes
bool	$expandFirst = false

bool	$expandAll = false

string	$thisScript = ''

string	$titleAttrib = 'title'

bool	$ext_IconMode = false

bool	$ext_showPathAboveMounts = false

int	$addSelfId = 0

string	$title = 'no title'

bool	$showDefaultTitleAttribute = false

TYPO3 CMS Core Authentication BackendUserAuthentication	$BE_USER = ''

array null	$MOUNTS

string	$table = ''

string	$parentField = 'pid'

string	$clause = ''

string	$orderByFields = ''

array	$fieldArray = array( 'uid', 'pid', 'title', 'is_siteroot' )

array	$defaultList = 'uid,pid,tstamp,sorting,deleted,perms_userid,perms_groupid,perms_user,perms_group,perms_everybody,crdate,cruser_id'

string	$treeName = ''

string	$domIdPrefix = 'row'

int	$makeHTML = 1

int	$setRecs = 0

string	$subLevelID = '_SUB_LEVEL'

array	$ids = array( )

array	$ids_hierarchy = array( )

array	$orig_ids_hierarchy = array( )

array	$buffer_idH = array( )

array	$specUIDmap = array( )

bool	$data = false

bool	$dataLookup = false

array	$tree = array( )

array	$stored = array( )

int	$bank = 0

array	$recs = array( )

Protected Member Functions
	determineScriptUrl ()

string	getThisScript ()

string	getMountPointPath (int $uid)

LanguageService	getLanguageService ()

BackendUserAuthentication	getBackendUser ()

Private Attributes
bool	$setDataFromArrayDeprecationThrown = false

Detailed Description

Base class for creating a browsable array/page/folder tree in HTML

Definition at line 32 of file AbstractTreeView.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Backend\Tree\View\AbstractTreeView::__construct ( )

Constructor

Reimplemented in TYPO3\CMS\Backend\Tree\View\FolderTreeView, TYPO3\CMS\Backend\Tree\View\ElementBrowserPageTreeView, TYPO3\CMS\Backend\View\PageTreeView, and TYPO3\CMS\Impexp\View\ExportPageTreeView.

Definition at line 255 of file AbstractTreeView.php.

References TYPO3\CMS\Backend\Tree\View\AbstractTreeView\determineScriptUrl().

Member Function Documentation

◆ addField()

TYPO3\CMS\Backend\Tree\View\AbstractTreeView::addField	(	$field,
		$noCheck = `false`
	)

Adds a fieldname to the internal array ->fieldArray

Parameters

string	$field	‪Field name to
bool	$noCheck	‪If set, the fieldname will be set no matter what. Otherwise the field name must either be found as key in $GLOBALS['TCA'][$table]['columns'] or in the list ->defaultList

Definition at line 317 of file AbstractTreeView.php.

References $GLOBALS.

◆ addTagAttributes()

string TYPO3\CMS\Backend\Tree\View\AbstractTreeView::addTagAttributes	(	$icon,
		$attr
	)

Adds attributes to image tag.

Parameters

string	$icon	‪Icon image tag
string	$attr	‪Attributes to add, eg. ' border="0"'

Returns: ‪string Image tag, modified with $attr attributes added.

Definition at line 545 of file AbstractTreeView.php.

◆ determineScriptUrl()

TYPO3\CMS\Backend\Tree\View\AbstractTreeView::determineScriptUrl ( )

protected

Sets the script url depending on being a module or script request

Definition at line 263 of file AbstractTreeView.php.

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

◆ expandNext()

bool TYPO3\CMS\Backend\Tree\View\AbstractTreeView::expandNext ( $id )

Returns TRUE/FALSE if the next level for $id should be expanded - based on data in $this->stored[][] and ->expandAll flag. Extending parent function

Parameters

int $id ‪Record id/key

Returns: ‪bool

See also: ‪\TYPO3\CMS\Backend\Tree\View\PageTreeView::expandNext()

Reimplemented in TYPO3\CMS\Backend\Tree\View\PageTreeView, and TYPO3\CMS\Backend\Tree\View\NewRecordPageTreeView.

Definition at line 581 of file AbstractTreeView.php.

References TYPO3\CMS\Backend\Tree\View\AbstractTreeView\$expandAll.

Referenced by TYPO3\CMS\Backend\Tree\View\FolderTreeView\getFolderTree(), and TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getTree().

◆ getBackendUser()

BackendUserAuthentication TYPO3\CMS\Backend\Tree\View\AbstractTreeView::getBackendUser ( )

protected

Returns: ‪BackendUserAuthentication

Definition at line 1065 of file AbstractTreeView.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getMountPointPath(), TYPO3\CMS\Backend\Tree\View\BrowseTreeView\getTitleStr(), TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getTree(), and TYPO3\CMS\Backend\Tree\View\BrowseTreeView\init().

◆ getBrowsableTree()

string TYPO3\CMS\Backend\Tree\View\AbstractTreeView::getBrowsableTree ( )

Will create and return the HTML code for a browsable tree Is based on the mounts found in the internal array ->MOUNTS (set in the constructor)

Returns: ‪string HTML code for the browsable tree

Reimplemented in TYPO3\CMS\Backend\View\PageTreeView, and TYPO3\CMS\Backend\Tree\View\FolderTreeView.

Definition at line 347 of file AbstractTreeView.php.

◆ getCount()

int TYPO3\CMS\Backend\Tree\View\AbstractTreeView::getCount ( $uid )

Returns the number of records having the parent id, $uid

Parameters

int $uid ‪Id to count subitems for

Returns: ‪int

Definition at line 812 of file AbstractTreeView.php.

References TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getDataCount(), TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getDataInit(), and TYPO3\CMS\Core\Database\Query\QueryHelper\stripLogicalOperatorPrefix().

Referenced by TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getTree().

◆ getDataCount()

int TYPO3\CMS\Backend\Tree\View\AbstractTreeView::getDataCount ( & $res )

Getting the tree data: Counting elements in resource

Parameters

mixed $res ‪Data handle

Returns: ‪int number of items

See also: ‪getDataInit()

Definition at line 921 of file AbstractTreeView.php.

Referenced by TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getCount(), and TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getTree().

◆ getDataFree()

TYPO3\CMS\Backend\Tree\View\AbstractTreeView::getDataFree ( & $res )

Getting the tree data: frees data handle

Parameters

mixed $res ‪Data handle

Definition at line 967 of file AbstractTreeView.php.

Referenced by TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getTree().

◆ getDataInit()

mixed TYPO3\CMS\Backend\Tree\View\AbstractTreeView::getDataInit ( $parentId )

Getting the tree data: Selecting/Initializing data pointer to items for a certain parent id. For tables: This will make a database query to select all children to "parent" For arrays: This will return key to the ->dataLookup array

Parameters

int $parentId ‪parent item id

Returns: ‪mixed Data handle (Tables: An sql-resource, arrays: A parentId integer. -1 is returned if there were NO subLevel.)

Definition at line 878 of file AbstractTreeView.php.

References TYPO3\CMS\Core\Database\Query\QueryHelper\parseOrderBy(), TYPO3\CMS\Backend\Tree\View\AbstractTreeView\reset(), and TYPO3\CMS\Core\Database\Query\QueryHelper\stripLogicalOperatorPrefix().

Referenced by TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getCount(), and TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getTree().

◆ getDataNext()

array bool TYPO3\CMS\Backend\Tree\View\AbstractTreeView::getDataNext ( & $res )

Getting the tree data: next entry

Parameters

mixed $res ‪Data handle

Returns: ‪array|bool item data array OR FALSE if end of elements.

See also: ‪getDataInit()

Definition at line 939 of file AbstractTreeView.php.

References TYPO3\CMS\Backend\Tree\View\AbstractTreeView\$subLevelID, and TYPO3\CMS\Backend\Utility\BackendUtility\workspaceOL().

Referenced by TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getTree().

◆ getIcon()

string TYPO3\CMS\Backend\Tree\View\AbstractTreeView::getIcon ( $row )

Get icon for the row.

Parameters

array | int $row ‪Item row or uid

Returns: ‪string Image tag.

Definition at line 649 of file AbstractTreeView.php.

References TYPO3\CMS\Backend\Tree\View\AbstractTreeView\$title, TYPO3\CMS\Backend\Utility\BackendUtility\getRecord(), TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getTitleAttrib(), TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL, and TYPO3\CMS\Backend\Tree\View\AbstractTreeView\wrapIcon().

Referenced by TYPO3\CMS\Backend\View\PageTreeView\getBrowsableTree(), TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getBrowsableTree(), and TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getTree().

◆ getId()

int TYPO3\CMS\Backend\Tree\View\AbstractTreeView::getId ( $row )

Returns the id from the record (typ. uid)

Parameters

array $row ‪Record array

Returns: ‪int The "uid" field value.

Reimplemented in TYPO3\CMS\Backend\Tree\View\FolderTreeView.

Definition at line 694 of file AbstractTreeView.php.

Referenced by TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getJumpToParam(), TYPO3\CMS\Backend\View\PageTreeView\printTree(), TYPO3\CMS\Backend\Tree\View\AbstractTreeView\printTree(), TYPO3\CMS\Backend\Tree\View\BrowseTreeView\wrapIcon(), TYPO3\CMS\Backend\View\PageTreeView\wrapTitle(), and TYPO3\CMS\Backend\Tree\View\AbstractTreeView\wrapTitle().

◆ getJumpToParam()

string TYPO3\CMS\Backend\Tree\View\AbstractTreeView::getJumpToParam ( $row )

Returns jump-url parameter value.

Parameters

array $row ‪The record array.

Returns: ‪string The jump-url parameter.

Reimplemented in TYPO3\CMS\Backend\Tree\View\FolderTreeView.

Definition at line 705 of file AbstractTreeView.php.

References TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getId().

Referenced by TYPO3\CMS\Backend\View\PageTreeView\wrapIcon(), TYPO3\CMS\Backend\Tree\View\BrowseTreeView\wrapIcon(), TYPO3\CMS\Backend\View\PageTreeView\wrapTitle(), and TYPO3\CMS\Backend\Tree\View\AbstractTreeView\wrapTitle().

◆ getLanguageService()

LanguageService TYPO3\CMS\Backend\Tree\View\AbstractTreeView::getLanguageService ( )

protected

Returns: ‪LanguageService

Reimplemented in TYPO3\CMS\Backend\Tree\View\FolderTreeView.

Definition at line 1057 of file AbstractTreeView.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Tree\View\PageTreeView\getTitleStr(), TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getTitleStr(), and TYPO3\CMS\Impexp\View\ExportPageTreeView\wrapTitle().

◆ getMountPointPath()

string TYPO3\CMS\Backend\Tree\View\AbstractTreeView::getMountPointPath ( int $uid )

protected

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

Parameters

int $uid

Returns: ‪string

Definition at line 1033 of file AbstractTreeView.php.

References TYPO3\CMS\Backend\Utility\BackendUtility\BEgetRootLine(), TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getBackendUser(), and TYPO3\CMS\Backend\Utility\BackendUtility\getRecordWSOL().

Referenced by TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getBrowsableTree().

◆ getRecord()

array TYPO3\CMS\Backend\Tree\View\AbstractTreeView::getRecord ( $uid )

Returns the record for a uid. For tables: Looks up the record in the database. For arrays: Returns the fake record for uid id.

Parameters

int $uid ‪UID to look up

Returns: ‪array The record

Definition at line 859 of file AbstractTreeView.php.

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

Referenced by TYPO3\CMS\Backend\View\PageTreeView\getBrowsableTree(), and TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getBrowsableTree().

◆ getRootIcon()

string TYPO3\CMS\Backend\Tree\View\AbstractTreeView::getRootIcon ( $rec )

Returns the root icon for a tree/mountpoint (defaults to the globe)

Parameters

array $rec ‪Record for root.

Returns: ‪string Icon image tag.

Definition at line 637 of file AbstractTreeView.php.

References TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL, and TYPO3\CMS\Backend\Tree\View\AbstractTreeView\wrapIcon().

Referenced by TYPO3\CMS\Impexp\View\ExportPageTreeView\ext_tree(), TYPO3\CMS\Backend\View\PageTreeView\getBrowsableTree(), and TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getBrowsableTree().

◆ getRootRecord()

array TYPO3\CMS\Backend\Tree\View\AbstractTreeView::getRootRecord ( )

Returns root record for uid (<=0)

Returns: ‪array Array with title/uid keys with values of $this->title/0 (zero)

Definition at line 846 of file AbstractTreeView.php.

References TYPO3\CMS\Backend\Tree\View\AbstractTreeView\$title.

Referenced by TYPO3\CMS\Backend\View\PageTreeView\getBrowsableTree(), and TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getBrowsableTree().

◆ getThisScript()

string TYPO3\CMS\Backend\Tree\View\AbstractTreeView::getThisScript ( )

protected

Returns: ‪string

Definition at line 276 of file AbstractTreeView.php.

Referenced by TYPO3\CMS\Backend\View\PageTreeView\getBrowsableTree(), TYPO3\CMS\Backend\Tree\View\ElementBrowserFolderTreeView\PM_ATagWrap(), TYPO3\CMS\Backend\Tree\View\ElementBrowserPageTreeView\PM_ATagWrap(), TYPO3\CMS\Backend\Tree\View\AbstractTreeView\PM_ATagWrap(), TYPO3\CMS\Backend\Tree\View\ElementBrowserPageTreeView\printTree(), TYPO3\CMS\Backend\Tree\View\FolderTreeView\renderPMIconAndLink(), TYPO3\CMS\Backend\Tree\View\ElementBrowserFolderTreeView\wrapIcon(), TYPO3\CMS\Recordlist\Tree\View\ElementBrowserPageTreeView\wrapTitle(), TYPO3\CMS\Backend\Tree\View\ElementBrowserFolderTreeView\wrapTitle(), and TYPO3\CMS\Recordlist\Tree\View\RecordBrowserPageTreeView\wrapTitle().

◆ getTitleAttrib()

string TYPO3\CMS\Backend\Tree\View\AbstractTreeView::getTitleAttrib ( $row )

Returns the value for the image "title" attribute

Parameters

array $row ‪The input row array (where the key "title" is used for the title)

Returns: ‪string The attribute value (is htmlspecialchared() already)

See also: ‪wrapIcon()

Reimplemented in TYPO3\CMS\Backend\Tree\View\BrowseTreeView, and TYPO3\CMS\Backend\Tree\View\FolderTreeView.

Definition at line 683 of file AbstractTreeView.php.

Referenced by TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getIcon().

◆ getTitleStr()

string TYPO3\CMS\Backend\Tree\View\AbstractTreeView::getTitleStr	(	$row,
		$titleLen = `30`
	)

Returns the title for the input record. If blank, a "no title" label (localized) will be returned. Do NOT htmlspecialchar the string from this function - has already been done.

Parameters

array	$row	‪The input row array (where the key "title" is used for the title)
int	$titleLen	‪Title length (30)

Returns: ‪string The title.

Reimplemented in TYPO3\CMS\Backend\Tree\View\FolderTreeView, TYPO3\CMS\Backend\Tree\View\BrowseTreeView, and TYPO3\CMS\Backend\Tree\View\PageTreeView.

Definition at line 669 of file AbstractTreeView.php.

References TYPO3\CMS\Backend\Tree\View\AbstractTreeView\$title, and TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getLanguageService().

Referenced by TYPO3\CMS\Backend\Tree\View\AbstractTreeView\printTree().

◆ getTree()

int TYPO3\CMS\Backend\Tree\View\AbstractTreeView::getTree	(	$uid,
		$depth = `999`,
		$depthData = `''`
	)

Fetches the data for the tree

Parameters

int	$uid	‪item id for which to select subitems (parent id)
int	$depth	‪Max depth (recursivity limit)
string	$depthData	‪HTML-code prefix for recursive calls.

Returns: ‪int The count of items on the level

Definition at line 723 of file AbstractTreeView.php.

Referenced by TYPO3\CMS\Impexp\View\ExportPageTreeView\ext_tree(), TYPO3\CMS\Backend\View\PageTreeView\getBrowsableTree(), and TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getBrowsableTree().

◆ init()

TYPO3\CMS\Backend\Tree\View\AbstractTreeView::init	(	$clause = `''`,
		$orderByFields = `''`
	)

Initialize the tree class. Needs to be overwritten

Parameters

string	$clause	‪Record WHERE clause
string	$orderByFields	‪Record ORDER BY field

Reimplemented in TYPO3\CMS\Backend\Tree\View\BrowseTreeView, and TYPO3\CMS\Backend\Tree\View\PageTreeView.

Definition at line 287 of file AbstractTreeView.php.

References TYPO3\CMS\Backend\Tree\View\AbstractTreeView\$clause, $GLOBALS, and TYPO3\CMS\Backend\Tree\View\AbstractTreeView\$orderByFields.

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

◆ initializePositionSaving()

TYPO3\CMS\Backend\Tree\View\AbstractTreeView::initializePositionSaving ( )

Get stored tree structure AND updating it if needed according to incoming PM GET var.

Reimplemented in TYPO3\CMS\Backend\Tree\View\FolderTreeView, and TYPO3\CMS\Backend\Tree\View\PageTreeView.

Definition at line 591 of file AbstractTreeView.php.

References TYPO3\CMS\Backend\Tree\View\AbstractTreeView\savePosition().

Referenced by TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getBrowsableTree().

◆ PM_ATagWrap()

string TYPO3\CMS\Backend\Tree\View\AbstractTreeView::PM_ATagWrap	(	$icon,
		$cmd,
		$bMark = `''`,
		$isOpen = `false`
	)

Wrap the plus/minus icon in a link

Parameters

string	$icon	‪HTML string to wrap, probably an image tag.
string	$cmd	‪Command for 'PM' get var
string	$bMark	‪If set, the link will have an anchor point (=$bMark) and a name attribute (=$bMark)
bool	$isOpen

Returns: ‪string Link-wrapped input string

Reimplemented in TYPO3\CMS\Backend\Tree\View\ElementBrowserPageTreeView, TYPO3\CMS\Backend\Tree\View\ElementBrowserFolderTreeView, and TYPO3\CMS\Impexp\View\ExportPageTreeView.

Definition at line 499 of file AbstractTreeView.php.

References TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getThisScript().

Referenced by TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getBrowsableTree(), and TYPO3\CMS\Backend\Tree\View\AbstractTreeView\PMicon().

◆ PMicon()

string TYPO3\CMS\Backend\Tree\View\AbstractTreeView::PMicon	(	$row,
		$a,
		$c,
		$nextCount,
		$isOpen
	)

Generate the plus/minus icon for the browsable tree.

Parameters

array	$row	‪Record for the entry
int	$a	‪The current entry number
int	$c	‪The total number of entries. If equal to $a, a "bottom" element is returned.
int	$nextCount	‪The number of sub-elements to the current element.
bool	$isOpen	‪The element was expanded to render subelements if this flag is set.

Returns: ‪string Image tag with the plus/minus icon.

See also: ‪\TYPO3\CMS\Backend\Tree\View\PageTreeView::PMicon()

Reimplemented in TYPO3\CMS\Backend\Tree\View\PageTreeView, TYPO3\CMS\Backend\View\PageTreeView, and TYPO3\CMS\Backend\Tree\View\FolderTreeView.

Definition at line 479 of file AbstractTreeView.php.

References TYPO3\CMS\Backend\Tree\View\AbstractTreeView\PM_ATagWrap().

Referenced by TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getTree().

◆ printTree()

string TYPO3\CMS\Backend\Tree\View\AbstractTreeView::printTree ( $treeArr = '' )

Compiles the HTML code for displaying the structure found inside the ->tree array

Parameters

array | string $treeArr ‪"tree-array" - if blank string, the internal ->tree array is used.

Returns: ‪string The HTML code for the tree

Reimplemented in TYPO3\CMS\Backend\Tree\View\FolderTreeView, TYPO3\CMS\Backend\View\PageTreeView, TYPO3\CMS\Backend\Tree\View\ElementBrowserPageTreeView, and TYPO3\CMS\Recordlist\Tree\View\RecordBrowserPageTreeView.

Definition at line 413 of file AbstractTreeView.php.

References TYPO3\CMS\Backend\Tree\View\AbstractTreeView\$tree, TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getId(), TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getTitleStr(), and TYPO3\CMS\Backend\Tree\View\AbstractTreeView\wrapTitle().

Referenced by TYPO3\CMS\Backend\View\PageTreeView\getBrowsableTree(), and TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getBrowsableTree().

◆ reset()

TYPO3\CMS\Backend\Tree\View\AbstractTreeView::reset ( )

Resets the tree, recs, ids, ids_hierarchy and orig_ids_hierarchy internal variables. Use it if you need it.

Definition at line 327 of file AbstractTreeView.php.

Referenced by TYPO3\CMS\Impexp\View\ExportPageTreeView\ext_tree(), TYPO3\CMS\Backend\View\PageTreeView\getBrowsableTree(), TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getBrowsableTree(), TYPO3\CMS\Backend\Tree\View\FolderTreeView\getBrowseableTreeForStorage(), and TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getDataInit().

◆ savePosition()

TYPO3\CMS\Backend\Tree\View\AbstractTreeView::savePosition ( )

Saves the content of ->stored (keeps track of expanded positions in the tree) $this->treeName will be used as key for BE_USER->uc[] to store it in

Definition at line 620 of file AbstractTreeView.php.

References TYPO3\CMS\Backend\Tree\View\AbstractTreeView\$treeName.

Referenced by TYPO3\CMS\Backend\Tree\View\FolderTreeView\initializePositionSaving(), and TYPO3\CMS\Backend\Tree\View\AbstractTreeView\initializePositionSaving().

◆ setDataFromArray()

TYPO3\CMS\Backend\Tree\View\AbstractTreeView::setDataFromArray	(	&	$dataArr,
			$traverse = `false`,
			$pid = `0`
	)

Used to initialize class with an array to browse. The array inputted will be traversed and an internal index for lookup is created. The keys of the input array are perceived as "uid"s of records which means that keys GLOBALLY must be unique like uids are. "uid" and "pid" "fakefields" are also set in each record. All other fields are optional.

Parameters

array	$dataArr	‪The input array, see examples below in this script.
bool	$traverse	‪Internal, for recursion.
int	$pid	‪Internal, for recursion.

Deprecated:: ‪since TYPO3 v9, will be removed in TYPO3 v10.0.

Definition at line 987 of file AbstractTreeView.php.

References TYPO3\CMS\Backend\Tree\View\AbstractTreeView\$subLevelID.

◆ setDataFromTreeArray()

TYPO3\CMS\Backend\Tree\View\AbstractTreeView::setDataFromTreeArray	(	&	$treeArr,
		&	$treeLookupArr
	)

Sets the internal data arrays

Parameters

array	$treeArr	‪Content for $this->data
array	$treeLookupArr	‪Content for $this->dataLookup

Deprecated:: ‪since TYPO3 v9, will be removed in TYPO3 v10.0.

Definition at line 1020 of file AbstractTreeView.php.

◆ wrapIcon()

string TYPO3\CMS\Backend\Tree\View\AbstractTreeView::wrapIcon	(	$icon,
		$row
	)

Wrapping the image tag, $icon, for the row, $row (except for mount points)

Parameters

string	$icon	‪The image tag for the icon
array	$row	‪The row for the current element

Returns: ‪string The processed icon input value.

Reimplemented in TYPO3\CMS\Backend\View\PageTreeView, TYPO3\CMS\Filelist\FileListFolderTree, TYPO3\CMS\Backend\Tree\View\ElementBrowserPageTreeView, TYPO3\CMS\Backend\Tree\View\BrowseTreeView, TYPO3\CMS\Impexp\View\ExportPageTreeView, TYPO3\CMS\Backend\Tree\View\FolderTreeView, and TYPO3\CMS\Backend\Tree\View\ElementBrowserFolderTreeView.

Definition at line 533 of file AbstractTreeView.php.

Referenced by TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getIcon(), and TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getRootIcon().

◆ wrapStop()

string TYPO3\CMS\Backend\Tree\View\AbstractTreeView::wrapStop	(	$str,
		$row
	)

Adds a red "+" to the input string, $str, if the field "php_tree_stop" in the $row (pages) is set

Parameters

string	$str	‪Input string, like a page title for the tree
array	$row	‪record row with "php_tree_stop" field

Returns: ‪string Modified string

Definition at line 558 of file AbstractTreeView.php.

Referenced by TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getTree().

◆ wrapTitle()

string TYPO3\CMS\Backend\Tree\View\AbstractTreeView::wrapTitle	(	$title,
		$row,
		$bank = `0`
	)

Wrapping $title in a-tags.

Parameters

string	$title	‪Title string
array	$row	‪Item record
int	$bank	‪Bank pointer (which mount point number)

Returns: ‪string

Reimplemented in TYPO3\CMS\Backend\Tree\View\ElementBrowserPageTreeView, TYPO3\CMS\Recordlist\Tree\View\ElementBrowserPageTreeView, TYPO3\CMS\Backend\View\PageTreeView, TYPO3\CMS\Impexp\View\ExportPageTreeView, TYPO3\CMS\Recordlist\Tree\View\RecordBrowserPageTreeView, TYPO3\CMS\Backend\Tree\View\FolderTreeView, TYPO3\CMS\Backend\Tree\View\ElementBrowserFolderTreeView, and TYPO3\CMS\Filelist\FileListFolderTree.

Definition at line 519 of file AbstractTreeView.php.

References TYPO3\CMS\Backend\Tree\View\AbstractTreeView\$bank, TYPO3\CMS\Backend\Tree\View\AbstractTreeView\$title, TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getId(), and TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getJumpToParam().

Referenced by TYPO3\CMS\Backend\View\PageTreeView\printTree(), and TYPO3\CMS\Backend\Tree\View\AbstractTreeView\printTree().

Member Data Documentation

◆ $addSelfId

int TYPO3\CMS\Backend\Tree\View\AbstractTreeView::$addSelfId = 0

Definition at line 68 of file AbstractTreeView.php.

◆ $bank

int TYPO3\CMS\Backend\Tree\View\AbstractTreeView::$bank = 0

Definition at line 240 of file AbstractTreeView.php.

Referenced by TYPO3\CMS\Backend\Tree\View\FolderTreeView\generateExpandCollapseParameter(), TYPO3\CMS\Backend\View\PageTreeView\getBrowsableTree(), TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getBrowsableTree(), TYPO3\CMS\Backend\Tree\View\FolderTreeView\getBrowseableTreeForStorage(), TYPO3\CMS\Backend\Tree\View\FolderTreeView\getFolderTree(), TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getTree(), TYPO3\CMS\Filelist\FileListFolderTree\wrapTitle(), TYPO3\CMS\Backend\View\PageTreeView\wrapTitle(), TYPO3\CMS\Backend\Tree\View\FolderTreeView\wrapTitle(), and TYPO3\CMS\Backend\Tree\View\AbstractTreeView\wrapTitle().

◆ $BE_USER

TYPO3 CMS Core Authentication BackendUserAuthentication TYPO3\CMS\Backend\Tree\View\AbstractTreeView::$BE_USER = ''

Needs to be initialized with $GLOBALS['BE_USER'] Done by default in init()

Definition at line 87 of file AbstractTreeView.php.

◆ $buffer_idH

array TYPO3\CMS\Backend\Tree\View\AbstractTreeView::$buffer_idH = array( )

Definition at line 204 of file AbstractTreeView.php.

Referenced by TYPO3\CMS\Impexp\View\ExportPageTreeView\ext_tree(), and TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getTree().

◆ $clause

string TYPO3\CMS\Backend\Tree\View\AbstractTreeView::$clause = ''

WHERE clause used for selecting records for the tree. Is set by function init. Only makes sense when $this->table is set.

See also: ‪init()

Definition at line 118 of file AbstractTreeView.php.

Referenced by TYPO3\CMS\Backend\Tree\View\ElementBrowserPageTreeView\__construct(), TYPO3\CMS\Impexp\View\ExportPageTreeView\ext_tree(), TYPO3\CMS\Backend\Tree\View\PageTreeView\init(), TYPO3\CMS\Backend\Tree\View\BrowseTreeView\init(), and TYPO3\CMS\Backend\Tree\View\AbstractTreeView\init().

◆ $data

bool TYPO3\CMS\Backend\Tree\View\AbstractTreeView::$data = false

For arrays, holds the input data array

Deprecated:: ‪since TYPO3 v9, will be removed in TYPO3 v10.0.

Definition at line 217 of file AbstractTreeView.php.

◆ $dataLookup

bool TYPO3\CMS\Backend\Tree\View\AbstractTreeView::$dataLookup = false

For arrays, holds an index with references to the data array.

Deprecated:: ‪since TYPO3 v9, will be removed in TYPO3 v10.0.

Definition at line 224 of file AbstractTreeView.php.

◆ $defaultList

array TYPO3\CMS\Backend\Tree\View\AbstractTreeView::$defaultList = 'uid,pid,tstamp,sorting,deleted,perms_userid,perms_groupid,perms_user,perms_group,perms_everybody,crdate,cruser_id'

List of other fields which are ALLOWED to set (here, based on the "pages" table!)

See also: ‪addField()

Definition at line 141 of file AbstractTreeView.php.

◆ $domIdPrefix

string TYPO3\CMS\Backend\Tree\View\AbstractTreeView::$domIdPrefix = 'row'

A prefix for table cell id's which will be wrapped around an item. Can be used for highlighting by JavaScript. Needs to be unique if multiple trees are on one HTML page.

See also: ‪printTree()

Definition at line 160 of file AbstractTreeView.php.

◆ $expandAll

bool TYPO3\CMS\Backend\Tree\View\AbstractTreeView::$expandAll = false

Definition at line 43 of file AbstractTreeView.php.

Referenced by TYPO3\CMS\Backend\Tree\View\AbstractTreeView\expandNext().

◆ $expandFirst

bool TYPO3\CMS\Backend\Tree\View\AbstractTreeView::$expandFirst = false

Definition at line 38 of file AbstractTreeView.php.

Referenced by TYPO3\CMS\Impexp\View\ExportPageTreeView\ext_tree(), TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getBrowsableTree(), and TYPO3\CMS\Backend\Tree\View\FolderTreeView\getBrowseableTreeForStorage().

◆ $ext_IconMode

bool TYPO3\CMS\Backend\Tree\View\AbstractTreeView::$ext_IconMode = false

Definition at line 59 of file AbstractTreeView.php.

◆ $ext_showPathAboveMounts

bool TYPO3\CMS\Backend\Tree\View\AbstractTreeView::$ext_showPathAboveMounts = false

Definition at line 63 of file AbstractTreeView.php.

◆ $fieldArray

array TYPO3\CMS\Backend\Tree\View\AbstractTreeView::$fieldArray = array( 'uid', 'pid', 'title', 'is_siteroot' )

Default set of fields selected from the tree table. Make SURE that these fields names listed herein are actually possible to select from $this->table (if that variable is set to a TCA table name)

See also: ‪addField()

Definition at line 134 of file AbstractTreeView.php.

◆ $ids

array TYPO3\CMS\Backend\Tree\View\AbstractTreeView::$ids = array( )

Definition at line 189 of file AbstractTreeView.php.

Referenced by TYPO3\CMS\Impexp\View\ExportPageTreeView\ext_tree(), TYPO3\CMS\Backend\View\PageTreeView\getBrowsableTree(), and TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getBrowsableTree().

◆ $ids_hierarchy

array TYPO3\CMS\Backend\Tree\View\AbstractTreeView::$ids_hierarchy = array( )

Definition at line 194 of file AbstractTreeView.php.

◆ $makeHTML

int TYPO3\CMS\Backend\Tree\View\AbstractTreeView::$makeHTML = 1

If 1, HTML code is also accumulated in ->tree array during rendering of the tree

Definition at line 166 of file AbstractTreeView.php.

◆ $MOUNTS

array null TYPO3\CMS\Backend\Tree\View\AbstractTreeView::$MOUNTS

Needs to be initialized with e.g. $GLOBALS['BE_USER']->returnWebmounts() Default setting in init() is 0 => 0 The keys are mount-ids (can be anything basically) and the values are the ID of the root element (COULD be zero or anything else. For pages that would be the uid of the page, zero for the pagetree root.)

Definition at line 97 of file AbstractTreeView.php.

◆ $orderByFields

string TYPO3\CMS\Backend\Tree\View\AbstractTreeView::$orderByFields = ''

Field for ORDER BY. Is set by function init. Only makes sense when $this->table is set.

See also: ‪init()

Definition at line 126 of file AbstractTreeView.php.

Referenced by TYPO3\CMS\Backend\Tree\View\AbstractTreeView\init().

◆ $orig_ids_hierarchy

array TYPO3\CMS\Backend\Tree\View\AbstractTreeView::$orig_ids_hierarchy = array( )

Definition at line 199 of file AbstractTreeView.php.

◆ $parentField

string TYPO3\CMS\Backend\Tree\View\AbstractTreeView::$parentField = 'pid'

Defines the field of $table which is the parent id field (like pid for table pages).

Definition at line 110 of file AbstractTreeView.php.

◆ $recs

array TYPO3\CMS\Backend\Tree\View\AbstractTreeView::$recs = array( )

Definition at line 245 of file AbstractTreeView.php.

◆ $setDataFromArrayDeprecationThrown

bool TYPO3\CMS\Backend\Tree\View\AbstractTreeView::$setDataFromArrayDeprecationThrown = false

private

Deprecated:: ‪since TYPO3 v9, will be removed in TYPO3 v10.0

Definition at line 250 of file AbstractTreeView.php.

◆ $setRecs

int TYPO3\CMS\Backend\Tree\View\AbstractTreeView::$setRecs = 0

If TRUE, records as selected will be stored internally in the ->recs array

Definition at line 172 of file AbstractTreeView.php.

◆ $showDefaultTitleAttribute

bool TYPO3\CMS\Backend\Tree\View\AbstractTreeView::$showDefaultTitleAttribute = false

Definition at line 80 of file AbstractTreeView.php.

◆ $specUIDmap

array TYPO3\CMS\Backend\Tree\View\AbstractTreeView::$specUIDmap = array( )

Definition at line 210 of file AbstractTreeView.php.

◆ $stored

array TYPO3\CMS\Backend\Tree\View\AbstractTreeView::$stored = array( )

Definition at line 235 of file AbstractTreeView.php.

◆ $subLevelID

string TYPO3\CMS\Backend\Tree\View\AbstractTreeView::$subLevelID = '_SUB_LEVEL'

Sets the associative array key which identifies a new sublevel if arrays are used for trees. This value has formerly been "subLevel" and "--sublevel--"

Deprecated:: ‪since TYPO3 v9, will be removed in TYPO3 v10.0.

Definition at line 180 of file AbstractTreeView.php.

Referenced by TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getDataNext(), and TYPO3\CMS\Backend\Tree\View\AbstractTreeView\setDataFromArray().

◆ $table

string TYPO3\CMS\Backend\Tree\View\AbstractTreeView::$table = ''

Database table to get the tree data from. Leave blank if data comes from an array.

Definition at line 104 of file AbstractTreeView.php.

◆ $thisScript

string TYPO3\CMS\Backend\Tree\View\AbstractTreeView::$thisScript = ''

Definition at line 48 of file AbstractTreeView.php.

Referenced by TYPO3\CMS\Backend\Tree\View\FolderTreeView\PMiconATagWrap(), and TYPO3\CMS\Backend\Tree\View\ElementBrowserFolderTreeView\PMiconATagWrap().

◆ $title

string TYPO3\CMS\Backend\Tree\View\AbstractTreeView::$title = 'no title'

Definition at line 73 of file AbstractTreeView.php.

◆ $titleAttrib

string TYPO3\CMS\Backend\Tree\View\AbstractTreeView::$titleAttrib = 'title'

Definition at line 53 of file AbstractTreeView.php.

◆ $tree

array TYPO3\CMS\Backend\Tree\View\AbstractTreeView::$tree = array( )

Definition at line 230 of file AbstractTreeView.php.

Referenced by TYPO3\CMS\Recordlist\Tree\View\RecordBrowserPageTreeView\printTree(), TYPO3\CMS\Backend\Tree\View\ElementBrowserPageTreeView\printTree(), TYPO3\CMS\Backend\View\PageTreeView\printTree(), TYPO3\CMS\Backend\Tree\View\AbstractTreeView\printTree(), and TYPO3\CMS\Backend\Tree\View\FolderTreeView\printTree().

◆ $treeName

string TYPO3\CMS\Backend\Tree\View\AbstractTreeView::$treeName = ''

Unique name for the tree. Used as key for storing the tree into the BE users settings. Used as key to pass parameters in links. MUST NOT contain underscore chars. etc.

Definition at line 151 of file AbstractTreeView.php.

Referenced by TYPO3\CMS\Backend\Tree\View\AbstractTreeView\savePosition().

Public Member Functions

Public Attributes

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addField()

◆ addTagAttributes()

◆ determineScriptUrl()

◆ expandNext()

◆ getBackendUser()

◆ getBrowsableTree()

◆ getCount()

◆ getDataCount()

◆ getDataFree()

◆ getDataInit()

◆ getDataNext()

◆ getIcon()

◆ getId()

◆ getJumpToParam()

◆ getLanguageService()

◆ getMountPointPath()

◆ getRecord()

◆ getRootIcon()

◆ getRootRecord()

◆ getThisScript()

◆ getTitleAttrib()

◆ getTitleStr()

◆ getTree()

◆ init()

◆ initializePositionSaving()

◆ PM_ATagWrap()

◆ PMicon()

◆ printTree()

◆ reset()

◆ savePosition()

◆ setDataFromArray()

◆ setDataFromTreeArray()

◆ wrapIcon()

◆ wrapStop()

◆ wrapTitle()

Member Data Documentation

◆ $addSelfId

◆ $bank

◆ $BE_USER

◆ $buffer_idH

◆ $clause

◆ $data

◆ $dataLookup

◆ $defaultList

◆ $domIdPrefix

◆ $expandAll

◆ $expandFirst

◆ $ext_IconMode

◆ $ext_showPathAboveMounts

◆ $fieldArray

◆ $ids

◆ $ids_hierarchy

◆ $makeHTML

◆ $MOUNTS

◆ $orderByFields

◆ $orig_ids_hierarchy

◆ $parentField

◆ $recs

◆ $setDataFromArrayDeprecationThrown

◆ $setRecs

◆ $showDefaultTitleAttribute

◆ $specUIDmap

◆ $stored

◆ $subLevelID

◆ $table

◆ $thisScript

◆ $title

◆ $titleAttrib

◆ $tree

◆ $treeName