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

Public Member Functions
	__construct ()

	PMicon (\TYPO3\CMS\Core\Resource\Folder $folderObject, $subFolderCounter, $totalSubFolders, $nextCount, $isExpanded)

	PMiconATagWrap ($icon, $cmd, $isExpand=TRUE)

	wrapIcon ($icon, \TYPO3\CMS\Core\Resource\Folder $folderObject)

	wrapTitle ($title, \TYPO3\CMS\Core\Resource\Folder $folderObject, $bank=0)

	getId (\TYPO3\CMS\Core\Resource\Folder $folderObject)

	getJumpToParam (\TYPO3\CMS\Core\Resource\Folder $folderObject)

	getTitleStr ($row, $titleLen=30)

	getTitleAttrib (\TYPO3\CMS\Core\Resource\Folder $folderObject)

	getBrowsableTree ()

	getFolderTree (\TYPO3\CMS\Core\Resource\Folder $folderObject, $depth=999, $type='')

	getNumberOfSubfolders (\TYPO3\CMS\Core\Resource\Folder $folderObject)

	initializePositionSaving ()

	getAjaxStatus ()

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)

Protected Member Functions
	getShortHashNumberForStorage (\TYPO3\CMS\Core\Resource\ResourceStorage $storageObject=NULL, \TYPO3\CMS\Core\Resource\Folder $startingPointFolder=NULL)

	evaluateExpandCollapseParameter ($PM=NULL)

	generateExpandCollapseParameter ($mountKey=NULL, $doExpand=FALSE, \TYPO3\CMS\Core\Resource\Folder $folderObject=NULL, $treeName=NULL)

	getLanguageService ()

Protected Member Functions inherited from TYPO3\CMS\Backend\Tree\View\AbstractTreeView
	determineScriptUrl ()

	getThisScript ()

	hasPageRecordVersions ($workspaceId, $pageId)

	getWorkspaceService ()

Protected Attributes
	$storages = NULL

	$storageHashNumbers

	$ajaxStatus = FALSE

	$scope

Protected Attributes inherited from TYPO3\CMS\Backend\Tree\View\AbstractTreeView
	$workspaceService = NULL

Additional Inherited Members
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()

Detailed Description

Generate a folder tree, specially made for browsing folders in the File module

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 30 of file FolderTreeView.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Backend\Tree\View\FolderTreeView::__construct ( )

Constructor function of the class

Definition at line 60 of file FolderTreeView.php.

Member Function Documentation

◆ evaluateExpandCollapseParameter()

TYPO3\CMS\Backend\Tree\View\FolderTreeView::evaluateExpandCollapseParameter ( $PM = NULL )

protected

Gets the values from the Expand/Collapse Parameter (&PM) previously known as "PM" (plus/minus) PM action: (If an plus/minus icon has been clicked, the PM GET var is sent and we must update the stored positions in the tree): 0: mount key, 1: set/clear boolean, 2: item ID (cannot contain "_"), 3: treeName

Parameters

string $PM The "plus/minus" command

Returns: array

Definition at line 604 of file FolderTreeView.php.

References TYPO3\CMS\Backend\Tree\View\AbstractTreeView\$treeName, TYPO3\CMS\Core\Utility\GeneralUtility\_GP(), and TYPO3\CMS\Core\Utility\GeneralUtility\revExplode().

Referenced by TYPO3\CMS\Backend\Tree\View\FolderTreeView\getFolderTree(), and TYPO3\CMS\Backend\Tree\View\FolderTreeView\initializePositionSaving().

◆ generateExpandCollapseParameter()

TYPO3\CMS\Backend\Tree\View\FolderTreeView::generateExpandCollapseParameter	(		$mountKey = `NULL`,
			$doExpand = `FALSE`,
		\TYPO3\CMS\Core\Resource\Folder	$folderObject = `NULL`,
			$treeName = `NULL`
	)

protected

Generates the "PM" string to sent to expand/collapse items

Parameters

string	$mountKey	The mount key / storage UID
boolean	$doExpand	Whether to expand/collapse
\TYPO3\CMS\Core\Resource\Folder	$folderObject	The folder object
string	$treeName	The name of the tree

Returns: string

Definition at line 633 of file FolderTreeView.php.

References TYPO3\CMS\Backend\Tree\View\AbstractTreeView\$treeName, and TYPO3\CMS\Core\Utility\GeneralUtility\md5int().

Referenced by TYPO3\CMS\Backend\Tree\View\FolderTreeView\getBrowsableTree(), and TYPO3\CMS\Backend\Tree\View\FolderTreeView\PMicon().

◆ getAjaxStatus()

TYPO3\CMS\Backend\Tree\View\FolderTreeView::getAjaxStatus ( )

Gets the AJAX status.

Returns: boolean

Definition at line 648 of file FolderTreeView.php.

References TYPO3\CMS\Backend\Tree\View\FolderTreeView\$ajaxStatus.

◆ getBrowsableTree()

TYPO3\CMS\Backend\Tree\View\FolderTreeView::getBrowsableTree ( )

Will create and return the HTML code for a browsable tree of folders. Is based on the mounts found in the internal array ->MOUNTS (set in the constructor)

Returns: string HTML code for the browsable tree

Definition at line 219 of file FolderTreeView.php.

◆ getFolderTree()

TYPO3\CMS\Backend\Tree\View\FolderTreeView::getFolderTree	(	\TYPO3\CMS\Core\Resource\Folder	$folderObject,
			$depth = `999`,
			$type = `''`
	)

Fetches the data for the tree

Parameters

\TYPO3\CMS\Core\Resource\Folder	$folderObject	the folderobject
integer	$depth	Max depth (recursivity limit)
string	$type	HTML-code prefix for recursive calls.

Returns: integer The count of items on the level

See also: getBrowsableTree()

Definition at line 329 of file FolderTreeView.php.

Referenced by TYPO3\CMS\Backend\Tree\View\FolderTreeView\getBrowsableTree().

◆ getId()

TYPO3\CMS\Backend\Tree\View\FolderTreeView::getId ( \TYPO3\CMS\Core\Resource\Folder $folderObject )

Returns the id from the record - for folders, this is an md5 hash.

Parameters

\TYPO3\CMS\Core\Resource\Folder $folderObject The folder object

Returns: integer The "uid" field value.

Definition at line 176 of file FolderTreeView.php.

Referenced by TYPO3\CMS\Backend\Tree\View\FolderTreeView\getFolderTree(), and TYPO3\CMS\Backend\Tree\View\FolderTreeView\wrapIcon().

◆ getJumpToParam()

TYPO3\CMS\Backend\Tree\View\FolderTreeView::getJumpToParam ( \TYPO3\CMS\Core\Resource\Folder $folderObject )

Returns jump-url parameter value.

Parameters

\TYPO3\CMS\Core\Resource\Folder $folderObject The folder object

Returns: string The jump-url parameter.

Definition at line 186 of file FolderTreeView.php.

Referenced by TYPO3\CMS\Filelist\FileListFolderTree\wrapIcon(), TYPO3\CMS\Backend\Tree\View\FolderTreeView\wrapIcon(), and TYPO3\CMS\Filelist\FileListFolderTree\wrapTitle().

◆ getLanguageService()

TYPO3\CMS\Backend\Tree\View\FolderTreeView::getLanguageService ( )

protected

Returns: LanguageService

Definition at line 655 of file FolderTreeView.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Tree\View\FolderTreeView\getBrowsableTree(), and TYPO3\CMS\Backend\Tree\View\FolderTreeView\getFolderTree().

◆ getNumberOfSubfolders()

TYPO3\CMS\Backend\Tree\View\FolderTreeView::getNumberOfSubfolders ( \TYPO3\CMS\Core\Resource\Folder $folderObject )

Counts the number of directories in a file path.

Parameters

\TYPO3\CMS\Core\Resource\Folder $folderObject File path.

Returns: integer

Definition at line 521 of file FolderTreeView.php.

Referenced by TYPO3\CMS\Backend\Tree\View\FolderTreeView\getBrowsableTree(), and TYPO3\CMS\Backend\Tree\View\FolderTreeView\getFolderTree().

◆ getShortHashNumberForStorage()

TYPO3\CMS\Backend\Tree\View\FolderTreeView::getShortHashNumberForStorage	(	\TYPO3\CMS\Core\Resource\ResourceStorage	$storageObject = `NULL`,
		\TYPO3\CMS\Core\Resource\Folder	$startingPointFolder = `NULL`
	)

protected

Helper method to map md5-hash to shorter number

Parameters

\TYPO3\CMS\Core\Resource\ResourceStorage	$storageObject
\TYPO3\CMS\Core\Resource\Folder	$startingPointFolder

Returns: integer

Definition at line 563 of file FolderTreeView.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\md5int().

Referenced by TYPO3\CMS\Backend\Tree\View\FolderTreeView\getBrowsableTree(), and TYPO3\CMS\Backend\Tree\View\FolderTreeView\initializePositionSaving().

◆ getTitleAttrib()

TYPO3\CMS\Backend\Tree\View\FolderTreeView::getTitleAttrib ( \TYPO3\CMS\Core\Resource\Folder $folderObject )

Returns the value for the image "title" attribute

Parameters

\TYPO3\CMS\Core\Resource\Folder $folderObject The folder to be used

Returns: string The attribute value (is htmlspecialchared() already)

Todo:: Define visibility

Definition at line 209 of file FolderTreeView.php.

◆ getTitleStr()

TYPO3\CMS\Backend\Tree\View\FolderTreeView::getTitleStr	(	$row,
		$titleLen = `30`
	)

Returns the title for the input record. If blank, a "no title" labele (localized) will be returned. '_title' is used for setting an alternative title for folders.

Parameters

array	$row	The input row array (where the key "_title" is used for the title)
integer	$titleLen	Title length (30)

Returns: string The title

Definition at line 198 of file FolderTreeView.php.

Referenced by TYPO3\CMS\Backend\Tree\View\FolderTreeView\getFolderTree().

◆ initializePositionSaving()

TYPO3\CMS\Backend\Tree\View\FolderTreeView::initializePositionSaving ( )

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

Returns: void private

Todo:: Define visibility

Definition at line 533 of file FolderTreeView.php.

References TYPO3\CMS\Backend\Tree\View\AbstractTreeView\$treeName, TYPO3\CMS\Backend\Tree\View\FolderTreeView\evaluateExpandCollapseParameter(), TYPO3\CMS\Backend\Tree\View\FolderTreeView\getShortHashNumberForStorage(), and TYPO3\CMS\Backend\Tree\View\AbstractTreeView\savePosition().

◆ PMicon()

TYPO3\CMS\Backend\Tree\View\FolderTreeView::PMicon	(	\TYPO3\CMS\Core\Resource\Folder	$folderObject,
			$subFolderCounter,
			$totalSubFolders,
			$nextCount,
			$isExpanded
	)

Generate the plus/minus icon for the browsable tree.

Parameters

\TYPO3\CMS\Core\Resource\Folder	$folderObject	Entry folder object
integer	$subFolderCounter	The current entry number
integer	$totalSubFolders	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	$isExpanded	The element was expanded to render subelements if this flag is set.

Returns: string Image tag with the plus/minus icon.

Definition at line 81 of file FolderTreeView.php.

References TYPO3\CMS\Backend\Tree\View\FolderTreeView\generateExpandCollapseParameter(), TYPO3\CMS\Backend\Tree\View\FolderTreeView\PMiconATagWrap(), and TYPO3\CMS\Backend\Utility\IconUtility\skinImg().

Referenced by TYPO3\CMS\Backend\Tree\View\FolderTreeView\getFolderTree().

◆ PMiconATagWrap()

TYPO3\CMS\Backend\Tree\View\FolderTreeView::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
boolean	$isExpand	Whether to be expanded

Returns: string Link-wrapped input string

Definition at line 101 of file FolderTreeView.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\hmac(), and TYPO3\CMS\Core\Utility\GeneralUtility\quoteJSvalue().

Referenced by TYPO3\CMS\Backend\Tree\View\FolderTreeView\PMicon().

◆ wrapIcon()

TYPO3\CMS\Backend\Tree\View\FolderTreeView::wrapIcon	(		$icon,
		\TYPO3\CMS\Core\Resource\Folder	$folderObject
	)

Wrapping the folder icon

Parameters

string	$icon	The image tag for the icon
\TYPO3\CMS\Core\Resource\Folder	$folderObject	The row for the current element

Returns: string The processed icon input value.

Definition at line 134 of file FolderTreeView.php.

References $GLOBALS, TYPO3\CMS\Backend\Tree\View\FolderTreeView\getId(), and TYPO3\CMS\Backend\Tree\View\FolderTreeView\getJumpToParam().

Referenced by TYPO3\CMS\Backend\Tree\View\FolderTreeView\getBrowsableTree(), and TYPO3\CMS\Backend\Tree\View\FolderTreeView\getFolderTree().

◆ wrapTitle()

TYPO3\CMS\Backend\Tree\View\FolderTreeView::wrapTitle	(		$title,
		\TYPO3\CMS\Core\Resource\Folder	$folderObject,
			$bank = `0`
	)

Wrapping $title in a-tags.

Parameters

string	$title	Title string
\TYPO3\CMS\Core\Resource\Folder	$folderObject	the folder record
integer	$bank	Bank pointer (which mount point number)

Returns: string

Definition at line 159 of file FolderTreeView.php.

Referenced by TYPO3\CMS\Backend\Tree\View\FolderTreeView\getFolderTree().

Member Data Documentation

◆ $ajaxStatus

TYPO3\CMS\Backend\Tree\View\FolderTreeView::$ajaxStatus = FALSE

protected

Definition at line 50 of file FolderTreeView.php.

Referenced by TYPO3\CMS\Backend\Tree\View\FolderTreeView\getAjaxStatus().

◆ $scope

TYPO3\CMS\Backend\Tree\View\FolderTreeView::$scope

protected

Definition at line 55 of file FolderTreeView.php.

◆ $storageHashNumbers

TYPO3\CMS\Backend\Tree\View\FolderTreeView::$storageHashNumbers

protected

Definition at line 42 of file FolderTreeView.php.

◆ $storages

TYPO3\CMS\Backend\Tree\View\FolderTreeView::$storages = NULL

protected

Definition at line 37 of file FolderTreeView.php.

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ evaluateExpandCollapseParameter()

◆ generateExpandCollapseParameter()

◆ getAjaxStatus()

◆ getBrowsableTree()

◆ getFolderTree()

◆ getId()

◆ getJumpToParam()

◆ getLanguageService()

◆ getNumberOfSubfolders()

◆ getShortHashNumberForStorage()

◆ getTitleAttrib()

◆ getTitleStr()

◆ initializePositionSaving()

◆ PMicon()

◆ PMiconATagWrap()

◆ wrapIcon()

◆ wrapTitle()

Member Data Documentation

◆ $ajaxStatus

◆ $scope

◆ $storageHashNumbers

◆ $storages