FolderInterface

interface \TYPO3\CMS\Core\Resource\FolderInterface

Extends
ResourceInterface

Interface for folders

Table of Contents

Constants

ROLE_DEFAULT  : mixed = 'default'
Roles for folders
ROLE_MOUNT  : mixed = 'mount'
ROLE_PROCESSING  : mixed = 'processing'
ROLE_READONLY_MOUNT  : mixed = 'readonly-mount'
ROLE_RECYCLER  : mixed = 'recycler'
ROLE_TEMPORARY  : mixed = 'temporary'
ROLE_USER_MOUNT  : mixed = 'user-mount'
ROLE_USERUPLOAD  : mixed = 'userupload'

Methods

delete()  : bool
Deletes this folder from its storage. This also means that this object becomes useless.
getCreationTime()  : int
Returns the creation time of the folder as Unix timestamp
getFile()  : FileInterface|null
Fetches a file from a folder, must be a direct descendant of a folder.
getHashedIdentifier()  : non-empty-string
getIdentifier()  : string
getModificationTime()  : int
Returns the modification time of the folder as Unix timestamp
getName()  : string
getParentFolder()  : FolderInterface
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.
rename()  : $this
Renames this folder.

Constants

ROLE_DEFAULT

Roles for folders

public mixed ROLE_DEFAULT = 'default'

ROLE_MOUNT

public mixed ROLE_MOUNT = 'mount'

ROLE_PROCESSING

public mixed ROLE_PROCESSING = 'processing'

ROLE_READONLY_MOUNT

public mixed ROLE_READONLY_MOUNT = 'readonly-mount'

ROLE_RECYCLER

public mixed ROLE_RECYCLER = 'recycler'

ROLE_TEMPORARY

public mixed ROLE_TEMPORARY = 'temporary'

ROLE_USER_MOUNT

public mixed ROLE_USER_MOUNT = 'user-mount'

ROLE_USERUPLOAD

public mixed ROLE_USERUPLOAD = 'userupload'

Methods

delete()

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

public delete() : bool

Return values

bool

getCreationTime()

Returns the creation time of the folder 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

getHashedIdentifier()

public getHashedIdentifier() : non-empty-string

Return values

non-empty-string

getIdentifier()

public getIdentifier() : string

Return values

string

getModificationTime()

Returns the modification time of the folder as Unix timestamp

public getModificationTime() : int

Return values

int

getName()

public getName() : 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

Return values

Folder

getSubfolders()

public getSubfolders() : array

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

rename()

Renames this folder.

public rename(string $newName) : $this

Parameters

$newName : string

Return values

$this
On this page