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

Public Member Functions
	init ($clause='', $orderByFields='')

	setTreeName ($treeName='')

	addField ($field, $noCheck=0)

	reset ()

	getBrowsableTree ()

	printTree ($treeArr='')

	PMicon ($row, $a, $c, $nextCount, $exp)

	PM_ATagWrap ($icon, $cmd, $bMark='')

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

	wrapIcon ($icon, $row)

	addTagAttributes ($icon, $attr)

	wrapStop ($str, $row)

	expandNext ($id)

	initializePositionSaving ()

	savePosition ()

	getRootIcon ($rec)

	getIcon ($row)

	getTitleStr ($row, $titleLen=30)

	getTitleAttrib ($row)

	getId ($row)

	getJumpToParam ($row)

	getTree ($uid, $depth=999, $depthData='', $blankLineCode='', $subCSSclass='')

	getCount ($uid)

	getRootRecord ($uid)

	getRecord ($uid)

	getDataInit ($parentId, $subCSSclass='')

	getDataCount (&$res)

	getDataNext (&$res, $subCSSclass='')

	getDataFree (&$res)

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

	setDataFromTreeArray (&$treeArr, &$treeLookupArr)

Public Attributes
	$expandFirst = 0

	$expandAll = 0

	$thisScript = ''

	$titleAttrib = 'title'

	$ext_IconMode = FALSE

	$addSelfId = 0

	$title = 'no title'

	$showDefaultTitleAttribute = FALSE

	$highlightPagesWithVersions = TRUE

	$BE_USER = ''

	$MOUNTS = ''

	$table = ''

	$parentField = 'pid'

	$clause = ''

	$orderByFields = ''

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

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

	$treeName = ''

	$domIdPrefix = 'row'

	$backPath

	$iconPath = ''

	$iconName = 'default.gif'

	$makeHTML = 1

	$setRecs = 0

	$subLevelID = '_SUB_LEVEL'

	$ids = array()

	$ids_hierarchy = array()

	$orig_ids_hierarchy = array()

	$buffer_idH = array()

	$specUIDmap = array()

	$data = FALSE

	$dataLookup = FALSE

	$tree = array()

	$stored = array()

	$bank = 0

	$recs = array()

Protected Member Functions
	determineScriptUrl ()

	getThisScript ()

	hasPageRecordVersions ($workspaceId, $pageId)

	getWorkspaceService ()

Protected Attributes
	$workspaceService = NULL

Detailed Description

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

Author: Kasper Skårhøj kaspe.nosp@m.rYYY.nosp@m.Y@typ.nosp@m.o3.c.nosp@m.om; René Fritz r.fri.nosp@m.tz@c.nosp@m.olorc.nosp@m.ube..nosp@m.de

Definition at line 28 of file AbstractTreeView.php.

Member Function Documentation

◆ addField()

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

Adds a fieldname to the internal array ->fieldArray

Parameters

string	$field	Field name to
boolean	$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

Returns: void

Todo:: Define visibility

Definition at line 376 of file AbstractTreeView.php.

References $GLOBALS, and TYPO3\CMS\Core\Utility\GeneralUtility\inList().

◆ addTagAttributes()

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.

Todo:: Define visibility

Definition at line 583 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 306 of file AbstractTreeView.php.

References $moduleName, TYPO3\CMS\Core\Utility\GeneralUtility\_GP(), TYPO3\CMS\Core\Utility\GeneralUtility\getIndpEnv(), and TYPO3\CMS\Backend\Utility\BackendUtility\getModuleUrl().

Referenced by localPageTree\__construct().

◆ expandNext()

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

integer $id Record id/key

Returns: boolean private

See also: ::expandNext()

Todo:: Define visibility

Definition at line 619 of file AbstractTreeView.php.

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

◆ getBrowsableTree()

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

Todo:: Define visibility

Definition at line 408 of file AbstractTreeView.php.

◆ getCount()

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

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

Parameters

integer $uid Id to count subitems for

Returns: integer private

Todo:: Define visibility

Definition at line 861 of file AbstractTreeView.php.

◆ getDataCount()

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

Getting the tree data: Counting elements in resource

Parameters

mixed $res Data handle

Returns: integer number of items private

See also: getDataInit()

Todo:: Define visibility

Definition at line 932 of file AbstractTreeView.php.

◆ getDataFree()

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

Getting the tree data: frees data handle

Parameters

mixed $res Data handle

Returns: void private

Todo:: Define visibility

Definition at line 994 of file AbstractTreeView.php.

◆ getDataInit()

TYPO3\CMS\Backend\Tree\View\AbstractTreeView::getDataInit	(	$parentId,
		$subCSSclass = `''`
	)

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

integer	$parentId	parent item id
string	$subCSSclass	Class for sub-elements.

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

Todo:: Define visibility

Definition at line 909 of file AbstractTreeView.php.

◆ getDataNext()

TYPO3\CMS\Backend\Tree\View\AbstractTreeView::getDataNext	(	&	$res,
			$subCSSclass = `''`
	)

Getting the tree data: next entry

Parameters

mixed	$res	Data handle
string	$subCSSclass	CSS class for sub elements (workspace related)

Returns: array item data array OR FALSE if end of elements. private

See also: getDataInit()

Todo:: Define visibility

Definition at line 951 of file AbstractTreeView.php.

◆ getIcon()

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

Get icon for the row. If $this->iconPath and $this->iconName is set, try to get icon based on those values.

Parameters

array $row Item row.

Returns: string Image tag.

Todo:: Define visibility

Definition at line 689 of file AbstractTreeView.php.

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

◆ getId()

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

Returns the id from the record (typ. uid)

Parameters

array $row Record array

Returns: integer The "uid" field value.

Todo:: Define visibility

Definition at line 742 of file AbstractTreeView.php.

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

◆ getJumpToParam()

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.

Todo:: Define visibility

Definition at line 753 of file AbstractTreeView.php.

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

◆ getRecord()

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

integer $uid UID to look up

Returns: array The record

Todo:: Define visibility

Definition at line 890 of file AbstractTreeView.php.

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

◆ getRootIcon()

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.

Todo:: Define visibility

Definition at line 677 of file AbstractTreeView.php.

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

◆ getRootRecord()

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

Returns root record for uid (<=0)

Parameters

integer $uid uid, <= 0 (normally, this does not matter)

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

Todo:: Define visibility

Definition at line 877 of file AbstractTreeView.php.

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

◆ getThisScript()

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

protected

Returns: string

Definition at line 317 of file AbstractTreeView.php.

Referenced by TYPO3\CMS\Backend\Tree\View\AbstractTreeView\PM_ATagWrap(), TYPO3\CMS\Rtehtmlarea\PageTree\printTree(), and TYPO3\CMS\Rtehtmlarea\FolderTree\wrapTitle().

◆ getTitleAttrib()

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()

Todo:: Define visibility

Definition at line 731 of file AbstractTreeView.php.

◆ getTitleStr()

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)
integer	$titleLen	Title length (30)

Returns: string The title.

Todo:: Define visibility

Definition at line 710 of file AbstractTreeView.php.

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

◆ getTree()

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

Fetches the data for the tree

Parameters

integer	$uid	item id for which to select subitems (parent id)
integer	$depth	Max depth (recursivity limit)
string	$depthData	HTML-code prefix for recursive calls.
string	$blankLineCode	? (internal)
string	$subCSSclass	CSS class to use for

sub-elements

Returns: integer The count of items on the level

Todo:: Define visibility

Definition at line 773 of file AbstractTreeView.php.

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

◆ getWorkspaceService()

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

protected

Returns: ;

Definition at line 1061 of file AbstractTreeView.php.

References TYPO3\CMS\Backend\Tree\View\AbstractTreeView\$workspaceService, and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

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

◆ hasPageRecordVersions()

TYPO3\CMS\Backend\Tree\View\AbstractTreeView::hasPageRecordVersions	(	$workspaceId,
		$pageId
	)

protected

Parameters

int	$workspaceId
int	$pageId

Returns: bool

Definition at line 1049 of file AbstractTreeView.php.

References TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getWorkspaceService(), and TYPO3\CMS\Core\Utility\ExtensionManagementUtility\isLoaded().

◆ init()

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

Initialize the tree class. Needs to be overwritten Will set ->fieldsArray, ->backPath and ->clause

Parameters

string	Record WHERE clause
string	Record ORDER BY field

Returns: void

Todo:: Define visibility

Definition at line 330 of file AbstractTreeView.php.

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

◆ initializePositionSaving()

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

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

Returns: void private

Todo:: Define visibility

Definition at line 630 of file AbstractTreeView.php.

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

◆ PM_ATagWrap()

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

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
boolean	$bMark	If set, the link will have a anchor point (=$bMark) and a name attribute (=$bMark)

Returns: string Link-wrapped input string private

Todo:: Define visibility

Definition at line 534 of file AbstractTreeView.php.

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

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

◆ PMicon()

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

Generate the plus/minus icon for the browsable tree.

Parameters

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

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

See also: ::PMicon()

Todo:: Define visibility

Definition at line 512 of file AbstractTreeView.php.

References TYPO3\CMS\Backend\Utility\IconUtility\getSpriteIcon(), and TYPO3\CMS\Backend\Tree\View\AbstractTreeView\PM_ATagWrap().

◆ printTree()

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

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

Parameters

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

Returns: string The HTML code for the tree

Todo:: Define visibility

Definition at line 464 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(), if, and TYPO3\CMS\Backend\Tree\View\AbstractTreeView\wrapTitle().

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

◆ 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.

Returns: void

Todo:: Define visibility

Definition at line 388 of file AbstractTreeView.php.

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

◆ 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

Returns: void private

Todo:: Define visibility

Definition at line 660 of file AbstractTreeView.php.

Referenced by TYPO3\CMS\Backend\Tree\View\FolderTreeView\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.
boolean	$traverse	Internal, for recursion.
integer	$pid	Internal, for recursion.

Returns: void

Todo:: Define visibility

Definition at line 1013 of file AbstractTreeView.php.

References $uid.

◆ 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

Returns: void

Todo:: Define visibility

Definition at line 1039 of file AbstractTreeView.php.

◆ setTreeName()

TYPO3\CMS\Backend\Tree\View\AbstractTreeView::setTreeName ( $treeName = '' )

Sets the tree name which is used to identify the tree Used for JavaScript and other things

Parameters

string $treeName Default is the table name. Underscores are stripped.

Returns: void

Todo:: Define visibility

Definition at line 362 of file AbstractTreeView.php.

References TYPO3\CMS\Backend\Tree\View\AbstractTreeView\$table, and TYPO3\CMS\Backend\Tree\View\AbstractTreeView\$treeName.

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

◆ wrapIcon()

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. private

Todo:: Define visibility

Definition at line 571 of file AbstractTreeView.php.

◆ wrapStop()

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 private

Todo:: Define visibility

Definition at line 596 of file AbstractTreeView.php.

◆ wrapTitle()

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

Wrapping $title in a-tags.

Parameters

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

Returns: string private

Todo:: Define visibility

Definition at line 557 of file AbstractTreeView.php.

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

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

Member Data Documentation

◆ $addSelfId

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

Todo:: Define visibility

Definition at line 66 of file AbstractTreeView.php.

◆ $backPath

TYPO3\CMS\Backend\Tree\View\AbstractTreeView::$backPath

Back path for icons

Todo:: Define visibility

Definition at line 186 of file AbstractTreeView.php.

◆ $bank

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

Todo:: Define visibility

Definition at line 290 of file AbstractTreeView.php.

Referenced by TYPO3\CMS\Filelist\FileListFolderTree\wrapTitle().

◆ $BE_USER

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

Definition at line 97 of file AbstractTreeView.php.

◆ $buffer_idH

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

Todo:: Define visibility

Definition at line 251 of file AbstractTreeView.php.

Referenced by TYPO3\CMS\Impexp\LocalPageTree\ext_tree().

◆ $clause

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()

Todo:: Define visibility

Definition at line 132 of file AbstractTreeView.php.

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

◆ $data

TYPO3\CMS\Backend\Tree\View\AbstractTreeView::$data = FALSE

Todo:: Define visibility

Definition at line 265 of file AbstractTreeView.php.

◆ $dataLookup

TYPO3\CMS\Backend\Tree\View\AbstractTreeView::$dataLookup = FALSE

Todo:: Define visibility

Definition at line 271 of file AbstractTreeView.php.

◆ $defaultList

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()

Todo:: Define visibility

Definition at line 158 of file AbstractTreeView.php.

◆ $domIdPrefix

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()

Todo:: Define visibility

Definition at line 179 of file AbstractTreeView.php.

◆ $expandAll

TYPO3\CMS\Backend\Tree\View\AbstractTreeView::$expandAll = 0

Todo:: Define visibility

Definition at line 41 of file AbstractTreeView.php.

◆ $expandFirst

TYPO3\CMS\Backend\Tree\View\AbstractTreeView::$expandFirst = 0

Todo:: Define visibility

Definition at line 35 of file AbstractTreeView.php.

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

◆ $ext_IconMode

TYPO3\CMS\Backend\Tree\View\AbstractTreeView::$ext_IconMode = FALSE

Todo:: Define visibility

Definition at line 60 of file AbstractTreeView.php.

◆ $fieldArray

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

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()

Todo:: Define visibility

Definition at line 150 of file AbstractTreeView.php.

◆ $highlightPagesWithVersions

TYPO3\CMS\Backend\Tree\View\AbstractTreeView::$highlightPagesWithVersions = TRUE

Todo:: Define visibility

Definition at line 88 of file AbstractTreeView.php.

◆ $iconName

TYPO3\CMS\Backend\Tree\View\AbstractTreeView::$iconName = 'default.gif'

Icon file name for item icons.

Todo:: Define visibility

Definition at line 200 of file AbstractTreeView.php.

◆ $iconPath

TYPO3\CMS\Backend\Tree\View\AbstractTreeView::$iconPath = ''

Icon file path.

Todo:: Define visibility

Definition at line 193 of file AbstractTreeView.php.

◆ $ids

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

Todo:: Define visibility

Definition at line 233 of file AbstractTreeView.php.

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

◆ $ids_hierarchy

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

Todo:: Define visibility

Definition at line 239 of file AbstractTreeView.php.

◆ $makeHTML

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

If TRUE, HTML code is also accumulated in ->tree array during rendering of the tree. If 2, then also the icon prefix code (depthData) is stored

Todo:: Define visibility

Definition at line 208 of file AbstractTreeView.php.

◆ $MOUNTS

TYPO3\CMS\Backend\Tree\View\AbstractTreeView::$MOUNTS = ''

Needs to be initialized with e.g. $GLOBALS['WEBMOUNTS'] 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.)

Todo:: Define visibility

Definition at line 108 of file AbstractTreeView.php.

◆ $orderByFields

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()

Todo:: Define visibility

Definition at line 141 of file AbstractTreeView.php.

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

◆ $orig_ids_hierarchy

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

Todo:: Define visibility

Definition at line 245 of file AbstractTreeView.php.

◆ $parentField

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

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

Todo:: Define visibility

Definition at line 123 of file AbstractTreeView.php.

◆ $recs

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

Todo:: Define visibility

Definition at line 296 of file AbstractTreeView.php.

◆ $setRecs

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

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

Todo:: Define visibility

Definition at line 215 of file AbstractTreeView.php.

◆ $showDefaultTitleAttribute

TYPO3\CMS\Backend\Tree\View\AbstractTreeView::$showDefaultTitleAttribute = FALSE

Todo:: Define visibility

Definition at line 80 of file AbstractTreeView.php.

◆ $specUIDmap

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

Todo:: Define visibility

Definition at line 258 of file AbstractTreeView.php.

◆ $stored

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

Todo:: Define visibility

Definition at line 284 of file AbstractTreeView.php.

◆ $subLevelID

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--"

Todo:: Define visibility

Definition at line 223 of file AbstractTreeView.php.

◆ $table

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

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

Todo:: Define visibility

Definition at line 116 of file AbstractTreeView.php.

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

◆ $thisScript

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

Todo:: Define visibility

Definition at line 47 of file AbstractTreeView.php.

◆ $title

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

Todo:: Define visibility

Definition at line 72 of file AbstractTreeView.php.

Referenced by TYPO3\CMS\Impexp\LocalPageTree\wrapTitle(), and TYPO3\CMS\Filelist\FileListFolderTree\wrapTitle().

◆ $titleAttrib

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

Todo:: Define visibility

Definition at line 53 of file AbstractTreeView.php.

◆ $tree

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

Todo:: Define visibility

Definition at line 278 of file AbstractTreeView.php.

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

◆ $treeName

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.

Todo:: Define visibility

Definition at line 169 of file AbstractTreeView.php.

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

◆ $workspaceService

TYPO3\CMS\Backend\Tree\View\AbstractTreeView::$workspaceService = NULL

protected

Definition at line 301 of file AbstractTreeView.php.

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

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ addField()

◆ addTagAttributes()

◆ determineScriptUrl()

◆ expandNext()

◆ getBrowsableTree()

◆ getCount()

◆ getDataCount()

◆ getDataFree()

◆ getDataInit()

◆ getDataNext()

◆ getIcon()

◆ getId()

◆ getJumpToParam()

◆ getRecord()

◆ getRootIcon()

◆ getRootRecord()

◆ getThisScript()

◆ getTitleAttrib()

◆ getTitleStr()

◆ getTree()

◆ getWorkspaceService()

◆ hasPageRecordVersions()

◆ init()

◆ initializePositionSaving()

◆ PM_ATagWrap()

◆ PMicon()

◆ printTree()

◆ reset()

◆ savePosition()

◆ setDataFromArray()

◆ setDataFromTreeArray()

◆ setTreeName()

◆ wrapIcon()

◆ wrapStop()

◆ wrapTitle()

Member Data Documentation

◆ $addSelfId

◆ $backPath

◆ $bank

◆ $BE_USER

◆ $buffer_idH

◆ $clause

◆ $data

◆ $dataLookup

◆ $defaultList

◆ $domIdPrefix

◆ $expandAll

◆ $expandFirst

◆ $ext_IconMode

◆ $fieldArray

◆ $highlightPagesWithVersions

◆ $iconName

◆ $iconPath

◆ $ids

◆ $ids_hierarchy

◆ $makeHTML

◆ $MOUNTS

◆ $orderByFields

◆ $orig_ids_hierarchy

◆ $parentField

◆ $recs

◆ $setRecs

◆ $showDefaultTitleAttribute

◆ $specUIDmap

◆ $stored

◆ $subLevelID

◆ $table

◆ $thisScript

◆ $title

◆ $titleAttrib

◆ $tree

◆ $treeName

◆ $workspaceService