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

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

Public Member Functions
	init ($clause='', $orderByFields='')
	expandNext ($id)
	PMicon ($row, $a, $c, $nextCount, $exp)
	initializePositionSaving ()
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
	$fieldArray
	$defaultList = 'uid,pid,tstamp,sorting,deleted,perms_userid,perms_groupid,perms_user,perms_group,perms_everybody,crdate,cruser_id'
	$setRecs = 0
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

This file is part of the TYPO3 CMS project.

It is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, either version 2 of the License, or any later version.

For the full copyright and license information, please read the LICENSE.txt file that was distributed with this source code.

The TYPO3 project - inspiring people to share! Generate a page-tree, non-browsable.

Author

Kasper Skårhøj kaspe.nosp@m.rYYY.nosp@m.Y@typ.nosp@m.o3.c.nosp@m.om René Fritz r.fri.nosp@m.tz@c.nosp@m.olorc.nosp@m.ube..nosp@m.de

Definition at line 22 of file PageTreeView.php.

Member Function Documentation

expandNext()

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

integer

$id

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

Returns

boolean

Todo:

Define visibility

Definition at line 78 of file PageTreeView.php.

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

Returns

void

Todo:

Define visibility

Definition at line 56 of file PageTreeView.php.

References TYPO3\CMS\Backend\Tree\View\AbstractTreeView\$clause.

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.

Returns

void private

Todo:

Define visibility

Definition at line 111 of file PageTreeView.php.

PMicon()

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

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

AbstarctTreeView::PMicon()

Todo:

Define visibility

Definition at line 96 of file PageTreeView.php.

References TYPO3\CMS\Backend\Utility\IconUtility\getSpriteIcon().

Member Data Documentation

$defaultList

TYPO3\CMS\Backend\Tree\View\PageTreeView::$defaultList = 'uid,pid,tstamp,sorting,deleted,perms_userid,perms_groupid,perms_user,perms_group,perms_everybody,crdate,cruser_id'

Todo:

Define visibility

Definition at line 40 of file PageTreeView.php.

$fieldArray

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

Initial value:

= array(
        'uid',
        'title',
        'doktype',
        'mount_pid',
        'php_tree_stop',
        't3ver_id',
        't3ver_state'
    )

Todo:

Define visibility

Definition at line 27 of file PageTreeView.php.

$setRecs

TYPO3\CMS\Backend\Tree\View\PageTreeView::$setRecs = 0

Todo:

Define visibility

Definition at line 45 of file PageTreeView.php.