TYPO3\CMS\Backend\View\PageTreeView Class Reference

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

Public Member Functions
	__construct ()
	wrapTitle ($title, $row, $bank=0)
	printTree ($treeArr='')
	PMicon ($row, $a, $c, $nextCount, $exp)
	PMiconATagWrap ($icon, $cmd, $isExpand=true)
	getBrowsableTree ()
Public Member Functions inherited from TYPO3\CMS\Backend\Tree\View\BrowseTreeView
	init ($clause='', $orderByFields='')
	getTitleAttrib ($row)
	wrapIcon ($icon, $row)
	getTitleStr ($row, $titleLen=30)
Public Member Functions inherited from TYPO3\CMS\Backend\Tree\View\AbstractTreeView
	__construct ()
	init ($clause='', $orderByFields='')
	addField ($field, $noCheck=false)
	reset ()
	getBrowsableTree ()
	printTree ($treeArr='')
	PMicon ($row, $a, $c, $nextCount, $isOpen)
	PM_ATagWrap ($icon, $cmd, $bMark='', $isOpen=false)
	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='')
	getCount ($uid)
	getRootRecord ()
	getRecord ($uid)
	getDataInit ($parentId)
	getDataCount (&$res)
	getDataNext (&$res)
	getDataFree (&$res)
	setDataFromArray (&$dataArr, $traverse=false, $pid=0)
	setDataFromTreeArray (&$treeArr, &$treeLookupArr)

Public Attributes
	$ext_showPageId = false
	$ext_separateNotinmenuPages
	$ext_alphasortNotinmenuPages
	$ajaxStatus = false
Public Attributes inherited from TYPO3\CMS\Backend\Tree\View\BrowseTreeView
	$fieldArray
	$treeName = 'browsePages'
	$table = 'pages'
	$domIdPrefix = 'pages'
	$ext_showNavTitle = false
Public Attributes inherited from TYPO3\CMS\Backend\Tree\View\AbstractTreeView
	$expandFirst = 0
	$expandAll = 0
	$thisScript = ''
	$titleAttrib = 'title'
	$ext_IconMode = false
	$ext_showPathAboveMounts = false
	$addSelfId = 0
	$title = 'no title'
	$showDefaultTitleAttribute = false
	$BE_USER = ''
	$MOUNTS = null
	$table = ''
	$parentField = 'pid'
	$clause = ''
	$orderByFields = ''
	$fieldArray = ['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'
	$makeHTML = 1
	$setRecs = 0
	$subLevelID = '_SUB_LEVEL'
	$ids = []
	$ids_hierarchy = []
	$orig_ids_hierarchy = []
	$buffer_idH = []
	$specUIDmap = []
	$data = false
	$dataLookup = false
	$tree = []
	$stored = []
	$bank = 0
	$recs = []

Additional Inherited Members
Protected Member Functions inherited from TYPO3\CMS\Backend\Tree\View\AbstractTreeView
	determineScriptUrl ()
	getThisScript ()
	getLanguageService ()
	getBackendUser ()
	getDatabaseConnection ()

Detailed Description

Browse pages in Web module

Definition at line 26 of file PageTreeView.php.

Constructor & Destructor Documentation

__construct()

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

(

)

Calls init functions

Definition at line 53 of file PageTreeView.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\callUserFunction(), TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getJumpToParam(), TYPO3\CMS\Backend\Tree\View\BrowseTreeView\init(), TYPO3\CMS\Backend\Utility\BackendUtility\isRecordLocked(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), TYPO3\CMS\Core\Utility\GeneralUtility\quoteJSvalue(), TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL, TYPO3\CMS\Backend\Utility\BackendUtility\wrapClickMenuOnIcon(), and TYPO3\CMS\Backend\Tree\View\BrowseTreeView\wrapIcon().

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

Definition at line 280 of file PageTreeView.php.

References TYPO3\CMS\Backend\Tree\View\AbstractTreeView\$bank, TYPO3\CMS\Backend\Tree\View\AbstractTreeView\$ids, $uid, TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getIcon(), TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getRecord(), TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getRootIcon(), TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getRootRecord(), TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getThisScript(), TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getTree(), TYPO3\CMS\Backend\Tree\View\AbstractTreeView\initializePositionSaving(), TYPO3\CMS\Backend\View\PageTreeView\printTree(), and TYPO3\CMS\Backend\Tree\View\AbstractTreeView\reset().

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

Definition at line 244 of file PageTreeView.php.

References TYPO3\CMS\Backend\View\PageTreeView\PMiconATagWrap().

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
bool	$isExpand	Link-wrapped input string

Returns

string private

Definition at line 263 of file PageTreeView.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\quoteJSvalue().

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

$treeArr

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

Returns

string The HTML code for the tree

Definition at line 136 of file PageTreeView.php.

References TYPO3\CMS\Backend\Tree\View\AbstractTreeView\$tree, $uid, TYPO3\CMS\Core\Utility\GeneralUtility\_GP(), TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getId(), TYPO3\CMS\Backend\Tree\View\BrowseTreeView\getTitleStr(), if, and TYPO3\CMS\Backend\View\PageTreeView\wrapTitle().

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

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
int	$bank	Bank pointer (which mount point number)

Returns

string private

Definition at line 112 of file PageTreeView.php.

References TYPO3\CMS\Backend\Tree\View\AbstractTreeView\$bank, $GLOBALS, TYPO3\CMS\Backend\Tree\View\AbstractTreeView\$title, TYPO3\CMS\Core\Utility\GeneralUtility\callUserFunction(), TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getId(), TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getJumpToParam(), TYPO3\CMS\Core\Utility\GeneralUtility\implodeAttributes(), TYPO3\CMS\Core\Utility\GeneralUtility\quoteJSvalue(), and TYPO3\CMS\Backend\Utility\BackendUtility\wrapClickMenuOnIcon().

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

Member Data Documentation

$ajaxStatus

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

Definition at line 48 of file PageTreeView.php.

$ext_alphasortNotinmenuPages

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

Definition at line 41 of file PageTreeView.php.

$ext_separateNotinmenuPages

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

Definition at line 36 of file PageTreeView.php.

$ext_showPageId

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

Definition at line 31 of file PageTreeView.php.