TYPO3\CMS\Core\Resource\FolderInterface Interface Reference

Inheritance diagram for TYPO3\CMS\Core\Resource\FolderInterface:

Public Member Functions
	getSubfolders ()
	getSubfolder (string $name)
	hasFolder (string $name)
	hasFile (string $name)
	getFile (string $fileName)
$this	rename (string $newName)
	delete ()
	getModificationTime ()
	getCreationTime ()
‪Public Member Functions inherited from ‪TYPO3\CMS\Core\Resource\ResourceInterface
	getIdentifier ()
	getName ()
	getStorage ()
non empty string	getHashedIdentifier ()
	getParentFolder ()

Public Attributes
const	ROLE_DEFAULT = 'default'
const	ROLE_RECYCLER = 'recycler'
const	ROLE_PROCESSING = 'processing'
const	ROLE_TEMPORARY = 'temporary'
const	ROLE_USERUPLOAD = 'userupload'
const	ROLE_MOUNT = 'mount'
const	ROLE_READONLY_MOUNT = 'readonly-mount'
const	ROLE_USER_MOUNT = 'user-mount'

Detailed Description

Interface for folders

Definition at line 23 of file FolderInterface.php.

Member Function Documentation

delete()

TYPO3\CMS\Core\Resource\FolderInterface::delete

(

)

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

getCreationTime()

TYPO3\CMS\Core\Resource\FolderInterface::getCreationTime

(

)

Returns the creation time of the folder as Unix timestamp

Implemented in TYPO3\CMS\Core\Resource\Folder, and TYPO3\CMS\Core\Resource\InaccessibleFolder.

getFile()

TYPO3\CMS\Core\Resource\FolderInterface::getFile

(

string

$fileName

)

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

Implemented in TYPO3\CMS\Core\Resource\Folder.

getModificationTime()

TYPO3\CMS\Core\Resource\FolderInterface::getModificationTime

(

)

Returns the modification time of the folder as Unix timestamp

Implemented in TYPO3\CMS\Core\Resource\Folder, and TYPO3\CMS\Core\Resource\InaccessibleFolder.

getSubfolder()

TYPO3\CMS\Core\Resource\FolderInterface::getSubfolder

(

string

$name

)

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

Implemented in TYPO3\CMS\Core\Resource\Folder.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\copyFolder().

getSubfolders()

TYPO3\CMS\Core\Resource\FolderInterface::getSubfolders

(

)

@phpstan-return array<array-key, Folder>

hasFile()

TYPO3\CMS\Core\Resource\FolderInterface::hasFile

(

string

$name

)

Checks if a file exists in this folder

Implemented in TYPO3\CMS\Core\Resource\Folder.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\copyFolder().

hasFolder()

TYPO3\CMS\Core\Resource\FolderInterface::hasFolder

(

string

$name

)

Checks if a folder exists in this folder.

Implemented in TYPO3\CMS\Core\Resource\Folder.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\copyFolder().

rename()

$this TYPO3\CMS\Core\Resource\FolderInterface::rename

(

string

$newName

)

Renames this folder.

Returns

‪$this

Implemented in TYPO3\CMS\Core\Resource\Folder.

Member Data Documentation

ROLE_DEFAULT

const TYPO3\CMS\Core\Resource\FolderInterface::ROLE_DEFAULT = 'default'

Roles for folders

Definition at line 28 of file FolderInterface.php.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\getRole(), TYPO3\CMS\Core\Tests\Functional\Resource\StorageRepositoryTest\getRoleReturnsDefaultForRegularFolders(), and TYPO3\CMS\Filelist\FileList\renderName().

ROLE_MOUNT

const TYPO3\CMS\Core\Resource\FolderInterface::ROLE_MOUNT = 'mount'

Definition at line 33 of file FolderInterface.php.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\getRole(), and TYPO3\CMS\Backend\Tree\FileStorageTreeProvider\prepareFolderInformation().

ROLE_PROCESSING

const TYPO3\CMS\Core\Resource\FolderInterface::ROLE_PROCESSING = 'processing'

Definition at line 30 of file FolderInterface.php.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\getRole(), and TYPO3\CMS\Filelist\FileList\render().

ROLE_READONLY_MOUNT

const TYPO3\CMS\Core\Resource\FolderInterface::ROLE_READONLY_MOUNT = 'readonly-mount'

Definition at line 34 of file FolderInterface.php.

Referenced by TYPO3\CMS\Core\Imaging\IconFactory\getIconForResource(), and TYPO3\CMS\Core\Resource\ResourceStorage\getRole().

ROLE_RECYCLER

const TYPO3\CMS\Core\Resource\FolderInterface::ROLE_RECYCLER = 'recycler'

Definition at line 29 of file FolderInterface.php.

Referenced by TYPO3\CMS\Core\Imaging\IconFactory\getIconForResource(), TYPO3\CMS\Core\Resource\ResourceStorage\getNearestRecyclerFolder(), and TYPO3\CMS\Form\Slot\FilePersistenceSlot\isRecycleFolder().

ROLE_TEMPORARY

const TYPO3\CMS\Core\Resource\FolderInterface::ROLE_TEMPORARY = 'temporary'

Definition at line 31 of file FolderInterface.php.

Referenced by TYPO3\CMS\Core\Imaging\IconFactory\getIconForResource().

ROLE_USER_MOUNT

const TYPO3\CMS\Core\Resource\FolderInterface::ROLE_USER_MOUNT = 'user-mount'

Definition at line 35 of file FolderInterface.php.

Referenced by TYPO3\CMS\Core\Imaging\IconFactory\getIconForResource(), and TYPO3\CMS\Core\Resource\ResourceStorage\getRole().

ROLE_USERUPLOAD

const TYPO3\CMS\Core\Resource\FolderInterface::ROLE_USERUPLOAD = 'userupload'

Definition at line 32 of file FolderInterface.php.