FileStorageTreeProvider

class \TYPO3\CMS\Backend\Tree\FileStorageTreeProvider

Responsible for fetching a tree-structure of folders.

Table of Contents

Properties

$expandedState  : array|null
$userSettingsIdentifier  : string

Methods

getFilteredTree()  : FolderInterface[]
Filter a tree by a search word
getRootNodes()  : array
Fetch all file storages / file mounts visible for a user.
getSubfoldersRecursively()  : array
prepareFolderInformation()  : array
getFoldersInStorage()  : array
Fetch all folders recursively in a single store.
getMountsInStorage()  : array|array[]
Fetches all "root level folders" of a storage. If a user has file mounts in this storage, they are properly resolved.
isExpanded()  : bool
Checks if a folder was previously opened by the user.

Properties

$expandedState

protected array|null $expandedState = null

$userSettingsIdentifier

protected string $userSettingsIdentifier = 'BackendComponents.States.FileStorageTree'

Methods

getSubfoldersRecursively()

public getSubfoldersRecursively(Folder $folderObject, int $currentDepth[, array|null $subFolders = null ]) : array

Parameters

$folderObject : Folder
$currentDepth : int
$subFolders : array|null = null

Return values

array

prepareFolderInformation()

public prepareFolderInformation(Folder $folder[, string|null $alternativeName = null ][, Folder|null $parentFolder = null ][, array|null $children = null ]) : array

Parameters

$folder : Folder
$alternativeName : string|null = null
$parentFolder : Folder|null = null
$children : array|null = null

Return values

array

isExpanded()

Checks if a folder was previously opened by the user.

protected isExpanded(Folder $folder[, bool $fallback = false ]) : bool

Parameters

$folder : Folder
$fallback : bool = false

Return values

bool
On this page