localPageTree Class Reference

Inheritance diagram for localPageTree:

Public Member Functions
	__construct ()
	wrapTitle ($title, $v, $ext_pArrPages='')
	printTree ($treeArr='')
	ext_isLinkable ($doktype, $uid)
	PM_ATagWrap ($icon, $cmd, $bMark='')
	wrapIcon ($icon, $row)
Public Member Functions inherited from TYPO3\CMS\Backend\Tree\View\BrowseTreeView
	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)

Public Attributes
	$ext_showPageId = FALSE
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()

Additional Inherited Members
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

Class which generates the page tree

Author

Kasper Skårhøj kaspe.nosp@m.rYYY.nosp@m.Y@typ.nosp@m.o3.c.nosp@m.om

Definition at line 7 of file class.browse_links.php.

Constructor & Destructor Documentation

__construct()

localPageTree::__construct

(

)

Constructor. Just calling init()

Todo:

Define visibility

Definition at line 22 of file class.browse_links.php.

References TYPO3\CMS\Backend\Tree\View\AbstractTreeView\$clause, TYPO3\CMS\Backend\Tree\View\AbstractTreeView\determineScriptUrl(), TYPO3\CMS\Frontend\Page\PageRepository\DOKTYPE_RECYCLER, and TYPO3\CMS\Backend\Tree\View\BrowseTreeView\init().

Member Function Documentation

ext_isLinkable()

localPageTree::ext_isLinkable	(		$doktype,
			$uid
	)

Returns TRUE if a doktype can be linked.

Parameters

integer	$doktype	Doktype value to test
integer	$uid	uid to test.

Returns

boolean

Todo:

Define visibility

Definition at line 96 of file class.browse_links.php.

Referenced by TYPO3\CMS\Rtehtmlarea\PageTree\printTree(), and wrapTitle().

PM_ATagWrap()

localPageTree::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

Todo:

Define visibility

Definition at line 111 of file class.browse_links.php.

printTree()

localPageTree::printTree

(

$treeArr = ''

)

Create the page navigation tree in HTML

Parameters

array

$treeArr

Tree array

Returns

string HTML output.

Todo:

Define visibility

Definition at line 53 of file class.browse_links.php.

wrapIcon()

localPageTree::wrapIcon	(		$icon,
			$row
	)

Wrapping the image tag, $icon, for the row, $row

Parameters

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

Returns

string The processed icon input value.

Todo:

Define visibility

Definition at line 129 of file class.browse_links.php.

wrapTitle()

localPageTree::wrapTitle	(		$title,
			$v,
			$ext_pArrPages = ''
	)

Wrapping the title in a link, if applicable.

Parameters

string	$title	Title, (must be ready for output, that means it must be htmlspecialchars()'ed).
array	$v	The record
boolean	$ext_pArrPages	(Ignore)

Returns

string Wrapping title string.

Todo:

Define visibility

Definition at line 37 of file class.browse_links.php.

References ext_isLinkable().

Referenced by TYPO3\CMS\Rtehtmlarea\PageTree\printTree().

Member Data Documentation

$ext_showPageId

localPageTree::$ext_showPageId = FALSE

whether the page ID should be shown next to the title, activate through userTSconfig (options.pageTree.showPageIdWithTitle)

Definition at line 15 of file class.browse_links.php.