TYPO3\CMS\Backend\View\PageTreeView Class Reference

Inheritance diagram for TYPO3\CMS\Backend\View\PageTreeView:

Public Member Functions
	__construct ()
	wrapIcon ($thePageIcon, &$row)
	wrapStop ($str, $row)
	wrapTitle ($title, $row, $bank=0)
	printTree ($treeArr='')
	PMicon ($row, $a, $c, $nextCount, $exp)
	PMiconATagWrap ($icon, $cmd, $isExpand=TRUE)
	getBrowsableTree ()
	getTree ($uid, $depth=999, $blankLineCode='', $subCSSclass='')
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
	$ext_IconMode
	$ext_separateNotinmenuPages
	$ext_alphasortNotinmenuPages
	$ajaxStatus = 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

Browse pages in Web module

Author

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

Benjamin Mack bmack.nosp@m.@xno.nosp@m.s.org

Definition at line 26 of file PageTreeView.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Backend\View\PageTreeView::__construct

(

)

Calls init functions

Todo:

Define visibility

Definition at line 59 of file PageTreeView.php.

References TYPO3\CMS\Backend\Tree\View\BrowseTreeView\init().

Member Function Documentation

getBrowsableTree()

TYPO3\CMS\Backend\View\PageTreeView::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 298 of file PageTreeView.php.

getTree()

TYPO3\CMS\Backend\View\PageTreeView::getTree	(		$uid,
			$depth = 999,
			$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	$blankLineCode	? (internal)
string	$subCSSclass

Returns

integer The count of items on the level

Todo:

Define visibility

Definition at line 359 of file PageTreeView.php.

PMicon()

TYPO3\CMS\Backend\View\PageTreeView::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 261 of file PageTreeView.php.

References TYPO3\CMS\Backend\View\PageTreeView\PMiconATagWrap(), and TYPO3\CMS\Backend\Utility\IconUtility\skinImg().

PMiconATagWrap()

TYPO3\CMS\Backend\View\PageTreeView::PMiconATagWrap	(		$icon,
			$cmd,
			$isExpand = TRUE
	)

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

Returns

boolean $isExpand Link-wrapped input string private

Todo:

Define visibility

Definition at line 281 of file PageTreeView.php.

Referenced by TYPO3\CMS\Backend\View\PageTreeView\PMicon().

printTree()

TYPO3\CMS\Backend\View\PageTreeView::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 153 of file PageTreeView.php.

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

wrapIcon()

TYPO3\CMS\Backend\View\PageTreeView::wrapIcon	(		$thePageIcon,
		&	$row
	)

Wrapping icon in browse tree

Parameters

string	$thePageIcon	Icon IMG code
array	$row	Data row for element.

Returns

string Page icon

Todo:

Define visibility

Definition at line 71 of file PageTreeView.php.

References $GLOBALS, TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getJumpToParam(), TYPO3\CMS\Backend\Utility\IconUtility\getSpriteIcon(), TYPO3\CMS\Backend\Utility\BackendUtility\isRecordLocked(), and TYPO3\CMS\Core\Utility\GeneralUtility\quoteJSvalue().

wrapStop()

TYPO3\CMS\Backend\View\PageTreeView::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 113 of file PageTreeView.php.

wrapTitle()

TYPO3\CMS\Backend\View\PageTreeView::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 130 of file PageTreeView.php.

Referenced by TYPO3\CMS\Backend\View\PageTreeView\printTree().

Member Data Documentation

$ajaxStatus

TYPO3\CMS\Backend\View\PageTreeView::$ajaxStatus = FALSE

Todo:

Define visibility

Definition at line 52 of file PageTreeView.php.

$ext_alphasortNotinmenuPages

TYPO3\CMS\Backend\View\PageTreeView::$ext_alphasortNotinmenuPages

Todo:

Define visibility

Definition at line 46 of file PageTreeView.php.

$ext_IconMode

TYPO3\CMS\Backend\View\PageTreeView::$ext_IconMode

Todo:

Define visibility

Definition at line 36 of file PageTreeView.php.

$ext_separateNotinmenuPages

TYPO3\CMS\Backend\View\PageTreeView::$ext_separateNotinmenuPages

Todo:

Define visibility

Definition at line 41 of file PageTreeView.php.

$ext_showPageId

TYPO3\CMS\Backend\View\PageTreeView::$ext_showPageId

Todo:

Define visibility

Definition at line 31 of file PageTreeView.php.