‪TYPO3CMS  10.4
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Core\Resource\Folder Class Reference
Inheritance diagram for TYPO3\CMS\Core\Resource\Folder:
TYPO3\CMS\Core\Resource\FolderInterface TYPO3\CMS\Core\Resource\ResourceInterface TYPO3\CMS\Core\Resource\InaccessibleFolder

Public Member Functions

 __construct (ResourceStorage $storage, $identifier, $name)
 
string getName ()
 
string getReadablePath ($rootId=null)
 
 setName ($name)
 
ResourceStorage getStorage ()
 
string getIdentifier ()
 
string getHashedIdentifier ()
 
string getCombinedIdentifier ()
 
string null getPublicUrl ($relativeToCurrentScript=false)
 
TYPO3 CMS Core Resource File[] getFiles ($start=0, $numberOfItems=0, $filterMode=self::FILTER_MODE_USE_OWN_AND_STORAGE_FILTERS, $recursive=false, $sort='', $sortRev=false)
 
FileSearchResultInterface searchFiles (FileSearchDemand $searchDemand, int $filterMode=self::FILTER_MODE_USE_OWN_AND_STORAGE_FILTERS)
 
int getFileCount (array $filterMethods=[], $recursive=false)
 
Folder getSubfolder ($name)
 
Folder[] 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)
 
Folder rename ($newName)
 
bool 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)
 
bool hasFile ($name)
 
bool hasFolder ($name)
 
bool checkActionPermission ($action)
 
 updateProperties (array $properties)
 
 setFileAndFolderNameFilters (array $filters)
 
string getRole ()
 
FolderInterface getParentFolder ()
 
int getModificationTime ()
 
int getCreationTime ()
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Core\Resource\FolderInterface
Folder[] getSubfolders ()
 
bool 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 36 of file Folder.php.

Constructor & Destructor Documentation

◆ __construct()

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

Initialization of the folder

Parameters
ResourceStorage$storage
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$conflictMode‪a value of the \TYPO3\CMS\Core\Resource\DuplicationBehavior enumeration
Returns
‪File The file object

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

Definition at line 307 of file Folder.php.

References TYPO3\CMS\Core\Utility\PathUtility\basename().

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$conflictMode‪a value of the \TYPO3\CMS\Core\Resource\DuplicationBehavior enumeration
Returns
‪File The file object

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

Definition at line 320 of file Folder.php.

◆ 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 423 of file Folder.php.

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

Referenced by TYPO3\CMS\Recordlist\View\FolderUtilityRenderer\createFolder(), TYPO3\CMS\Impexp\Controller\ExportController\exportData(), TYPO3\CMS\Filelist\FileList\formatDirList(), TYPO3\CMS\Filelist\FileList\makeClip(), TYPO3\CMS\Recordlist\Browser\FileBrowser\renderFilesInFolder(), TYPO3\CMS\Recordlist\Browser\FolderBrowser\renderFolders(), and TYPO3\CMS\Recordlist\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$conflictMode‪a value of the \TYPO3\CMS\Core\Resource\DuplicationBehavior enumeration
Returns
‪Folder New (copied) folder object.

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

Definition at line 377 of file Folder.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\copyFolder(), 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 353 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 364 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(), TYPO3\CMS\Core\Resource\ResourceStorage\getProcessingFolder(), and TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter\provideTargetFolder().

◆ delete()

bool 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
Returns
‪bool TRUE if deletion succeeded

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

Definition at line 342 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 181 of file Folder.php.

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

Referenced by TYPO3\CMS\Recordlist\View\FolderUtilityRenderer\createFolder(), TYPO3\CMS\Filelist\FileList\formatDirList(), TYPO3\CMS\Core\Resource\ResourceStorage\isProcessingFolder(), TYPO3\CMS\Filelist\FileList\linkWrapDir(), TYPO3\CMS\Recordlist\Browser\FolderBrowser\renderFolders(), and TYPO3\CMS\Recordlist\View\FolderUtilityRenderer\uploadForm().

◆ getCreationTime()

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

Returns the creation time of the file as Unix timestamp

Returns
‪int

Implements TYPO3\CMS\Core\Resource\FolderInterface.

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

Definition at line 556 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
array$filterMethods
bool$recursive
Returns
‪int
Exceptions
Exception

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

Definition at line 261 of file Folder.php.

Referenced by TYPO3\CMS\Filelist\FileList\formatDirList(), 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 218 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(), TYPO3\CMS\Recordlist\Browser\FileBrowser\getFilesInFolder(), and TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler\getFolderContent().

◆ getHashedIdentifier()

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

Get hashed identifier

Returns
‪string

Implements TYPO3\CMS\Core\Resource\ResourceInterface.

Definition at line 170 of file Folder.php.

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

◆ getIdentifier()

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
‪string

Implements TYPO3\CMS\Core\Resource\ResourceInterface.

Definition at line 160 of file Folder.php.

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

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\addFile(), TYPO3\CMS\Core\Resource\ResourceStorage\addFileMount(), TYPO3\CMS\Core\Resource\ResourceStorage\assureFileCopyPermissions(), TYPO3\CMS\Core\Resource\ResourceStorage\assureFileMovePermissions(), TYPO3\CMS\Core\Resource\ResourceStorage\copyFolder(), TYPO3\CMS\Core\Resource\ResourceStorage\countFilesInFolder(), TYPO3\CMS\Core\Resource\ResourceStorage\countFoldersInFolder(), TYPO3\CMS\Core\Resource\ResourceStorage\createFile(), TYPO3\CMS\Recordlist\View\FolderUtilityRenderer\createFolder(), TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler\expandFolder(), TYPO3\CMS\Core\Resource\Folder\getCombinedIdentifier(), TYPO3\CMS\Core\Resource\ResourceStorage\getFileInFolder(), TYPO3\CMS\Core\Resource\ResourceStorage\getFilesInFolder(), TYPO3\CMS\Core\Resource\ResourceStorage\getFolderInfo(), TYPO3\CMS\Core\Resource\ResourceStorage\getFolderInFolder(), TYPO3\CMS\Core\Resource\ResourceStorage\getFoldersInFolder(), TYPO3\CMS\Core\Imaging\IconFactory\getIconForResource(), TYPO3\CMS\Core\Resource\Folder\getParentFolder(), TYPO3\CMS\Install\Service\Typo3tempFileService\getStatsFromStorage(), TYPO3\CMS\Backend\Tree\View\FolderTreeView\getTableNameForClickMenu(), TYPO3\CMS\Core\Resource\ResourceStorage\hasFileInFolder(), TYPO3\CMS\Core\Resource\ResourceStorage\hasFolderInFolder(), TYPO3\CMS\Core\Resource\ResourceStorage\isWithinFolder(), TYPO3\CMS\Core\Resource\ResourceStorage\isWithinProcessingFolder(), TYPO3\CMS\Core\Resource\ResourceStorage\moveFolder(), TYPO3\CMS\Core\Resource\ResourceStorage\updateProcessedFile(), and TYPO3\CMS\Recordlist\View\FolderUtilityRenderer\uploadForm().

◆ getModificationTime()

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

Returns the modification time of the file as Unix timestamp

Returns
‪int

Implements TYPO3\CMS\Core\Resource\FolderInterface.

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

Definition at line 546 of file Folder.php.

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

◆ getName()

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

Returns the name of this folder.

Returns
‪string

Implements TYPO3\CMS\Core\Resource\ResourceInterface.

Definition at line 94 of file Folder.php.

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

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\assureFolderDeletePermission(), TYPO3\CMS\Core\Resource\ResourceStorage\moveFolder(), TYPO3\CMS\Recordlist\Browser\FolderBrowser\renderFolders(), and TYPO3\CMS\Core\Resource\InaccessibleFolder\throwInaccessibleException().

◆ getParentFolder()

FolderInterface 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.

Returns
‪FolderInterface

Implements TYPO3\CMS\Core\Resource\ResourceInterface.

Definition at line 536 of file Folder.php.

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

Referenced by TYPO3\CMS\Core\Resource\Folder\getReadablePath(), and TYPO3\CMS\Core\Resource\ResourceStorage\moveFolder().

◆ getPublicUrl()

string null TYPO3\CMS\Core\Resource\Folder::getPublicUrl (   $relativeToCurrentScript = false)

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.

Parameters
bool$relativeToCurrentScript‪Determines whether the URL returned should be relative to the current script, in case it is relative at all (only for the LocalDriver)
Returns
‪string|null NULL if file is missing or deleted, the generated url otherwise

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

Definition at line 195 of file Folder.php.

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

◆ 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 106 of file Folder.php.

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

Referenced by TYPO3\CMS\Recordlist\Browser\FileBrowser\renderFilesInFolder().

◆ 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 522 of file Folder.php.

Referenced by TYPO3\CMS\Filelist\FileList\formatDirList(), and TYPO3\CMS\Backend\Tree\View\FolderTreeView\getTableNameForClickMenu().

◆ getStorage()

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

Returns the storage this folder belongs to.

Returns
‪ResourceStorage

Implements TYPO3\CMS\Core\Resource\ResourceInterface.

Definition at line 149 of file Folder.php.

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

Referenced by TYPO3\CMS\Core\Resource\ProcessedFile\__construct(), TYPO3\CMS\Core\Resource\ResourceStorage\assureFileCopyPermissions(), TYPO3\CMS\Core\Resource\ResourceStorage\assureFileMovePermissions(), TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\canBePastedInto(), TYPO3\CMS\Core\Resource\Folder\checkActionPermission(), TYPO3\CMS\Core\Resource\Folder\copyTo(), TYPO3\CMS\Core\Resource\AbstractFile\copyTo(), TYPO3\CMS\Core\Resource\Index\FileIndexRepository\findByFolder(), TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\AbstractOnlineMediaHelper\findExistingFileByOnlineMediaId(), TYPO3\CMS\Core\Resource\Folder\getCombinedIdentifier(), TYPO3\CMS\Core\Resource\ResourceStorage\getNestedProcessingFolder(), TYPO3\CMS\Core\Resource\Folder\getParentFolder(), TYPO3\CMS\Core\Resource\ResourceStorage\getProcessingFolder(), TYPO3\CMS\Core\Resource\Folder\getPublicUrl(), TYPO3\CMS\Backend\Tree\View\FolderTreeView\getTableNameForClickMenu(), TYPO3\CMS\Form\Domain\Finishers\DeleteUploadsFinisher\isEmptyFolder(), TYPO3\CMS\Core\Resource\ResourceStorage\isWithinFolder(), TYPO3\CMS\Core\Resource\ResourceStorage\isWithinProcessingFolder(), TYPO3\CMS\Filelist\FileList\makeClip(), TYPO3\CMS\Core\Resource\ResourceStorage\moveFolder(), TYPO3\CMS\Core\Resource\Folder\moveTo(), TYPO3\CMS\Core\Resource\AbstractFile\moveTo(), TYPO3\CMS\Filelist\Controller\FileListController\registerButtons(), TYPO3\CMS\Filelist\FileList\renderClipboardHeaderRow(), TYPO3\CMS\Recordlist\Browser\FileBrowser\renderFilesInFolder(), and TYPO3\CMS\Backend\Form\Container\InlineControlContainer\renderPossibleRecordsSelectorTypeGroupDB().

◆ getSubfolder()

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

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

Parameters
string$name‪Name of the subfolder
Returns
‪Folder
Exceptions

Implements TYPO3\CMS\Core\Resource\FolderInterface.

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

Definition at line 273 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()

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

Returns a list of subfolders

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
Returns
‪Folder[]

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

Definition at line 290 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\Recordlist\LinkHandler\FolderLinkHandler\getFolderContent(), TYPO3\CMS\Backend\Tree\View\FolderTreeView\getFolderTree(), TYPO3\CMS\Backend\Tree\View\FolderTreeView\getNumberOfSubfolders(), TYPO3\CMS\Core\Resource\Service\UserFileMountService\getSubfoldersForOptionList(), and TYPO3\CMS\Recordlist\Browser\FolderBrowser\renderFolders().

◆ hasFile()

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

Checks if a file exists in this folder

Parameters
string$name
Returns
‪bool

Implements TYPO3\CMS\Core\Resource\FolderInterface.

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

Definition at line 401 of file Folder.php.

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

Referenced by TYPO3\CMS\Backend\Resource\Processing\DeferredBackendImageProcessor\canProcessTask(), and TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter\provideFolderInitialization().

◆ hasFolder()

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

Checks if a folder exists in this folder.

Parameters
string$name
Returns
‪bool

Implements TYPO3\CMS\Core\Resource\FolderInterface.

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

Definition at line 412 of file Folder.php.

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

Referenced by TYPO3\CMS\Impexp\Controller\ImportExportController\getDefaultImportExportFolder(), 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$conflictMode‪a value of the \TYPO3\CMS\Core\Resource\DuplicationBehavior enumeration
Returns
‪Folder New (copied) folder object.

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

Definition at line 390 of file Folder.php.

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

◆ 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 457 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()

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

Renames this folder.

Parameters
string$newName
Returns
‪Folder

Implements TYPO3\CMS\Core\Resource\FolderInterface.

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

Definition at line 331 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 499 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()

FileSearchResultInterface 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
FileSearchDemand$searchDemand
int$filterMode‪The filter mode to use for the found files
Returns
‪FileSearchResultInterface

Definition at line 243 of file Folder.php.

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

Referenced by TYPO3\CMS\Recordlist\Browser\FileBrowser\renderFilesInFolder(), and TYPO3\CMS\Core\Resource\FileRepository\searchByName().

◆ 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

Parameters
array$filters

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

Definition at line 512 of file Folder.php.

Referenced by TYPO3\CMS\Recordlist\Browser\FileBrowser\getFilesInFolder(), and TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler\getFolderContent().

◆ 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 139 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 440 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 62 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 50 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 56 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 42 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 67 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 69 of file Folder.php.

Referenced by TYPO3\CMS\Frontend\Resource\FileCollector\addFilesFromFolder(), TYPO3\CMS\Core\Utility\File\ExtendedFileUtility\folderHasFilesInUse(), TYPO3\CMS\Core\Tests\Unit\Utility\File\ExtendedFileUtilityTest\folderHasFilesInUseReturnsFalseIfItHasNoFiles(), TYPO3\CMS\Core\Tests\Unit\Utility\File\ExtendedFileUtilityTest\folderHasFilesInUseReturnsTrueIfItHasFiles(), TYPO3\CMS\Core\Tests\Unit\Resource\FolderTest\getFilesHandsOverRecursiveTRUEifSet(), TYPO3\CMS\Filelist\FileList\getTable(), 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 73 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 71 of file Folder.php.

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