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

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

Public Member Functions
	setLinkParameterProvider (LinkParameterProviderInterface $linkParameterProvider)
string	wrapIcon ($icon, $folderObject)
string	wrapTitle ($title, $folderObject, $bank=0)
bool	ext_isLinkable (Folder $folderObject)
string	PM_ATagWrap ($icon, $cmd, $bMark='', $isOpen=false)
string	PMiconATagWrap ($icon, $cmd, $isExpand=true)
‪Public Member Functions inherited from ‪TYPO3\CMS\Backend\Tree\View\FolderTreeView
	__construct ()
string	PMicon ($folderObject, $subFolderCounter, $totalSubFolders, $nextCount, $isExpanded)
int	getId ($folderObject)
string	getJumpToParam ($folderObject)
string	getTitleStr ($row, $titleLen=30)
string	getTitleAttrib ($folderObject)
string	getBrowsableTree ()
	getBrowseableTreeForStorage (ResourceStorage $storageObject)
int	getFolderTree (Folder $folderObject, $depth=999, $type='')
string	printTree ($treeItems='')
int	getNumberOfSubfolders (Folder $folderObject)
	initializePositionSaving ()
bool	getAjaxStatus ()
‪Public Member Functions inherited from ‪TYPO3\CMS\Backend\Tree\View\AbstractTreeView
	init ($clause='', $orderByFields='')
	addField ($field, $noCheck=false)
	reset ()
string	addTagAttributes ($icon, $attr)
string	wrapStop ($str, $row)
bool	expandNext ($id)
	savePosition ()
string	getRootIcon ($rec)
string	getIcon ($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)
	setDataFromArray (&$dataArr, $traverse=false, $pid=0)
	setDataFromTreeArray (&$treeArr, &$treeLookupArr)

Public Attributes
string	$ext_IconMode = 'titlelink'
‪Public Attributes inherited from ‪TYPO3\CMS\Backend\Tree\View\FolderTreeView
string	$titleAttrib = ''
string	$treeName = 'folder'
string	$domIdPrefix = 'folder'
‪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	$BE_USER = ''
array null	$MOUNTS
string	$table = ''
string	$parentField = 'pid'
string	$clause = ''
string	$orderByFields = ''
array	$fieldArray = array( 'uid', 'pid', 'title', 'is_siteroot' )
array	$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
string	$subLevelID = '_SUB_LEVEL'
array	$ids = array( )
array	$ids_hierarchy = array( )
array	$orig_ids_hierarchy = array( )
array	$buffer_idH = array( )
array	$specUIDmap = array( )
bool	$data = false
bool	$dataLookup = false
array	$tree = array( )
array	$stored = array( )
int	$bank = 0
array	$recs = array( )

Protected Member Functions
string	renderPMIconAndLink ($cmd, $isOpen)
‪Protected Member Functions inherited from ‪TYPO3\CMS\Backend\Tree\View\FolderTreeView
string	getTableNameForClickMenu (Folder $folderObject)
int	getShortHashNumberForStorage (ResourceStorage $storageObject=null, Folder $startingPointFolder=null)
array	evaluateExpandCollapseParameter ($PM=null)
string	generateExpandCollapseParameter ($mountKey=null, $doExpand=false, Folder $folderObject=null, $treeName=null)
LanguageService	getLanguageService ()
‪Protected Member Functions inherited from ‪TYPO3\CMS\Backend\Tree\View\AbstractTreeView
	determineScriptUrl ()
string	getThisScript ()
string	getMountPointPath (int $uid)
BackendUserAuthentication	getBackendUser ()

Protected Attributes
LinkParameterProviderInterface	$linkParameterProvider
‪Protected Attributes inherited from ‪TYPO3\CMS\Backend\Tree\View\FolderTreeView
ResourceStorage[]	$storages
array	$storageHashNumbers
bool	$ajaxStatus = false
array	$scope
IconFactory	$iconFactory

Detailed Description

Base extension class which generates the folder tree. Used directly by the RTE. also used for the linkpicker on files

Browsable folder tree, used in Element Browser and RTE (for which it will be extended) previously located inside typo3/class.browse_links.php

Definition at line 30 of file ElementBrowserFolderTreeView.php.

Member Function Documentation

ext_isLinkable()

bool TYPO3\CMS\Backend\Tree\View\ElementBrowserFolderTreeView::ext_isLinkable

(

Folder

$folderObject

)

Returns TRUE if the input "record" contains a folder which can be linked.

Parameters

Folder

$folderObject

‪Object with information about the folder element. Contains keys like title, uid, path, _title

Returns

‪bool TRUE

Deprecated:

‪since TYPO3 v9, will be removed in TYPO3 v10.0

Definition at line 98 of file ElementBrowserFolderTreeView.php.

PM_ATagWrap()

string TYPO3\CMS\Backend\Tree\View\ElementBrowserFolderTreeView::PM_ATagWrap	(		$icon,
			$cmd,
			$bMark = '',
			$isOpen = false
	)

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
bool | string	$bMark	‪If set, the link will have an anchor point (=$bMark) and a name attribute (=$bMark)
bool	$isOpen	‪check if the item has children

Returns

‪string Link-wrapped input string

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

Definition at line 127 of file ElementBrowserFolderTreeView.php.

References TYPO3\CMS\Core\Utility\HttpUtility\buildQueryString(), and TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getThisScript().

PMiconATagWrap()

string TYPO3\CMS\Backend\Tree\View\ElementBrowserFolderTreeView::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
bool	$isExpand	‪Whether to be expanded

Returns

‪string Link-wrapped input string

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

Definition at line 146 of file ElementBrowserFolderTreeView.php.

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

Referenced by TYPO3\CMS\Backend\Tree\View\ElementBrowserFolderTreeView\renderPMIconAndLink().

renderPMIconAndLink()

string TYPO3\CMS\Backend\Tree\View\ElementBrowserFolderTreeView::renderPMIconAndLink (   $cmd,   $isOpen  )

protected

Parameters

string	$cmd
bool	$isOpen

Returns

‪string

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

Definition at line 109 of file ElementBrowserFolderTreeView.php.

References TYPO3\CMS\Backend\Tree\View\ElementBrowserFolderTreeView\PMiconATagWrap().

setLinkParameterProvider()

TYPO3\CMS\Backend\Tree\View\ElementBrowserFolderTreeView::setLinkParameterProvider

(

LinkParameterProviderInterface

$linkParameterProvider

)

Parameters

LinkParameterProviderInterface

$linkParameterProvider

Definition at line 43 of file ElementBrowserFolderTreeView.php.

References TYPO3\CMS\Backend\Tree\View\ElementBrowserFolderTreeView\$linkParameterProvider, and TYPO3\CMS\Recordlist\Tree\View\LinkParameterProviderInterface\getScriptUrl().

wrapIcon()

string TYPO3\CMS\Backend\Tree\View\ElementBrowserFolderTreeView::wrapIcon	(		$icon,
			$folderObject
	)

Wrapping the folder icon

Parameters

string	$icon	‪The image tag for the icon
Folder	$folderObject	‪The row for the current element

Returns

‪string The processed icon input value.

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

Definition at line 58 of file ElementBrowserFolderTreeView.php.

References TYPO3\CMS\Core\Utility\HttpUtility\buildQueryString(), and TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getThisScript().

wrapTitle()

string TYPO3\CMS\Backend\Tree\View\ElementBrowserFolderTreeView::wrapTitle	(		$title,
			$folderObject,
			$bank = 0
	)

Wrapping the title in a link, if applicable.

Parameters

string	$title	‪Title, ready for output.
Folder	$folderObject	‪The record
int	$bank	‪Bank pointer (which mount point number)

Returns

‪string Wrapping title string.

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

Definition at line 83 of file ElementBrowserFolderTreeView.php.

References TYPO3\CMS\Backend\Tree\View\AbstractTreeView\$title, TYPO3\CMS\Core\Utility\HttpUtility\buildQueryString(), and TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getThisScript().

Member Data Documentation

$ext_IconMode

string TYPO3\CMS\Backend\Tree\View\ElementBrowserFolderTreeView::$ext_IconMode = 'titlelink'

Definition at line 34 of file ElementBrowserFolderTreeView.php.

$linkParameterProvider

LinkParameterProviderInterface TYPO3\CMS\Backend\Tree\View\ElementBrowserFolderTreeView::$linkParameterProvider

protected

Definition at line 38 of file ElementBrowserFolderTreeView.php.

Referenced by TYPO3\CMS\Backend\Tree\View\ElementBrowserFolderTreeView\setLinkParameterProvider().