Folder

class \TYPO3\CMS\Core\Resource\Folder

Implements
FolderInterface

A folder that groups files in a storage. This may be a folder on the local disk, a bucket in Amazon S3 or a user or a tag in Flickr.

This object is not persisted in TYPO3 locally, but created on the fly by storage drivers for the folders they "offer".

Some folders serve as a physical container for files (e.g. folders on the local disk, S3 buckets or Flickr users). Other folders just group files by a certain criterion, e.g. a tag. The way this is implemented depends on the storage driver.

Table of Contents

Interfaces

FolderInterface
Interface for folders

Constants

FILTER_MODE_NO_FILTERS  : mixed = 0
Modes for filter usage in getFiles()/getFolders()
FILTER_MODE_USE_OWN_AND_STORAGE_FILTERS  : mixed = 1
FILTER_MODE_USE_OWN_FILTERS  : mixed = 3
FILTER_MODE_USE_STORAGE_FILTERS  : mixed = 2

Properties

$fileAndFolderNameFilters  : callable[]
The filters this folder should use for a filelist.
$identifier  : string
The identifier of this folder to identify it on the storage.
$name  : string
The name of this folder
$storage  : ResourceStorage
The storage this folder belongs to.

Methods

__construct()  : mixed
Initialization of the folder
addFile()  : File
Adds a file from the local server disk. If the file already exists and overwriting is disabled,
addUploadedFile()  : FileInterface
Adds an uploaded file into the Storage.
checkActionPermission()  : bool
Check if a file operation (= action) is allowed on this folder
copyTo()  : Folder
Copies folder to a target folder
createFile()  : File
Creates a new blank file
createFolder()  : Folder
Creates a new folder
delete()  : bool
Deletes this folder from its storage. This also means that this object becomes useless.
getCombinedIdentifier()  : string
Returns a combined identifier of this folder, i.e. the storage UID and the folder identifier separated by a colon ":".
getCreationTime()  : int
Returns the creation time of the file as Unix timestamp
getFile()  : FileInterface|null
Fetches a file from a folder, must be a direct descendant of a folder.
getFileCount()  : int
Returns amount of all files within this folder, optionally filtered by the given pattern
getFiles()  : File[]
Returns a list of files in this folder, optionally filtered. There are several filter modes available, see the FILTER_MODE_* constants for more information.
getHashedIdentifier()  : non-empty-string
getIdentifier()  : non-empty-string
Returns the path of this folder inside the storage. It depends on the type of storage whether this is a real path or just some unique identifier.
getModificationTime()  : int
Returns the modification time of the file as Unix timestamp
getName()  : string
getParentFolder()  : FolderInterface
Returns the parent folder.
getPublicUrl()  : string|null
Returns a publicly accessible URL for this folder
getReadablePath()  : string
Returns the full path of this folder, from the root.
getRole()  : string
Returns the role of this folder (if any). See FolderInterface::ROLE_* constants for possible values.
getStorage()  : ResourceStorage
getSubfolder()  : Folder
Returns the object for a subfolder of the current folder, if it exists.
getSubfolders()  : array
hasFile()  : bool
Checks if a file exists in this folder
hasFolder()  : bool
Checks if a folder exists in this folder.
moveTo()  : Folder
Moves folder to a target folder
rename()  : $this
Renames this folder.
searchFiles()  : FileSearchResultInterface
Returns a file search result based on the given demand.
setFileAndFolderNameFilters()  : mixed
Sets the filters to use when listing files. These are only used if the filter mode is one of FILTER_MODE_USE_OWN_FILTERS and FILTER_MODE_USE_OWN_AND_STORAGE_FILTERS
setName()  : mixed
Sets a new name of the folder currently this does not trigger the "renaming process" as the name is more seen as a label
updateProperties()  : mixed
Updates the properties of this folder, e.g. after re-indexing or moving it.
prepareFiltersInStorage()  : array
Prepares the filters in this folder's storage according to a set filter mode.
restoreBackedUpFiltersInStorage()  : mixed
Restores the filters of a storage.

Constants

FILTER_MODE_NO_FILTERS

Modes for filter usage in getFiles()/getFolders()

public mixed FILTER_MODE_NO_FILTERS = 0

FILTER_MODE_USE_OWN_AND_STORAGE_FILTERS

public mixed FILTER_MODE_USE_OWN_AND_STORAGE_FILTERS = 1

FILTER_MODE_USE_OWN_FILTERS

public mixed FILTER_MODE_USE_OWN_FILTERS = 3

FILTER_MODE_USE_STORAGE_FILTERS

public mixed FILTER_MODE_USE_STORAGE_FILTERS = 2

Properties

$fileAndFolderNameFilters

The filters this folder should use for a filelist.

protected callable[] $fileAndFolderNameFilters = []

$identifier

The identifier of this folder to identify it on the storage.

protected string $identifier

On some drivers, this is the path to the folder, but drivers could also just provide any other unique identifier for this folder on the specific storage.

$name

The name of this folder

protected string $name

Methods

__construct()

Initialization of the folder

public __construct(ResourceStorage $storage, string $identifier, string $name) : mixed

Parameters

$storage : ResourceStorage
$identifier : string
$name : string

addFile()

Adds a file from the local server disk. If the file already exists and overwriting is disabled,

public addFile(string $localFilePath[, string $fileName = null ][, string|DuplicationBehavior $conflictMode = DuplicationBehavior::CANCEL ]) : File

Parameters

$localFilePath : string
$fileName : string = null
$conflictMode : string|DuplicationBehavior = DuplicationBehavior::CANCEL

Tags

throws
ExistingTargetFileNameException
todo

change $conflictMode parameter type to DuplicationBehavior in TYPO3 v14.0

Return values

File —

The file object

addUploadedFile()

Adds an uploaded file into the Storage.

public addUploadedFile(array|UploadedFileInterface $uploadedFileData[, string|DuplicationBehavior $conflictMode = DuplicationBehavior::CANCEL ]) : FileInterface

Parameters

$uploadedFileData : array|UploadedFileInterface

Information about the uploaded file given by $_FILES['file1'] or a PSR-7 UploadedFileInterface object

$conflictMode : string|DuplicationBehavior = DuplicationBehavior::CANCEL

Tags

todo

change $conflictMode parameter type to DuplicationBehavior in TYPO3 v14.0

Return values

FileInterface —

The file object

checkActionPermission()

Check if a file operation (= action) is allowed on this folder

public checkActionPermission(string $action) : bool

Parameters

$action : string

Action that can be read, write or delete

Return values

bool

copyTo()

Copies folder to a target folder

public copyTo(Folder $targetFolder[, string $targetFolderName = null ][, string|DuplicationBehavior $conflictMode = DuplicationBehavior::RENAME ]) : Folder

Parameters

$targetFolder : Folder

Target folder to copy to.

$targetFolderName : string = null

an optional destination fileName

$conflictMode : string|DuplicationBehavior = DuplicationBehavior::RENAME

Tags

todo

change $conflictMode parameter type to DuplicationBehavior in TYPO3 v14.0

Return values

Folder —

New (copied) folder object.

createFile()

Creates a new blank file

public createFile(string $fileName) : File

Parameters

$fileName : string

Return values

File —

The new file object

delete()

Deletes this folder from its storage. This also means that this object becomes useless.

public delete([bool $deleteRecursively = true ]) : bool

Parameters

$deleteRecursively : bool = true

Return values

bool

getCombinedIdentifier()

Returns a combined identifier of this folder, i.e. the storage UID and the folder identifier separated by a colon ":".

public getCombinedIdentifier() : string

Return values

string —

Combined storage and folder identifier, e.g. StorageUID:folder/path/

getCreationTime()

Returns the creation time of the file as Unix timestamp

public getCreationTime() : int

Return values

int

getFile()

Fetches a file from a folder, must be a direct descendant of a folder.

public getFile(string $fileName) : FileInterface|null

Parameters

$fileName : string

Return values

FileInterface|null

getFileCount()

Returns amount of all files within this folder, optionally filtered by the given pattern

public getFileCount([array $filterMethods = [] ][, bool $recursive = false ]) : int

Parameters

$filterMethods : array = []
$recursive : bool = false

Tags

throws
InsufficientFolderAccessPermissionsException

Return values

int

getFiles()

Returns a list of files in this folder, optionally filtered. There are several filter modes available, see the FILTER_MODE_* constants for more information.

public getFiles([int $start = 0 ][, int $numberOfItems = 0 ][, int $filterMode = self::FILTER_MODE_USE_OWN_AND_STORAGE_FILTERS ][, bool $recursive = false ][, string $sort = '' ][, bool $sortRev = false ]) : File[]

For performance reasons the returned items can also be limited to a given range

Parameters

$start : int = 0

The item to start at

$numberOfItems : int = 0

The number of items to return

$filterMode : int = self::FILTER_MODE_USE_OWN_AND_STORAGE_FILTERS

The filter mode to use for the filelist.

$recursive : bool = false
$sort : string = ''

Property name used to sort the items. Among them may be: '' (empty, no sorting), name, fileext, size, tstamp and rw. If a driver does not support the given property, it should fall back to "name".

$sortRev : bool = false

TRUE to indicate reverse sorting (last to first)

Return values

File[]

getHashedIdentifier()

public getHashedIdentifier() : non-empty-string

Return values

non-empty-string

getIdentifier()

Returns the path of this folder inside the storage. It depends on the type of storage whether this is a real path or just some unique identifier.

public getIdentifier() : non-empty-string

Return values

non-empty-string

getModificationTime()

Returns the modification time of the file as Unix timestamp

public getModificationTime() : int

Return values

int

getName()

public getName() : string

Return values

string

getPublicUrl()

Returns a publicly accessible URL for this folder

public getPublicUrl() : string|null

WARNING: Access to the folder may be restricted by further means, e.g. some web-based authentication. You have to take care of this yourself.

Return values

string|null —

NULL if file is missing or deleted, the generated url otherwise

getReadablePath()

Returns the full path of this folder, from the root.

public getReadablePath([string $rootId = null ]) : string

Parameters

$rootId : string = null

ID of the root folder, NULL to auto-detect

Return values

string

getRole()

Returns the role of this folder (if any). See FolderInterface::ROLE_* constants for possible values.

public getRole() : string

Return values

string

getSubfolder()

Returns the object for a subfolder of the current folder, if it exists.

public getSubfolder(string $name) : Folder

Parameters

$name : string

Tags

throws
InvalidArgumentException

Return values

Folder

getSubfolders()

public getSubfolders([int $start = 0 ][, int $numberOfItems = 0 ][, int $filterMode = self::FILTER_MODE_USE_OWN_AND_STORAGE_FILTERS ][, bool $recursive = false ]) : array

Parameters

$start : int = 0

The item to start at

$numberOfItems : int = 0

The number of items to return

$filterMode : int = self::FILTER_MODE_USE_OWN_AND_STORAGE_FILTERS

The filter mode to use for the filelist.

$recursive : bool = false

Tags

phpstan-return

array<array-key, Folder>

Return values

array

hasFile()

Checks if a file exists in this folder

public hasFile(string $name) : bool

Parameters

$name : string

Return values

bool

hasFolder()

Checks if a folder exists in this folder.

public hasFolder(string $name) : bool

Parameters

$name : string

Return values

bool

moveTo()

Moves folder to a target folder

public moveTo(Folder $targetFolder[, string $targetFolderName = null ][, string|DuplicationBehavior $conflictMode = DuplicationBehavior::RENAME ]) : Folder

Parameters

$targetFolder : Folder

Target folder to move to.

$targetFolderName : string = null

an optional destination fileName

$conflictMode : string|DuplicationBehavior = DuplicationBehavior::RENAME

Tags

todo

change $conflictMode parameter type to DuplicationBehavior in TYPO3 v14.0

Return values

Folder —

New (copied) folder object.

rename()

Renames this folder.

public rename(string $newName) : $this

Parameters

$newName : string

Return values

$this

searchFiles()

Returns a file search result based on the given demand.

public searchFiles(FileSearchDemand $searchDemand[, int $filterMode = self::FILTER_MODE_USE_OWN_AND_STORAGE_FILTERS ]) : FileSearchResultInterface

The result also includes matches in meta data fields that are defined in TCA.

Parameters

$searchDemand : FileSearchDemand
$filterMode : int = self::FILTER_MODE_USE_OWN_AND_STORAGE_FILTERS

The filter mode to use for the found files

Return values

FileSearchResultInterface

setFileAndFolderNameFilters()

Sets the filters to use when listing files. These are only used if the filter mode is one of FILTER_MODE_USE_OWN_FILTERS and FILTER_MODE_USE_OWN_AND_STORAGE_FILTERS

public setFileAndFolderNameFilters(array $filters) : mixed

Parameters

$filters : array

setName()

Sets a new name of the folder currently this does not trigger the "renaming process" as the name is more seen as a label

public setName(string $name) : mixed

Parameters

$name : string

The new name

updateProperties()

Updates the properties of this folder, e.g. after re-indexing or moving it.

public updateProperties(array $properties) : mixed

NOTE: This method should not be called from outside the File Abstraction Layer (FAL)!

Parameters

$properties : array

prepareFiltersInStorage()

Prepares the filters in this folder's storage according to a set filter mode.

protected prepareFiltersInStorage(int $filterMode) : array

Parameters

$filterMode : int

The filter mode to use; one of the FILTER_MODE_* constants

Return values

array —

The backed up filters as an array (NULL if filters were not backed up) and whether to use filters or not (bool)

restoreBackedUpFiltersInStorage()

Restores the filters of a storage.

protected restoreBackedUpFiltersInStorage(array $backedUpFilters) : mixed

Parameters

$backedUpFilters : array

The filters to restore; might be NULL if no filters have been backed up, in which case this method does nothing.

Tags

see
prepareFiltersInStorage()
On this page