Public Member Functions
	prepareFolderInformation (Folder $folder, ?string $alternativeName=null, ?Folder $parentFolder=null, ?array $children=null)

	getRootNodes (BackendUserAuthentication $user)

FolderInterface[]	getFilteredTree (BackendUserAuthentication $user, string $search)

	getSubfoldersRecursively (Folder $folderObject, int $currentDepth, ?array $subFolders=null)

Protected Member Functions
	getFoldersInStorage (ResourceStorage $resourceStorage, BackendUserAuthentication $user)

array array[]	getMountsInStorage (ResourceStorage $resourceStorage, BackendUserAuthentication $user)

	getStateIdentifier (Folder $folder)

	isExpanded (Folder $folder, bool $fallback=false)

Protected Attributes
array	$expandedState = null

string	$userSettingsIdentifier = 'BackendComponents.States.FileStorageTree'

Detailed Description

Responsible for fetching a tree-structure of folders.

not part of TYPO3 Core API due to the specific use case for the FileStorageTree component.

Definition at line 38 of file FileStorageTreeProvider.php.

Member Function Documentation

◆ getFilteredTree()

FolderInterface [] TYPO3\CMS\Backend\Tree\FileStorageTreeProvider::getFilteredTree	(	BackendUserAuthentication	$user,
		string	$search
	)

Filter a tree by a search word

Returns: ‪FolderInterface[]

Exceptions

Definition at line 131 of file FileStorageTreeProvider.php.

References TYPO3\CMS\Webhooks\Message\$identifier, TYPO3\CMS\Core\Resource\Folder\getCombinedIdentifier(), TYPO3\CMS\Core\Authentication\BackendUserAuthentication\getFileStorages(), TYPO3\CMS\Core\Resource\Folder\getIdentifier(), and TYPO3\CMS\Core\Resource\Folder\getParentFolder().

◆ getFoldersInStorage()

TYPO3\CMS\Backend\Tree\FileStorageTreeProvider::getFoldersInStorage	(	ResourceStorage	$resourceStorage,
		BackendUserAuthentication	$user
	)

protected

Fetch all folders recursively in a single store.

Definition at line 98 of file FileStorageTreeProvider.php.

References TYPO3\CMS\Backend\Tree\FileStorageTreeProvider\getMountsInStorage(), TYPO3\CMS\Backend\Tree\FileStorageTreeProvider\getSubfoldersRecursively(), TYPO3\CMS\Core\Resource\ResourceStorage\isBrowsable(), TYPO3\CMS\Backend\Tree\FileStorageTreeProvider\isExpanded(), and TYPO3\CMS\Backend\Tree\FileStorageTreeProvider\prepareFolderInformation().

Referenced by TYPO3\CMS\Backend\Tree\FileStorageTreeProvider\getRootNodes().

◆ getMountsInStorage()

array array [] TYPO3\CMS\Backend\Tree\FileStorageTreeProvider::getMountsInStorage	(	ResourceStorage	$resourceStorage,
		BackendUserAuthentication	$user
	)

protected

Fetches all "root level folders" of a storage. If a user has filemounts in this storage, they are properly resolved.

Returns: ‪array|array[]

Definition at line 243 of file FileStorageTreeProvider.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\getFileMounts(), TYPO3\CMS\Core\Resource\ResourceStorage\getName(), TYPO3\CMS\Core\Resource\ResourceStorage\getRootLevelFolder(), and TYPO3\CMS\Core\Authentication\BackendUserAuthentication\isAdmin().

Referenced by TYPO3\CMS\Backend\Tree\FileStorageTreeProvider\getFoldersInStorage().

◆ getRootNodes()

TYPO3\CMS\Backend\Tree\FileStorageTreeProvider::getRootNodes ( BackendUserAuthentication $user )

Fetch all file storages / file mounts visible for a user.

Definition at line 85 of file FileStorageTreeProvider.php.

References TYPO3\CMS\Core\Authentication\BackendUserAuthentication\getFileStorages(), and TYPO3\CMS\Backend\Tree\FileStorageTreeProvider\getFoldersInStorage().

◆ getStateIdentifier()

TYPO3\CMS\Backend\Tree\FileStorageTreeProvider::getStateIdentifier ( Folder $folder )

protected

The state identifier is the folder stored in the user settings, and also used to uniquely identify a folder throughout the folder tree structure.

Definition at line 270 of file FileStorageTreeProvider.php.

References TYPO3\CMS\Core\Resource\Folder\getIdentifier(), TYPO3\CMS\Core\Resource\Folder\getStorage(), and TYPO3\CMS\Core\Utility\GeneralUtility\md5int().

Referenced by TYPO3\CMS\Backend\Tree\FileStorageTreeProvider\isExpanded(), and TYPO3\CMS\Backend\Tree\FileStorageTreeProvider\prepareFolderInformation().

◆ getSubfoldersRecursively()

TYPO3\CMS\Backend\Tree\FileStorageTreeProvider::getSubfoldersRecursively	(	Folder	$folderObject,
		int	$currentDepth,
		?array	$subFolders = `null`
	)

Definition at line 198 of file FileStorageTreeProvider.php.

References TYPO3\CMS\Core\Resource\Folder\getSubfolders(), TYPO3\CMS\Backend\Tree\FileStorageTreeProvider\isExpanded(), and TYPO3\CMS\Backend\Tree\FileStorageTreeProvider\prepareFolderInformation().

Referenced by TYPO3\CMS\Backend\Tree\FileStorageTreeProvider\getFoldersInStorage().

◆ isExpanded()

TYPO3\CMS\Backend\Tree\FileStorageTreeProvider::isExpanded	(	Folder	$folder,
		bool	$fallback = `false`
	)

protected

Checks if a folder was previously opened by the user.

Definition at line 278 of file FileStorageTreeProvider.php.

References TYPO3\CMS\Backend\Tree\FileStorageTreeProvider\getStateIdentifier().

Referenced by TYPO3\CMS\Backend\Tree\FileStorageTreeProvider\getFoldersInStorage(), and TYPO3\CMS\Backend\Tree\FileStorageTreeProvider\getSubfoldersRecursively().

◆ prepareFolderInformation()

TYPO3\CMS\Backend\Tree\FileStorageTreeProvider::prepareFolderInformation	(	Folder	$folder,
		?string	$alternativeName = `null`,
		?Folder	$parentFolder = `null`,
		?array	$children = `null`
	)