TYPO3\CMS\Backend\View\PageTreeView Class Reference

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

Public Member Functions
	__construct ()
string	wrapIcon ($thePageIcon, $row)
string	wrapTitle ($title, $row, $bank=0)
string	printTree ($treeArr='')
string	PMicon ($row, $a, $c, $nextCount, $exp)
string	PMiconATagWrap ($icon, $cmd, $isExpand=true)
string	getBrowsableTree ()
‪Public Member Functions inherited from ‪TYPO3\CMS\Backend\Tree\View\BrowseTreeView
	init ($clause='', $orderByFields='')
string	getTitleAttrib ($row)
string	getTitleStr ($row, $titleLen=30)
‪Public Member Functions inherited from ‪TYPO3\CMS\Backend\Tree\View\AbstractTreeView
	addField ($field, $noCheck=false)
	reset ()
string	PM_ATagWrap ($icon, $cmd, $bMark='', $isOpen=false)
string	addTagAttributes ($icon, $attr)
string	wrapStop ($str, $row)
bool	expandNext ($id)
	initializePositionSaving ()
	savePosition ()
string	getRootIcon ($rec)
string	getIcon ($row)
int	getId ($row)
string	getJumpToParam ($row)
int	getTree ($uid, $depth=999, $depthData='')
int	getCount ($uid)
array	getRootRecord ()
array	getRecord ($uid)
mixed	getDataInit ($parentId)
int	getDataCount (&$res)
array bool	getDataNext (&$res)
	getDataFree (&$res)
	setDataFromArray (&$dataArr, $traverse=false, $pid=0)
	setDataFromTreeArray (&$treeArr, &$treeLookupArr)

Public Attributes
bool	$ext_showPageId = false
bool	$ajaxStatus = false
‪Public Attributes inherited from ‪TYPO3\CMS\Backend\Tree\View\BrowseTreeView
array	$fieldArray
string	$treeName = 'browsePages'
string	$table = 'pages'
string	$domIdPrefix = 'pages'
bool	$ext_showNavTitle = false
‪Public Attributes inherited from ‪TYPO3\CMS\Backend\Tree\View\AbstractTreeView
bool	$expandFirst = false
bool	$expandAll = false
string	$thisScript = ''
string	$titleAttrib = 'title'
bool	$ext_IconMode = false
bool	$ext_showPathAboveMounts = false
int	$addSelfId = 0
string	$title = 'no title'
bool	$showDefaultTitleAttribute = false
TYPO3 CMS Core Authentication BackendUserAuthentication	$BE_USER = ''
array null	$MOUNTS
string	$table = ''
string	$parentField = 'pid'
string	$clause = ''
string	$orderByFields = ''
array	$fieldArray = array( 'uid', 'pid', 'title', 'is_siteroot' )
array	$defaultList = 'uid,pid,tstamp,sorting,deleted,perms_userid,perms_groupid,perms_user,perms_group,perms_everybody,crdate,cruser_id'
string	$treeName = ''
string	$domIdPrefix = 'row'
int	$makeHTML = 1
int	$setRecs = 0
string	$subLevelID = '_SUB_LEVEL'
array	$ids = array( )
array	$ids_hierarchy = array( )
array	$orig_ids_hierarchy = array( )
array	$buffer_idH = array( )
array	$specUIDmap = array( )
bool	$data = false
bool	$dataLookup = false
array	$tree = array( )
array	$stored = array( )
int	$bank = 0
array	$recs = array( )

Additional Inherited Members
‪Protected Member Functions inherited from ‪TYPO3\CMS\Backend\Tree\View\AbstractTreeView
	determineScriptUrl ()
string	getThisScript ()
string	getMountPointPath (int $uid)
LanguageService	getLanguageService ()
BackendUserAuthentication	getBackendUser ()

Detailed Description

Browse pages in Web module

This class is a TYPO3 Backend implementation and is not considered part of the Public TYPO3 API.

Definition at line 27 of file PageTreeView.php.

Constructor & Destructor Documentation

__construct()

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

(

)

Calls init functions

Reimplemented from TYPO3\CMS\Backend\Tree\View\AbstractTreeView.

Definition at line 42 of file PageTreeView.php.

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

Member Function Documentation

getBrowsableTree()

string 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

Reimplemented from TYPO3\CMS\Backend\Tree\View\AbstractTreeView.

Definition at line 265 of file PageTreeView.php.

References TYPO3\CMS\Backend\Tree\View\AbstractTreeView\$bank, TYPO3\CMS\Backend\Tree\View\AbstractTreeView\$ids, 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\PageTreeView\initializePositionSaving(), TYPO3\CMS\Backend\Tree\View\AbstractTreeView\printTree(), and TYPO3\CMS\Backend\Tree\View\AbstractTreeView\reset().

PMicon()

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

See also

‪\TYPO3\CMS\Backend\Tree\View\PageTreeView::PMicon()

Reimplemented from TYPO3\CMS\Backend\Tree\View\AbstractTreeView.

Definition at line 230 of file PageTreeView.php.

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

PMiconATagWrap()

string 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

Definition at line 249 of file PageTreeView.php.

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

printTree()

string 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

Reimplemented from TYPO3\CMS\Backend\Tree\View\AbstractTreeView.

Definition at line 122 of file PageTreeView.php.

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

wrapIcon()

string 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

Reimplemented from TYPO3\CMS\Backend\Tree\View\BrowseTreeView.

Definition at line 55 of file PageTreeView.php.

References $GLOBALS, TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getJumpToParam(), TYPO3\CMS\Backend\Utility\BackendUtility\isRecordLocked(), TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL, and TYPO3\CMS\Backend\Utility\BackendUtility\wrapClickMenuOnIcon().

wrapTitle()

string 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

Reimplemented from TYPO3\CMS\Backend\Tree\View\AbstractTreeView.

Definition at line 99 of file PageTreeView.php.

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

Member Data Documentation

$ajaxStatus

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

Indicates, whether the ajax call was successful, i.e. the requested page has been found

Definition at line 37 of file PageTreeView.php.

$ext_showPageId

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

Definition at line 31 of file PageTreeView.php.