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

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

Public Member Functions
	init ($clause='', $orderByFields='')
bool	expandNext ($id)
string	PMicon ($row, $a, $c, $nextCount, $isExpand)
	initializePositionSaving ()
string	getTitleStr ($row, $titleLen=30)
‪Public Member Functions inherited from ‪TYPO3\CMS\Backend\Tree\View\AbstractTreeView
	__construct ()
	addField ($field, $noCheck=false)
	reset ()
string	getBrowsableTree ()
string	printTree ($treeArr='')
string	PM_ATagWrap ($icon, $cmd, $bMark='', $isOpen=false)
string	wrapTitle ($title, $row, $bank=0)
string	wrapIcon ($icon, $row)
string	addTagAttributes ($icon, $attr)
string	wrapStop ($str, $row)
	savePosition ()
string	getRootIcon ($rec)
string	getIcon ($row)
string	getTitleAttrib ($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)

Public Attributes
array	$fieldArray
string	$treeName = 'pages'
string	$table = '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 string	$BE_USER = ''
array null	$MOUNTS
string	$table = ''
string	$parentField = 'pid'
string	$clause = ''
string	$orderByFields = ''
array	$fieldArray = array( 'uid', 'pid', 'title', 'is_siteroot' )
string	$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
array	$ids = array( )
array	$ids_hierarchy = array( )
array	$orig_ids_hierarchy = array( )
array	$buffer_idH = array( )
array	$specUIDmap = array( )
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

Generate a page-tree, non-browsable.

Definition at line 23 of file PageTreeView.php.

Member Function Documentation

expandNext()

bool TYPO3\CMS\Backend\Tree\View\PageTreeView::expandNext

(

$id

)

Returns TRUE/FALSE if the next level for $id should be expanded - and all levels should, so we always return 1.

Parameters

int

$id

‪ID (uid) to test for (see extending classes where this is checked against session data)

Returns

‪bool

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

Reimplemented in TYPO3\CMS\Backend\Tree\View\NewRecordPageTreeView.

Definition at line 78 of file PageTreeView.php.

getTitleStr()

string TYPO3\CMS\Backend\Tree\View\PageTreeView::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)
int	$titleLen	‪Title length (30)

Returns

‪string The title.

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

Definition at line 120 of file PageTreeView.php.

References TYPO3\CMS\Backend\Tree\View\AbstractTreeView\$title, and TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getLanguageService().

init()

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

Init function REMEMBER to feed a $clause which will filter out non-readable pages!

Parameters

string	$clause	‪Part of where query which will filter out non-readable pages.
string	$orderByFields	‪Record ORDER BY field

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

Definition at line 67 of file PageTreeView.php.

References TYPO3\CMS\Backend\Tree\View\AbstractTreeView\$clause, and TYPO3\CMS\Backend\Tree\View\AbstractTreeView\$orderByFields.

initializePositionSaving()

TYPO3\CMS\Backend\Tree\View\PageTreeView::initializePositionSaving

(

)

Get stored tree structure AND updating it if needed according to incoming PM GET var.

• ‪Here we just set it to nothing since we want to just render the tree, nothing more.

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

Definition at line 107 of file PageTreeView.php.

PMicon()

string TYPO3\CMS\Backend\Tree\View\PageTreeView::PMicon	(		$row,
			$a,
			$c,
			$nextCount,
			$isExpand
	)

Generate the plus/minus icon for the browsable tree. In this case, there is no plus-minus icon displayed.

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	$isExpand	‪The element was expanded to render subelements if this flag is set.

Returns

‪string Image tag with the plus/minus icon.

See also

‪AbstractTreeView::PMicon()

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

Definition at line 96 of file PageTreeView.php.

Member Data Documentation

$ext_showNavTitle

bool TYPO3\CMS\Backend\Tree\View\PageTreeView::$ext_showNavTitle = false

Definition at line 58 of file PageTreeView.php.

$fieldArray

array TYPO3\CMS\Backend\Tree\View\PageTreeView::$fieldArray

Initial value:

= array( 
        'uid',
        'pid',
        'is_siteroot',
        'title',
        'doktype',
        'nav_title',
        'mount_pid',
        'php_tree_stop',
        't3ver_state',
        'hidden',
        'starttime',
        'endtime',
        'fe_group',
        'module',
        'extendToSubpages',
        'nav_hide'
     )

Definition at line 27 of file PageTreeView.php.

$table

string TYPO3\CMS\Backend\Tree\View\PageTreeView::$table = 'pages'

override to use this table

Definition at line 54 of file PageTreeView.php.

$treeName

string TYPO3\CMS\Backend\Tree\View\PageTreeView::$treeName = 'pages'

override to use this treeName

Definition at line 49 of file PageTreeView.php.