TYPO3\CMS\Impexp\View\ExportPageTreeView Class Reference

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

Public Member Functions
	__construct ()
	init ($clause='', $orderByFields='')
string	getTitleAttrib ($row)
	PMicon ($row, $a, $c, $nextCount, $isOpen)
	buildTreeByLevels (int $pid, int $levels)
	buildTreeByExpandedState (int $pid)
string	printTree ($treeArr='')
bool	expandNext ($id)
‪Public Member Functions inherited from ‪TYPO3\CMS\Backend\Tree\View\AbstractTreeView
	addField ($field, $noCheck=false)
	reset ()
string	PM_ATagWrap ($bMark='', $isOpen=false)
string	addTagAttributes ($icon, $attr)
string	getRootIcon ($rec)
string	getIcon ($row)
string	getTitleStr ($row, $titleLen=30)
int	getTree ($uid, $depth=999, $depthData='')
int	getCount ($uid)
array	getRootRecord ()
mixed	getDataInit ($parentId)
int	getDataCount (&$res)
array bool	getDataNext (&$res)
	getDataFree (&$res)

Public Attributes
int	$bank = 0
array	$stored = array( )
‪Public Attributes inherited from ‪TYPO3\CMS\Backend\Tree\View\AbstractTreeView
string	$thisScript = ''
string	$title = 'no title'
TYPO3 CMS Core Authentication BackendUserAuthentication string	$BE_USER = ''
string	$table = 'pages'
string	$parentField = 'pid'
string	$clause = ''
string	$orderByFields = ''
array	$fieldArray
string	$defaultList = 'uid,pid,tstamp,sorting,deleted,perms_userid,perms_groupid,perms_user,perms_group,perms_everybody,crdate,cruser_id'
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
	buildTree (int $pid, int $levels, bool $checkSub)
	syncPageTreeState ()
string	getPageIcon (array $row)
‪Protected Member Functions inherited from ‪TYPO3\CMS\Backend\Tree\View\AbstractTreeView
	determineScriptUrl ()
string	getThisScript ()
LanguageService	getLanguageService ()
BackendUserAuthentication	getBackendUser ()

Protected Attributes
bool	$expandAll = false

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 33 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 50 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 128 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\getRootIcon(), TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getTree(), and TYPO3\CMS\Backend\Tree\View\AbstractTreeView\reset().

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

buildTreeByExpandedState()

TYPO3\CMS\Impexp\View\ExportPageTreeView::buildTreeByExpandedState

(

int

$pid

)

Construction of the tree structure according to the state of folding of the page tree module.

Parameters

int

$pid

‪Page ID

Definition at line 107 of file ExportPageTreeView.php.

References TYPO3\CMS\Impexp\View\ExportPageTreeView\buildTree(), TYPO3\CMS\Impexp\Export\LEVELS_INFINITE, and TYPO3\CMS\Impexp\View\ExportPageTreeView\syncPageTreeState().

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 94 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 data in $this->stored[][] and ->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 254 of file ExportPageTreeView.php.

getPageIcon()

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

protected

Get page icon for the row.

Parameters

array

$row

Returns

‪string Icon image tag.

Definition at line 265 of file ExportPageTreeView.php.

References TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL.

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

getTitleAttrib()

string TYPO3\CMS\Impexp\View\ExportPageTreeView::getTitleAttrib

(

$row

)

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 75 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 63 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
	)

Wrapping Plus/Minus icon, unused in Export Page Tree

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

Definition at line 83 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 196 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().

syncPageTreeState()

TYPO3\CMS\Impexp\View\ExportPageTreeView::syncPageTreeState ( )

protected

Sync folding state of EXT:impexp page tree with the official page tree module

Definition at line 172 of file ExportPageTreeView.php.

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

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

Member Data Documentation

$bank

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

Points to the current mountpoint key

Definition at line 43 of file ExportPageTreeView.php.

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

$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 38 of file ExportPageTreeView.php.

$stored

array TYPO3\CMS\Impexp\View\ExportPageTreeView::$stored = array( )

Holds (session stored) information about which items in the tree are unfolded and which are not.

Definition at line 48 of file ExportPageTreeView.php.