TYPO3CMS  8
 All Classes Namespaces Files Functions Variables Pages
FolderInterface Interface Reference
Inheritance diagram for FolderInterface:
ResourceInterface Folder InaccessibleFolder

Public Member Functions

 getSubfolders ()
 
 getSubfolder ($name)
 
 hasFolder ($name)
 
 hasFile ($name)
 
 rename ($newName)
 
 delete ()
 
 getModificationTime ()
 
 getCreationTime ()
 
- Public Member Functions inherited from ResourceInterface
 getIdentifier ()
 
 getName ()
 
 getStorage ()
 
 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 20 of file FolderInterface.php.

Member Function Documentation

delete ( )

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

Returns
bool TRUE if deletion succeeded
getCreationTime ( )

Returns the creation time of the folder as Unix timestamp

Returns
int

Implemented in Folder, and InaccessibleFolder.

getModificationTime ( )

Returns the modification time of the folder as Unix timestamp

Returns
int

Implemented in Folder, and InaccessibleFolder.

getSubfolder (   $name)

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

Parameters
string$nameName of the subfolder
Returns
Folder

Implemented in Folder, and InaccessibleFolder.

Referenced by ResourceStorage\copyFolder().

getSubfolders ( )

Returns a list of all subfolders

Returns
Folder[]
hasFile (   $name)

Checks if a file exists in this folder

Parameters
string$name
Returns
bool

Implemented in Folder, and InaccessibleFolder.

hasFolder (   $name)

Checks if a folder exists in this folder.

Parameters
string$name
Returns
bool

Implemented in Folder, and InaccessibleFolder.

rename (   $newName)

Renames this folder.

Parameters
string$newName
Returns
Folder

Implemented in Folder, and InaccessibleFolder.

Member Data Documentation

const ROLE_DEFAULT = 'default'
const ROLE_MOUNT = 'mount'

Definition at line 30 of file FolderInterface.php.

Referenced by ResourceStorage\getRole().

const ROLE_PROCESSING = 'processing'

Definition at line 27 of file FolderInterface.php.

Referenced by FileList\formatDirList(), and ResourceStorage\getRole().

const ROLE_READONLY_MOUNT = 'readonly-mount'

Definition at line 31 of file FolderInterface.php.

Referenced by IconFactory\getIconForResource(), and ResourceStorage\getRole().

const ROLE_RECYCLER = 'recycler'
const ROLE_TEMPORARY = 'temporary'

Definition at line 28 of file FolderInterface.php.

Referenced by IconFactory\getIconForResource().

const ROLE_USER_MOUNT = 'user-mount'

Definition at line 32 of file FolderInterface.php.

Referenced by IconFactory\getIconForResource(), and ResourceStorage\getRole().

const ROLE_USERUPLOAD = 'userupload'

Definition at line 29 of file FolderInterface.php.