TYPO3\CMS\Core\Resource\FolderInterface Interface Reference

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

Public Member Functions
	getSubfolders ()
	getSubfolder ($name)
	hasFolder ($name)
	hasFile ($name)
	rename ($newName)
	delete ()
Public Member Functions inherited from TYPO3\CMS\Core\Resource\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

This file is part of the TYPO3 CMS project.

It is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, either version 2 of the License, or any later version.

For the full copyright and license information, please read the LICENSE.txt file that was distributed with this source code.

The TYPO3 project - inspiring people to share! Interface for folders

Author

Andreas Wolf andre.nosp@m.as.w.nosp@m.olf@t.nosp@m.ypo3.nosp@m..org

Definition at line 21 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.

Returns

boolean TRUE if deletion succeeded

getSubfolder()

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\InaccessibleFolder.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\copyFolder(), and TYPO3\CMS\Core\Resource\Folder\getFileCount().

getSubfolders()

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

(

)

Returns a list of all subfolders

Returns

Folder[]

hasFile()

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

(

$name

)

Checks if a file exists in this folder

Parameters

string

$name

Returns

boolean

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

hasFolder()

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

(

$name

)

Checks if a folder exists in this folder.

Parameters

string

$name

Returns

boolean

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

rename()

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\Backend\Tree\View\FolderTreeView\getFolderTree(), TYPO3\CMS\Core\Resource\Driver\LocalDriver\getRole(), and TYPO3\CMS\Core\Resource\ResourceStorage\getRole().

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().

ROLE_PROCESSING

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

Definition at line 28 of file FolderInterface.php.

Referenced by 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\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\Filelist\FileList\dirData().

ROLE_TEMPORARY

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

Definition at line 29 of file FolderInterface.php.

Referenced by TYPO3\CMS\Filelist\FileList\dirData().

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\Resource\ResourceStorage\getRole().

ROLE_USERUPLOAD

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

Definition at line 30 of file FolderInterface.php.