TYPO3\CMS\Impexp\View\ExportPageTreeView Class Reference

Inheritance diagram for TYPO3\CMS\Impexp\View\ExportPageTreeView:

Public Member Functions
	__construct ()
	init ($clause='', $orderByFields='')
	buildTreeByLevels (int $pid, int $levels)
string	printTree ($treeArr='')
bool	expandNext ($id)
‪Public Member Functions inherited from ‪TYPO3\CMS\Backend\Tree\View\AbstractTreeView
	addField ($field, $noCheck=false)
	reset ()
int	getTree ($uid, $depth=999, $depthData='')

Public Attributes
int	$bank = 0
‪Public Attributes inherited from ‪TYPO3\CMS\Backend\Tree\View\AbstractTreeView
string	$orderByFields = ''
int	$makeHTML = 1
array	$ids = array( )
array	$ids_hierarchy = array( )
array	$orig_ids_hierarchy = array( )
array	$buffer_idH = array( )
array	$tree = array( )

Protected Member Functions
string	getTitleAttrib ($row)
	PMicon ($row, $a, $c, $nextCount, $isOpen)
	buildTree (int $pid, int $levels, bool $checkSub)
string	getPageIcon (array $row)
‪Protected Member Functions inherited from ‪TYPO3\CMS\Backend\Tree\View\AbstractTreeView
string	PM_ATagWrap ($bMark='', $isOpen=false)
string	getIcon (array $row)
string	getTitleStr ($row, $titleLen=30)
int	getCount ($uid)
mixed	getDataInit ($parentId)
array bool	getDataNext (&$res)
	getLanguageService ()
	getBackendUser ()

Protected Attributes
bool	$expandAll = false
‪Protected Attributes inherited from ‪TYPO3\CMS\Backend\Tree\View\AbstractTreeView
string	$table = 'pages'
string	$parentField = 'pid'
string	$clause = ''
array	$fieldArray
string	$defaultList = 'uid,pid,tstamp,sorting,deleted,perms_userid,perms_groupid,perms_user,perms_group,perms_everybody,crdate'

Detailed Description

Extension of the page tree class. Used to get the tree of pages to export.

This class is not considered part of the public TYPO3 API.

Definition at line 31 of file ExportPageTreeView.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Impexp\View\ExportPageTreeView::__construct

(

)

Constructor

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

Definition at line 43 of file ExportPageTreeView.php.

References TYPO3\CMS\Impexp\View\ExportPageTreeView\init().

Member Function Documentation

buildTree()

TYPO3\CMS\Impexp\View\ExportPageTreeView::buildTree ( int  $pid, int  $levels, bool  $checkSub  )

protected

Creation of a tree structure with predefined depth to prepare the export.

Parameters

int	$pid	‪Page ID
int	$levels	‪Page tree levels
bool	$checkSub	‪Should root page be checked for sub pages?

Definition at line 102 of file ExportPageTreeView.php.

References TYPO3\CMS\Impexp\View\ExportPageTreeView\$bank, TYPO3\CMS\Backend\Tree\View\AbstractTreeView\$buffer_idH, $GLOBALS, TYPO3\CMS\Impexp\View\ExportPageTreeView\getPageIcon(), TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getTree(), and TYPO3\CMS\Backend\Tree\View\AbstractTreeView\reset().

Referenced by TYPO3\CMS\Impexp\View\ExportPageTreeView\buildTreeByLevels().

buildTreeByLevels()

TYPO3\CMS\Impexp\View\ExportPageTreeView::buildTreeByLevels	(	int	$pid,
		int	$levels
	)

Construction of the tree structure with predefined depth.

Parameters

int	$pid	‪Page ID
int	$levels	‪Page tree levels

Definition at line 87 of file ExportPageTreeView.php.

References TYPO3\CMS\Impexp\View\ExportPageTreeView\buildTree().

expandNext()

bool TYPO3\CMS\Impexp\View\ExportPageTreeView::expandNext

(

$id

)

Returns TRUE/FALSE if the next level for $id should be expanded - based on the ->expandAll flag. Extending parent function

Parameters

int

$id

‪Record id/key

Returns

‪bool

See also

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

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

Definition at line 201 of file ExportPageTreeView.php.

References TYPO3\CMS\Impexp\View\ExportPageTreeView\$expandAll.

getPageIcon()

string TYPO3\CMS\Impexp\View\ExportPageTreeView::getPageIcon ( array  $row )

protected

Get page icon for the row.

Returns

‪string Icon image tag.

Definition at line 211 of file ExportPageTreeView.php.

Referenced by TYPO3\CMS\Impexp\View\ExportPageTreeView\buildTree().

getTitleAttrib()

string TYPO3\CMS\Impexp\View\ExportPageTreeView::getTitleAttrib (   $row )

protected

Creates title attribute content for pages. Uses API function in \TYPO3\CMS\Backend\Utility\BackendUtility which will retrieve lots of useful information for pages.

Parameters

array

$row

‪The table row.

Returns

‪string

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

Definition at line 68 of file ExportPageTreeView.php.

init()

TYPO3\CMS\Impexp\View\ExportPageTreeView::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 56 of file ExportPageTreeView.php.

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

Referenced by TYPO3\CMS\Impexp\View\ExportPageTreeView\__construct().

PMicon()

TYPO3\CMS\Impexp\View\ExportPageTreeView::PMicon (   $row,   $a,   $c,   $nextCount,   $isOpen  )

protected

Wrapping Plus/Minus icon, unused in Export Page Tree

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

Definition at line 76 of file ExportPageTreeView.php.

printTree()

string TYPO3\CMS\Impexp\View\ExportPageTreeView::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 150 of file ExportPageTreeView.php.

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

Member Data Documentation

$bank

int TYPO3\CMS\Impexp\View\ExportPageTreeView::$bank = 0

Points to the current mountpoint key

Definition at line 41 of file ExportPageTreeView.php.

Referenced by TYPO3\CMS\Impexp\View\ExportPageTreeView\buildTree().

$expandAll

bool TYPO3\CMS\Impexp\View\ExportPageTreeView::$expandAll = false

protected

If set, then ALL items will be expanded, regardless of stored settings.

Definition at line 36 of file ExportPageTreeView.php.

Referenced by TYPO3\CMS\Impexp\View\ExportPageTreeView\expandNext().