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

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

Public Member Functions
	setLinkParameterProvider (LinkParameterProviderInterface $linkParameterProvider)
	wrapIcon ($icon, $folderObject)
	wrapTitle ($title, $folderObject, $bank=0)
	ext_isLinkable (Folder $folderObject)
	PM_ATagWrap ($icon, $cmd, $bMark='', $isOpen=false)
	PMiconATagWrap ($icon, $cmd, $isExpand=true)
Public Member Functions inherited from TYPO3\CMS\Backend\Tree\View\FolderTreeView
	__construct ()
	PMicon ($folderObject, $subFolderCounter, $totalSubFolders, $nextCount, $isExpanded)
	PMiconATagWrap ($icon, $cmd, $isExpand=true)
	wrapIcon ($icon, $folderObject)
	wrapTitle ($title, $folderObject, $bank=0)
	getId ($folderObject)
	getJumpToParam ($folderObject)
	getTitleStr ($row, $titleLen=30)
	getTitleAttrib ($folderObject)
	getBrowsableTree ()
	getNumberOfSubfolders (Folder $folderObject)
	initializePositionSaving ()
	getAjaxStatus ()
Public Member Functions inherited from TYPO3\CMS\Backend\Tree\View\AbstractTreeView
	__construct ()
	init ($clause='', $orderByFields='')
	addField ($field, $noCheck=false)
	reset ()
	getBrowsableTree ()
	printTree ($treeArr='')
	PMicon ($row, $a, $c, $nextCount, $isOpen)
	PM_ATagWrap ($icon, $cmd, $bMark='', $isOpen=false)
	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='')
	getCount ($uid)
	getRootRecord ()
	getRecord ($uid)
	getDataInit ($parentId)
	getDataCount (&$res)
	getDataNext (&$res)
	getDataFree (&$res)
	setDataFromArray (&$dataArr, $traverse=false, $pid=0)
	setDataFromTreeArray (&$treeArr, &$treeLookupArr)

Public Attributes
	$ext_IconMode = 'titlelink'
Public Attributes inherited from TYPO3\CMS\Backend\Tree\View\FolderTreeView
	$ext_noTempRecyclerDirs = false
	$titleAttrib = ''
	$treeName = 'folder'
	$domIdPrefix = 'folder'
Public Attributes inherited from TYPO3\CMS\Backend\Tree\View\AbstractTreeView
	$expandFirst = 0
	$expandAll = 0
	$thisScript = ''
	$titleAttrib = 'title'
	$ext_IconMode = false
	$ext_showPathAboveMounts = false
	$addSelfId = 0
	$title = 'no title'
	$showDefaultTitleAttribute = false
	$BE_USER = ''
	$MOUNTS = null
	$table = ''
	$parentField = 'pid'
	$clause = ''
	$orderByFields = ''
	$fieldArray = ['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'
	$makeHTML = 1
	$setRecs = 0
	$subLevelID = '_SUB_LEVEL'
	$ids = []
	$ids_hierarchy = []
	$orig_ids_hierarchy = []
	$buffer_idH = []
	$specUIDmap = []
	$data = false
	$dataLookup = false
	$tree = []
	$stored = []
	$bank = 0
	$recs = []

Protected Member Functions
	renderPMIconAndLink ($cmd, $isOpen)
Protected Member Functions inherited from TYPO3\CMS\Backend\Tree\View\FolderTreeView
	renderPMIconAndLink ($cmd, $isOpen)
	getShortHashNumberForStorage (ResourceStorage $storageObject=null, Folder $startingPointFolder=null)
	evaluateExpandCollapseParameter ($PM=null)
	generateExpandCollapseParameter ($mountKey=null, $doExpand=false, Folder $folderObject=null, $treeName=null)
	getLanguageService ()
Protected Member Functions inherited from TYPO3\CMS\Backend\Tree\View\AbstractTreeView
	determineScriptUrl ()
	getThisScript ()
	getLanguageService ()
	getBackendUser ()
	getDatabaseConnection ()

Protected Attributes
	$linkParameterProvider
Protected Attributes inherited from TYPO3\CMS\Backend\Tree\View\FolderTreeView
	$storages = null
	$storageHashNumbers
	$ajaxStatus = false
	$scope
	$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 29 of file ElementBrowserFolderTreeView.php.

Member Function Documentation

ext_isLinkable()

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 is returned if the path is found in the web-part of the server and is NOT a recycler or temp folder AND if ->ext_noTempRecyclerDirs is not set.

Definition at line 100 of file ElementBrowserFolderTreeView.php.

References TYPO3\CMS\Core\Resource\Folder\getIdentifier().

Referenced by TYPO3\CMS\Backend\Tree\View\ElementBrowserFolderTreeView\wrapIcon(), and TYPO3\CMS\Backend\Tree\View\ElementBrowserFolderTreeView\wrapTitle().

PM_ATagWrap()

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 private

Definition at line 129 of file ElementBrowserFolderTreeView.php.

References TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getThisScript(), TYPO3\CMS\Core\Utility\GeneralUtility\implodeArrayForUrl(), and TYPO3\CMS\Core\Utility\GeneralUtility\quoteJSvalue().

PMiconATagWrap()

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

Definition at line 148 of file ElementBrowserFolderTreeView.php.

References TYPO3\CMS\Backend\Tree\View\FolderTreeView\$ext_noTempRecyclerDirs, and TYPO3\CMS\Backend\Tree\View\AbstractTreeView\$thisScript.

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

renderPMIconAndLink()

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

protected

Parameters

string	$cmd
bool	$isOpen

Returns

string

Definition at line 111 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

Returns

void

Definition at line 46 of file ElementBrowserFolderTreeView.php.

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

wrapIcon()

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.

Definition at line 61 of file ElementBrowserFolderTreeView.php.

References TYPO3\CMS\Backend\Tree\View\ElementBrowserFolderTreeView\ext_isLinkable(), TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getThisScript(), TYPO3\CMS\Core\Utility\GeneralUtility\implodeArrayForUrl(), and TYPO3\CMS\Core\Utility\GeneralUtility\quoteJSvalue().

wrapTitle()

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.

Definition at line 84 of file ElementBrowserFolderTreeView.php.

References TYPO3\CMS\Backend\Tree\View\AbstractTreeView\$title, TYPO3\CMS\Backend\Tree\View\ElementBrowserFolderTreeView\ext_isLinkable(), TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getThisScript(), TYPO3\CMS\Core\Utility\GeneralUtility\implodeArrayForUrl(), and TYPO3\CMS\Core\Utility\GeneralUtility\quoteJSvalue().

Member Data Documentation

$ext_IconMode

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

Definition at line 34 of file ElementBrowserFolderTreeView.php.

$linkParameterProvider

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

protected

Definition at line 39 of file ElementBrowserFolderTreeView.php.

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