FileStorageTreeProvider

Responsible for fetching a tree-structure of folders.

Internal

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

Table of Contents

Properties

$expandedState  : array<string|int, mixed>|null
$userSettingsIdentifier  : string

Methods

getFilteredTree()  : array<string|int, FolderInterface>
Filter a tree by a search word
getRootNodes()  : array<string|int, mixed>
Fetch all file storages / file mounts visible for a user.
getSubfoldersRecursively()  : array<string|int, mixed>
prepareFolderInformation()  : array<string|int, mixed>
getFoldersInStorage()  : array<string|int, mixed>
Fetch all folders recursively in a single store.
getMountsInStorage()  : array<string|int, mixed>|array<string|int, array<string|int, mixed>>
Fetches all "root level folders" of a storage. If a user has filemounts in this storage, they are properly resolved.
getStateIdentifier()  : string
The state identifier is the folder stored in the user settings, and also used to uniquely identify a folder throughout the folder tree structure.
isExpanded()  : bool
Checks if a folder was previously opened by the user.

Properties

$expandedState

protected array<string|int, mixed>|null $expandedState = null

$userSettingsIdentifier

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

Methods

getSubfoldersRecursively()

public getSubfoldersRecursively(Folder $folderObject, int $currentDepth[, array<string|int, mixed>|null $subFolders = null ]) : array<string|int, mixed>
Parameters
$folderObject : Folder
$currentDepth : int
$subFolders : array<string|int, mixed>|null = null
Return values
array<string|int, mixed>

prepareFolderInformation()

public prepareFolderInformation(Folder $folder[, string|null $alternativeName = null ][, Folder|null $parentFolder = null ][, array<string|int, mixed>|null $children = null ]) : array<string|int, mixed>
Parameters
$folder : Folder
$alternativeName : string|null = null
$parentFolder : Folder|null = null
$children : array<string|int, mixed>|null = null
Return values
array<string|int, mixed>

getMountsInStorage()

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

protected getMountsInStorage(ResourceStorage $resourceStorage, BackendUserAuthentication $user) : array<string|int, mixed>|array<string|int, array<string|int, mixed>>
Parameters
$resourceStorage : ResourceStorage
$user : BackendUserAuthentication
Return values
array<string|int, mixed>|array<string|int, array<string|int, mixed>>

getStateIdentifier()

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

protected getStateIdentifier(Folder $folder) : string
Parameters
$folder : Folder
Return values
string

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

Search results