TYPO3\CMS\Core\Resource\FolderInterface Interface Reference

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

Public Member Functions
Folder[]	getSubfolders ()
Folder	getSubfolder ($name)
bool	hasFolder ($name)
bool	hasFile ($name)
Folder	rename ($newName)
bool	delete ()
int	getModificationTime ()
int	getCreationTime ()
‪Public Member Functions inherited from ‪TYPO3\CMS\Core\Resource\ResourceInterface
string	getIdentifier ()
string	getName ()
ResourceStorage	getStorage ()
string	getHashedIdentifier ()
FolderInterface	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 21 of file FolderInterface.php.

Member Function Documentation

delete()

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

(

)

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

Returns

‪bool TRUE if deletion succeeded

getCreationTime()

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

(

)

Returns the creation time of the folder as Unix timestamp

Returns

‪int

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

getModificationTime()

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

(

)

Returns the modification time of the folder as Unix timestamp

Returns

‪int

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

getSubfolder()

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

(

$name

)

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

Parameters

string

$name

‪Name of the subfolder

Returns

‪Folder

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

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

getSubfolders()

Folder [] TYPO3\CMS\Core\Resource\FolderInterface::getSubfolders

(

)

Returns a list of all subfolders

Returns

‪Folder[]

hasFile()

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

(

$name

)

Checks if a file exists in this folder

Parameters

string

$name

Returns

‪bool

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

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

hasFolder()

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

(

$name

)

Checks if a folder exists in this folder.

Parameters

string

$name

Returns

‪bool

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

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

rename()

Folder TYPO3\CMS\Core\Resource\FolderInterface::rename

(

$newName

)

Renames this folder.

Parameters

string

$newName

Returns

‪Folder

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

Member Data Documentation

ROLE_DEFAULT

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

Roles for folders

Definition at line 26 of file FolderInterface.php.

Referenced by TYPO3\CMS\Filelist\FileList\formatDirList(), TYPO3\CMS\Backend\Tree\View\FolderTreeView\getFolderTree(), TYPO3\CMS\Core\Resource\Driver\LocalDriver\getRole(), TYPO3\CMS\Core\Resource\ResourceStorage\getRole(), TYPO3\CMS\Core\Tests\Functional\Resource\ResourceStorageTest\getRoleReturnsDefaultForRegularFolders(), and TYPO3\CMS\Core\Resource\Utility\ListUtility\resolveSpecialFolderNames().

ROLE_MOUNT

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

Definition at line 31 of file FolderInterface.php.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\getRole(), and TYPO3\CMS\Backend\Tree\View\FolderTreeView\getTableNameForClickMenu().

ROLE_PROCESSING

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

Definition at line 28 of file FolderInterface.php.

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

ROLE_READONLY_MOUNT

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

Definition at line 32 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 27 of file FolderInterface.php.

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

ROLE_TEMPORARY

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

Definition at line 29 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 33 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 30 of file FolderInterface.php.