TYPO3\CMS\Backend\Tree\View\BrowseTreeView Class Reference

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

Public Member Functions
	init ($clause='', $orderByFields='')
	getTitleAttrib ($row)
	wrapIcon ($icon, $row)
	getTitleStr ($row, $titleLen=30)
	wrapStop ($str, $row)
Public Member Functions inherited from TYPO3\CMS\Backend\Tree\View\AbstractTreeView
	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)

Additional Inherited Members
Public Attributes inherited from TYPO3\CMS\Backend\Tree\View\AbstractTreeView
	$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 inherited from TYPO3\CMS\Backend\Tree\View\AbstractTreeView
	determineScriptUrl ()
	getThisScript ()
	hasPageRecordVersions ($workspaceId, $pageId)
	getWorkspaceService ()
Protected Attributes inherited from TYPO3\CMS\Backend\Tree\View\AbstractTreeView
	$workspaceService = NULL

Detailed Description

Generate a page-tree, browsable.

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 25 of file BrowseTreeView.php.

Member Function Documentation

getTitleAttrib()

TYPO3\CMS\Backend\Tree\View\BrowseTreeView::getTitleAttrib

(

$row

)

Creates title attribute content for pages. Uses API function in which will retrieve lots of useful information for pages.

Parameters

array

$row

The table row.

Returns

string

Todo:

Define visibility

Definition at line 69 of file BrowseTreeView.php.

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

getTitleStr()

TYPO3\CMS\Backend\Tree\View\BrowseTreeView::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 103 of file BrowseTreeView.php.

Referenced by TYPO3\CMS\Rtehtmlarea\PageTree\printTree(), and TYPO3\CMS\Backend\View\PageTreeView\printTree().

init()

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

Initialize, setting what is necessary for browsing pages. Using the current user.

Parameters

string	$clause	Additional clause for selecting pages.
string	$orderByFields	record ORDER BY field

Returns

void

Todo:

Define visibility

Definition at line 36 of file BrowseTreeView.php.

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

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

wrapIcon()

TYPO3\CMS\Backend\Tree\View\BrowseTreeView::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 82 of file BrowseTreeView.php.

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

wrapStop()

TYPO3\CMS\Backend\Tree\View\BrowseTreeView::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 123 of file BrowseTreeView.php.