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

Public Member Functions
	__construct (ResourceStorage $storage, $identifier, $name)

	getName ()

string	getReadablePath ($rootId=null)

	setName ($name)

	getStorage ()

non empty string	getIdentifier ()

	getHashedIdentifier ()

string	getCombinedIdentifier ()

string null	getPublicUrl ()

TYPO3 CMS Core Resource File[]	getFiles ($start=0, $numberOfItems=0, $filterMode=self::FILTER_MODE_USE_OWN_AND_STORAGE_FILTERS, $recursive=false, $sort='', $sortRev=false)

	searchFiles (FileSearchDemand $searchDemand, int $filterMode=self::FILTER_MODE_USE_OWN_AND_STORAGE_FILTERS)

int	getFileCount (array $filterMethods=[], $recursive=false)

	getSubfolder (string $name)

	getSubfolders ($start=0, $numberOfItems=0, $filterMode=self::FILTER_MODE_USE_OWN_AND_STORAGE_FILTERS, $recursive=false)

File	addFile ($localFilePath, $fileName=null, $conflictMode=DuplicationBehavior::CANCEL)

File	addUploadedFile (array $uploadedFileData, $conflictMode=DuplicationBehavior::CANCEL)

	rename (string $newName)

	delete ($deleteRecursively=true)

File	createFile ($fileName)

Folder	createFolder ($folderName)

Folder	copyTo (Folder $targetFolder, $targetFolderName=null, $conflictMode=DuplicationBehavior::RENAME)

Folder	moveTo (Folder $targetFolder, $targetFolderName=null, $conflictMode=DuplicationBehavior::RENAME)

	hasFile (string $name)

	getFile (string $fileName)

	hasFolder (string $name)

bool	checkActionPermission ($action)

	updateProperties (array $properties)

	setFileAndFolderNameFilters (array $filters)

string	getRole ()

	getParentFolder ()

	getModificationTime ()

	getCreationTime ()

‪Public Member Functions inherited from ‪TYPO3\CMS\Core\Resource\FolderInterface
	getSubfolders ()

	delete ()

Public Attributes
const	FILTER_MODE_NO_FILTERS = 0

const	FILTER_MODE_USE_OWN_AND_STORAGE_FILTERS = 1

const	FILTER_MODE_USE_STORAGE_FILTERS = 2

const	FILTER_MODE_USE_OWN_FILTERS = 3

‪Public Attributes inherited from ‪TYPO3\CMS\Core\Resource\FolderInterface
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'

Protected Member Functions
array	prepareFiltersInStorage ($filterMode)

	restoreBackedUpFiltersInStorage ($backedUpFilters)

Protected Attributes
ResourceStorage	$storage

string	$identifier

string	$name

callable[]	$fileAndFolderNameFilters = array( )

Detailed Description

A folder that groups files in a storage. This may be a folder on the local disk, a bucket in Amazon S3 or a user or a tag in Flickr.

This object is not persisted in TYPO3 locally, but created on the fly by storage drivers for the folders they "offer".

Some folders serve as a physical container for files (e.g. folders on the local disk, S3 buckets or Flickr users). Other folders just group files by a certain criterion, e.g. a tag. The way this is implemented depends on the storage driver.

Definition at line 37 of file Folder.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Core\Resource\Folder::__construct	(	ResourceStorage	$storage,
			$identifier,
			$name
	)

Initialization of the folder

Parameters

string	$identifier
string	$name

Definition at line 82 of file Folder.php.

References TYPO3\CMS\Core\Resource\Folder\$identifier, TYPO3\CMS\Core\Resource\Folder\$name, and TYPO3\CMS\Core\Resource\Folder\$storage.

Member Function Documentation

◆ addFile()

File TYPO3\CMS\Core\Resource\Folder::addFile	(	$localFilePath,
		$fileName = `null`,
		$conflictMode = `DuplicationBehavior::CANCEL`
	)

Adds a file from the local server disk. If the file already exists and overwriting is disabled,

Parameters

string	$localFilePath
string	$fileName
string \| DuplicationBehavior	$conflictMode

Returns: ‪File The file object

Todo:: ‪change $conflictMode parameter type to DuplicationBehavior in TYPO3 v14.0

Reimplemented in TYPO3\CMS\Core\Resource\InaccessibleFolder.

Definition at line 285 of file Folder.php.

References TYPO3\CMS\Core\Utility\PathUtility\basename(), and TYPO3\CMS\Core\Resource\Enum\getDefaultDuplicationBehaviour.

Referenced by TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\AbstractOnlineMediaHelper\createNewFile().

◆ addUploadedFile()

File TYPO3\CMS\Core\Resource\Folder::addUploadedFile	(	array	$uploadedFileData,
			$conflictMode = `DuplicationBehavior::CANCEL`
	)

Adds an uploaded file into the Storage.

Parameters

array	$uploadedFileData	‪contains information about the uploaded file given by $_FILES['file1']
string \| DuplicationBehavior	$conflictMode

Returns: ‪File The file object

Todo:: ‪change $conflictMode parameter type to DuplicationBehavior in TYPO3 v14.0

Reimplemented in TYPO3\CMS\Core\Resource\InaccessibleFolder.

Definition at line 309 of file Folder.php.

References TYPO3\CMS\Core\Resource\Enum\getDefaultDuplicationBehaviour.

◆ checkActionPermission()

bool TYPO3\CMS\Core\Resource\Folder::checkActionPermission ( $action )

Check if a file operation (= action) is allowed on this folder

Parameters

string $action ‪Action that can be read, write or delete

Returns: ‪bool

Definition at line 442 of file Folder.php.

References TYPO3\CMS\Core\Resource\Folder\getStorage().

Referenced by TYPO3\CMS\Backend\View\FolderUtilityRenderer\createFolder(), TYPO3\CMS\Backend\Form\Element\LinkElement\getLinkExplanation(), TYPO3\CMS\Filelist\FileList\getSortingValueForFolder(), and TYPO3\CMS\Backend\View\FolderUtilityRenderer\uploadForm().

◆ copyTo()

Folder TYPO3\CMS\Core\Resource\Folder::copyTo	(	Folder	$targetFolder,
			$targetFolderName = `null`,
			$conflictMode = `DuplicationBehavior::RENAME`
	)

Copies folder to a target folder

Parameters

Folder	$targetFolder	‪Target folder to copy to.
string	$targetFolderName	‪an optional destination fileName
string \| DuplicationBehavior	$conflictMode

Returns: ‪Folder New (copied) folder object.

Todo:: ‪change $conflictMode parameter type to DuplicationBehavior in TYPO3 v14.0

Reimplemented in TYPO3\CMS\Core\Resource\InaccessibleFolder.

Definition at line 372 of file Folder.php.

References TYPO3\CMS\Core\Resource\Enum\getDefaultDuplicationBehaviour, and TYPO3\CMS\Core\Resource\Folder\getStorage().

◆ createFile()

File TYPO3\CMS\Core\Resource\Folder::createFile ( $fileName )

Creates a new blank file

Parameters

string $fileName

Returns: ‪File The new file object

Reimplemented in TYPO3\CMS\Core\Resource\InaccessibleFolder.

Definition at line 347 of file Folder.php.

Referenced by TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter\provideFolderInitialization().

◆ createFolder()

Folder TYPO3\CMS\Core\Resource\Folder::createFolder ( $folderName )

Creates a new folder

Parameters

string $folderName

Returns: ‪Folder The new folder object

Reimplemented in TYPO3\CMS\Core\Resource\InaccessibleFolder.

Definition at line 358 of file Folder.php.

References TYPO3\CMS\Core\Resource\Folder\createFolder().

Referenced by TYPO3\CMS\Core\Resource\Folder\createFolder(), TYPO3\CMS\Core\Resource\ResourceStorage\getNestedProcessingFolder(), and TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter\provideTargetFolder().

◆ delete()

TYPO3\CMS\Core\Resource\Folder::delete ( $deleteRecursively = true )

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

Parameters

bool $deleteRecursively

Reimplemented in TYPO3\CMS\Core\Resource\InaccessibleFolder.

Definition at line 336 of file Folder.php.

◆ getCombinedIdentifier()

string TYPO3\CMS\Core\Resource\Folder::getCombinedIdentifier ( )

Returns a combined identifier of this folder, i.e. the storage UID and the folder identifier separated by a colon ":".

Returns: ‪string Combined storage and folder identifier, e.g. StorageUID:folder/path/

Definition at line 166 of file Folder.php.

References TYPO3\CMS\Core\Resource\Folder\getIdentifier(), and TYPO3\CMS\Core\Resource\Folder\getStorage().

Referenced by TYPO3\CMS\Backend\View\FolderUtilityRenderer\createFolder(), TYPO3\CMS\Backend\Tree\FileStorageTreeProvider\getFilteredTree(), TYPO3\CMS\Backend\Clipboard\Clipboard\getTabItems(), TYPO3\CMS\Core\Resource\ResourceStorage\isProcessingFolder(), TYPO3\CMS\Backend\Tree\FileStorageTreeProvider\prepareFolderInformation(), and TYPO3\CMS\Backend\View\FolderUtilityRenderer\uploadForm().

◆ getCreationTime()

TYPO3\CMS\Core\Resource\Folder::getCreationTime ( )

Returns the creation time of the file as Unix timestamp

Implements TYPO3\CMS\Core\Resource\FolderInterface.

Reimplemented in TYPO3\CMS\Core\Resource\InaccessibleFolder.

Definition at line 569 of file Folder.php.

◆ getFile()

TYPO3\CMS\Core\Resource\Folder::getFile ( string $fileName )

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

Implements TYPO3\CMS\Core\Resource\FolderInterface.

Definition at line 420 of file Folder.php.

◆ getFileCount()

int TYPO3\CMS\Core\Resource\Folder::getFileCount	(	array	$filterMethods = `[]`,
			$recursive = `false`
	)

Returns amount of all files within this folder, optionally filtered by the given pattern

Parameters

bool $recursive

Returns: ‪int

Exceptions

Exception

Reimplemented in TYPO3\CMS\Core\Resource\InaccessibleFolder.

Definition at line 242 of file Folder.php.

Referenced by TYPO3\CMS\Filelist\FileList\getSortingValueForFolder(), and TYPO3\CMS\Form\Domain\Finishers\DeleteUploadsFinisher\isEmptyFolder().

◆ getFiles()

TYPO3 CMS Core Resource File [] TYPO3\CMS\Core\Resource\Folder::getFiles	(	$start = `0`,
		$numberOfItems = `0`,
		$filterMode = `self::FILTER_MODE_USE_OWN_AND_STORAGE_FILTERS`,
		$recursive = `false`,
		$sort = `''`,
		$sortRev = `false`
	)

Returns a list of files in this folder, optionally filtered. There are several filter modes available, see the FILTER_MODE_* constants for more information.

For performance reasons the returned items can also be limited to a given range

Parameters

int	$start	‪The item to start at
int	$numberOfItems	‪The number of items to return
int	$filterMode	‪The filter mode to use for the filelist.
bool	$recursive
string	$sort	‪Property name used to sort the items. Among them may be: '' (empty, no sorting), name, fileext, size, tstamp and rw. If a driver does not support the given property, it should fall back to "name".
bool	$sortRev	‪TRUE to indicate reverse sorting (last to first)

Returns: ‪\TYPO3\CMS\Core\Resource\File[]

Reimplemented in TYPO3\CMS\Core\Resource\InaccessibleFolder.

Definition at line 202 of file Folder.php.

References TYPO3\CMS\Core\Resource\Folder\prepareFiltersInStorage(), and TYPO3\CMS\Core\Resource\Folder\restoreBackedUpFiltersInStorage().

Referenced by TYPO3\CMS\Scheduler\Task\RecyclerGarbageCollectionTask\cleanupRecycledFiles(), TYPO3\CMS\Core\Utility\File\ExtendedFileUtility\folderHasFilesInUse(), TYPO3\CMS\Core\Resource\ResourceStorage\getAllFileObjectsInFolder(), and TYPO3\CMS\Filelist\Controller\FileDownloadController\getFilesAndFoldersRecursive().

◆ getHashedIdentifier()

TYPO3\CMS\Core\Resource\Folder::getHashedIdentifier ( )

Returns: ‪non-empty-string

Implements TYPO3\CMS\Core\Resource\ResourceInterface.

Definition at line 155 of file Folder.php.

Referenced by TYPO3\CMS\Core\Resource\Index\FileIndexRepository\findByFolder(), and TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\AbstractOnlineMediaHelper\findExistingFileByOnlineMediaId().

◆ getIdentifier()

non empty string TYPO3\CMS\Core\Resource\Folder::getIdentifier ( )

Returns the path of this folder inside the storage. It depends on the type of storage whether this is a real path or just some unique identifier.

Returns: ‪non-empty-string

Implements TYPO3\CMS\Core\Resource\ResourceInterface.

Definition at line 150 of file Folder.php.

References TYPO3\CMS\Core\Resource\Folder\$identifier.

◆ getModificationTime()

TYPO3\CMS\Core\Resource\Folder::getModificationTime ( )

Returns the modification time of the file as Unix timestamp

Implements TYPO3\CMS\Core\Resource\FolderInterface.

Reimplemented in TYPO3\CMS\Core\Resource\InaccessibleFolder.

Definition at line 561 of file Folder.php.

◆ getName()

TYPO3\CMS\Core\Resource\Folder::getName ( )

Implements TYPO3\CMS\Core\Resource\ResourceInterface.

Definition at line 89 of file Folder.php.

References TYPO3\CMS\Core\Resource\Folder\$name.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\assureFolderDeletePermission(), TYPO3\CMS\Filelist\FileList\getSortingValueForFolder(), TYPO3\CMS\Core\Resource\ResourceStorage\moveFolder(), TYPO3\CMS\Backend\Tree\FileStorageTreeProvider\prepareFolderInformation(), and TYPO3\CMS\Core\Resource\InaccessibleFolder\throwInaccessibleException().

◆ getParentFolder()

TYPO3\CMS\Core\Resource\Folder::getParentFolder ( )

Returns the parent folder.

In non-hierarchical storages, that always is the root folder.

The parent folder of the root folder is the root folder.

Exceptions

InsufficientFolderAccessPermissionsException

Implements TYPO3\CMS\Core\Resource\ResourceInterface.

Definition at line 553 of file Folder.php.

References TYPO3\CMS\Core\Resource\Folder\getIdentifier(), and TYPO3\CMS\Core\Resource\Folder\getStorage().

Referenced by TYPO3\CMS\Backend\Tree\FileStorageTreeProvider\getFilteredTree(), TYPO3\CMS\Core\Resource\ResourceStorage\getNearestRecyclerFolder(), TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\getPropertiesForTable(), TYPO3\CMS\Core\Resource\Folder\getReadablePath(), and TYPO3\CMS\Backend\Tree\FileStorageTreeProvider\prepareFolderInformation().

◆ getPublicUrl()

string null TYPO3\CMS\Core\Resource\Folder::getPublicUrl ( )

Returns a publicly accessible URL for this folder

WARNING: Access to the folder may be restricted by further means, e.g. some web-based authentication. You have to take care of this yourself.

Returns: ‪string|null NULL if file is missing or deleted, the generated url otherwise

Reimplemented in TYPO3\CMS\Core\Resource\InaccessibleFolder.

Definition at line 179 of file Folder.php.

References TYPO3\CMS\Core\Resource\Folder\getStorage().

Referenced by TYPO3\CMS\Impexp\Controller\ExportController\saveExportToFile().

◆ getReadablePath()

string TYPO3\CMS\Core\Resource\Folder::getReadablePath ( $rootId = null )

Returns the full path of this folder, from the root.

Parameters

string $rootId ‪ID of the root folder, NULL to auto-detect

Returns: ‪string

Definition at line 101 of file Folder.php.

References TYPO3\CMS\Core\Resource\Folder\getParentFolder().

Referenced by TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\getPropertiesForTable().

◆ getRole()

string TYPO3\CMS\Core\Resource\Folder::getRole ( )

Returns the role of this folder (if any). See FolderInterface::ROLE_* constants for possible values.

Returns: ‪string

Definition at line 539 of file Folder.php.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\getNearestRecyclerFolder(), TYPO3\CMS\Backend\Tree\FileStorageTreeProvider\prepareFolderInformation(), and TYPO3\CMS\Filelist\FileList\render().

◆ getStorage()

TYPO3\CMS\Core\Resource\Folder::getStorage ( )

Implements TYPO3\CMS\Core\Resource\ResourceInterface.

Definition at line 139 of file Folder.php.

References TYPO3\CMS\Core\Resource\Folder\$storage.

◆ getSubfolder()

TYPO3\CMS\Core\Resource\Folder::getSubfolder ( string $name )

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

Exceptions

Implements TYPO3\CMS\Core\Resource\FolderInterface.

Definition at line 252 of file Folder.php.

References TYPO3\CMS\Core\Resource\Folder\$name.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\getNestedProcessingFolder(), and TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter\provideTargetFolder().

◆ getSubfolders()

TYPO3\CMS\Core\Resource\Folder::getSubfolders	(	$start = `0`,
		$numberOfItems = `0`,
		$filterMode = `self::FILTER_MODE_USE_OWN_AND_STORAGE_FILTERS`,
		$recursive = `false`
	)

Parameters

int	$start	‪The item to start at
int	$numberOfItems	‪The number of items to return
int	$filterMode	‪The filter mode to use for the filelist.
bool	$recursive	‪@phpstan-return array<array-key, Folder>

Reimplemented in TYPO3\CMS\Core\Resource\InaccessibleFolder.

Definition at line 267 of file Folder.php.

References TYPO3\CMS\Core\Resource\Folder\prepareFiltersInStorage(), and TYPO3\CMS\Core\Resource\Folder\restoreBackedUpFiltersInStorage().

Referenced by TYPO3\CMS\Scheduler\Task\RecyclerGarbageCollectionTask\cleanupRecycledFiles(), TYPO3\CMS\Core\Resource\ResourceStorage\getAllFileObjectsInFolder(), TYPO3\CMS\Filelist\Controller\FileDownloadController\getFilesAndFoldersRecursive(), TYPO3\CMS\Core\Resource\ResourceStorage\getNearestRecyclerFolder(), TYPO3\CMS\Backend\Tree\FileStorageTreeProvider\getSubfoldersRecursively(), and TYPO3\CMS\Backend\Tree\FileStorageTreeProvider\prepareFolderInformation().

◆ hasFile()

TYPO3\CMS\Core\Resource\Folder::hasFile ( string $name )

Checks if a file exists in this folder

Implements TYPO3\CMS\Core\Resource\FolderInterface.

Definition at line 412 of file Folder.php.

References TYPO3\CMS\Core\Resource\Folder\$name.

Referenced by TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter\provideFolderInitialization().

◆ hasFolder()

TYPO3\CMS\Core\Resource\Folder::hasFolder ( string $name )

Checks if a folder exists in this folder.

Implements TYPO3\CMS\Core\Resource\FolderInterface.

Definition at line 431 of file Folder.php.

References TYPO3\CMS\Core\Resource\Folder\$name.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\getNestedProcessingFolder(), and TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter\provideTargetFolder().

◆ moveTo()

Folder TYPO3\CMS\Core\Resource\Folder::moveTo	(	Folder	$targetFolder,
			$targetFolderName = `null`,
			$conflictMode = `DuplicationBehavior::RENAME`
	)

Moves folder to a target folder

Parameters

Folder	$targetFolder	‪Target folder to move to.
string	$targetFolderName	‪an optional destination fileName
string \| DuplicationBehavior	$conflictMode

Returns: ‪Folder New (copied) folder object.

Todo:: ‪change $conflictMode parameter type to DuplicationBehavior in TYPO3 v14.0

Reimplemented in TYPO3\CMS\Core\Resource\InaccessibleFolder.

Definition at line 395 of file Folder.php.

References TYPO3\CMS\Core\Resource\Enum\getDefaultDuplicationBehaviour, and TYPO3\CMS\Core\Resource\Folder\getStorage().

◆ prepareFiltersInStorage()

array TYPO3\CMS\Core\Resource\Folder::prepareFiltersInStorage ( $filterMode )

protected

Prepares the filters in this folder's storage according to a set filter mode.

Parameters

int $filterMode ‪The filter mode to use; one of the FILTER_MODE_* constants

Returns: ‪array The backed up filters as an array (NULL if filters were not backed up) and whether to use filters or not (bool)

Definition at line 476 of file Folder.php.

References TYPO3\CMS\Core\Resource\Folder\FILTER_MODE_NO_FILTERS, TYPO3\CMS\Core\Resource\Folder\FILTER_MODE_USE_OWN_AND_STORAGE_FILTERS, TYPO3\CMS\Core\Resource\Folder\FILTER_MODE_USE_OWN_FILTERS, and TYPO3\CMS\Core\Resource\Folder\FILTER_MODE_USE_STORAGE_FILTERS.

Referenced by TYPO3\CMS\Core\Resource\Folder\getFiles(), TYPO3\CMS\Core\Resource\Folder\getSubfolders(), and TYPO3\CMS\Core\Resource\Folder\searchFiles().

◆ rename()

TYPO3\CMS\Core\Resource\Folder::rename ( string $newName )

Renames this folder.

Implements TYPO3\CMS\Core\Resource\FolderInterface.

Definition at line 326 of file Folder.php.

◆ restoreBackedUpFiltersInStorage()

TYPO3\CMS\Core\Resource\Folder::restoreBackedUpFiltersInStorage ( $backedUpFilters )

protected

Restores the filters of a storage.

Parameters

array $backedUpFilters ‪The filters to restore; might be NULL if no filters have been backed up, in which case this method does nothing.

See also: ‪prepareFiltersInStorage()

Definition at line 518 of file Folder.php.

Referenced by TYPO3\CMS\Core\Resource\Folder\getFiles(), TYPO3\CMS\Core\Resource\Folder\getSubfolders(), and TYPO3\CMS\Core\Resource\Folder\searchFiles().

◆ searchFiles()

TYPO3\CMS\Core\Resource\Folder::searchFiles	(	FileSearchDemand	$searchDemand,
		int	$filterMode = `self::FILTER_MODE_USE_OWN_AND_STORAGE_FILTERS`
	)

Returns a file search result based on the given demand. The result also includes matches in meta data fields that are defined in TCA.

Parameters

int $filterMode ‪The filter mode to use for the found files

Definition at line 225 of file Folder.php.

References TYPO3\CMS\Core\Resource\Folder\prepareFiltersInStorage(), and TYPO3\CMS\Core\Resource\Folder\restoreBackedUpFiltersInStorage().

◆ setFileAndFolderNameFilters()

TYPO3\CMS\Core\Resource\Folder::setFileAndFolderNameFilters ( array $filters )

Sets the filters to use when listing files. These are only used if the filter mode is one of FILTER_MODE_USE_OWN_FILTERS and FILTER_MODE_USE_OWN_AND_STORAGE_FILTERS

Reimplemented in TYPO3\CMS\Core\Resource\InaccessibleFolder.

Definition at line 529 of file Folder.php.

◆ setName()

TYPO3\CMS\Core\Resource\Folder::setName ( $name )

Sets a new name of the folder currently this does not trigger the "renaming process" as the name is more seen as a label

Parameters

string $name ‪The new name

Reimplemented in TYPO3\CMS\Core\Resource\InaccessibleFolder.

Definition at line 134 of file Folder.php.

References TYPO3\CMS\Core\Resource\Folder\$name.

◆ updateProperties()

TYPO3\CMS\Core\Resource\Folder::updateProperties ( array $properties )

Updates the properties of this folder, e.g. after re-indexing or moving it.

NOTE: This method should not be called from outside the File Abstraction Layer (FAL)!

Parameters

array $properties

Reimplemented in TYPO3\CMS\Core\Resource\InaccessibleFolder.

Definition at line 459 of file Folder.php.

Member Data Documentation

◆ $fileAndFolderNameFilters

callable [] TYPO3\CMS\Core\Resource\Folder::$fileAndFolderNameFilters = array( )

protected

The filters this folder should use for a filelist.

Definition at line 63 of file Folder.php.

◆ $identifier

string TYPO3\CMS\Core\Resource\Folder::$identifier

protected

The identifier of this folder to identify it on the storage. On some drivers, this is the path to the folder, but drivers could also just provide any other unique identifier for this folder on the specific storage.

Definition at line 51 of file Folder.php.

Referenced by TYPO3\CMS\Core\Resource\Folder\__construct(), and TYPO3\CMS\Core\Resource\Folder\getIdentifier().

◆ $name

string TYPO3\CMS\Core\Resource\Folder::$name

protected

The name of this folder

Definition at line 57 of file Folder.php.

Referenced by TYPO3\CMS\Core\Resource\Folder\__construct(), TYPO3\CMS\Core\Resource\Folder\getName(), TYPO3\CMS\Core\Resource\Folder\getSubfolder(), TYPO3\CMS\Core\Resource\Folder\hasFile(), TYPO3\CMS\Core\Resource\Folder\hasFolder(), and TYPO3\CMS\Core\Resource\Folder\setName().

◆ $storage

ResourceStorage TYPO3\CMS\Core\Resource\Folder::$storage

protected

The storage this folder belongs to.

Definition at line 43 of file Folder.php.

Referenced by TYPO3\CMS\Core\Resource\Folder\__construct(), and TYPO3\CMS\Core\Resource\Folder\getStorage().

◆ FILTER_MODE_NO_FILTERS

const TYPO3\CMS\Core\Resource\Folder::FILTER_MODE_NO_FILTERS = 0

Modes for filter usage in getFiles()/getFolders()

Definition at line 68 of file Folder.php.

Referenced by TYPO3\CMS\Core\Resource\Search\QueryRestrictions\FolderRestriction\createFolderRestriction(), and TYPO3\CMS\Core\Resource\Folder\prepareFiltersInStorage().

◆ FILTER_MODE_USE_OWN_AND_STORAGE_FILTERS

const TYPO3\CMS\Core\Resource\Folder::FILTER_MODE_USE_OWN_AND_STORAGE_FILTERS = 1

Definition at line 70 of file Folder.php.

Referenced by TYPO3\CMS\Frontend\Resource\FileCollector\addFilesFromFolder(), TYPO3\CMS\Core\Utility\File\ExtendedFileUtility\folderHasFilesInUse(), TYPO3\CMS\Core\Tests\Unit\Resource\FolderTest\getFilesHandsOverRecursiveTRUEifSet(), TYPO3\CMS\Core\Resource\Collection\FolderBasedFileCollection\loadContents(), TYPO3\CMS\Core\Resource\Folder\prepareFiltersInStorage(), and TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\retrieveYamlFilesFromStorageFolders().

◆ FILTER_MODE_USE_OWN_FILTERS

const TYPO3\CMS\Core\Resource\Folder::FILTER_MODE_USE_OWN_FILTERS = 3

Definition at line 74 of file Folder.php.

Referenced by TYPO3\CMS\Core\Resource\Folder\prepareFiltersInStorage().

◆ FILTER_MODE_USE_STORAGE_FILTERS

const TYPO3\CMS\Core\Resource\Folder::FILTER_MODE_USE_STORAGE_FILTERS = 2

Definition at line 72 of file Folder.php.

Referenced by TYPO3\CMS\Core\Resource\Folder\prepareFiltersInStorage().

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addFile()

◆ addUploadedFile()

◆ checkActionPermission()

◆ copyTo()

◆ createFile()

◆ createFolder()

◆ delete()

◆ getCombinedIdentifier()

◆ getCreationTime()

◆ getFile()

◆ getFileCount()

◆ getFiles()

◆ getHashedIdentifier()

◆ getIdentifier()

◆ getModificationTime()

◆ getName()

◆ getParentFolder()

◆ getPublicUrl()

◆ getReadablePath()

◆ getRole()

◆ getStorage()

◆ getSubfolder()

◆ getSubfolders()

◆ hasFile()

◆ hasFolder()

◆ moveTo()

◆ prepareFiltersInStorage()

◆ rename()

◆ restoreBackedUpFiltersInStorage()

◆ searchFiles()

◆ setFileAndFolderNameFilters()

◆ setName()

◆ updateProperties()

Member Data Documentation

◆ $fileAndFolderNameFilters

◆ $identifier

◆ $name

◆ $storage

◆ FILTER_MODE_NO_FILTERS

◆ FILTER_MODE_USE_OWN_AND_STORAGE_FILTERS

◆ FILTER_MODE_USE_OWN_FILTERS

◆ FILTER_MODE_USE_STORAGE_FILTERS