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 31 of file core/Classes/Resource/Folder.php.
Definition at line 81 of file core/Classes/Resource/Folder.php.
References Folder\$identifier, Folder\$name, and Folder\$storage.
Definition at line 290 of file core/Classes/Resource/Folder.php.
Adds an uploaded file into the Storage.
Definition at line 303 of file core/Classes/Resource/Folder.php.
Definition at line 406 of file core/Classes/Resource/Folder.php.
Referenced by FolderUtilityRenderer\createFolder(), FileLinkHandler\expandFolder(), FileList\getButtonsAndOtherMarkers(), FileList\makeClip(), FileBrowser\renderFilesInFolder(), AddImageHandler\renderFilesInFolder(), FolderBrowser\renderFolders(), InlineControlContainer\renderPossibleRecordsSelectorTypeGroupDB(), and FolderUtilityRenderer\uploadForm().
Folder $targetFolder Target folder to copy to.
Folder New (copied) folder object.
Definition at line 360 of file core/Classes/Resource/Folder.php.
Definition at line 336 of file core/Classes/Resource/Folder.php.
Definition at line 347 of file core/Classes/Resource/Folder.php.
Deletes this folder from its storage. This also means that this object becomes useless.
Definition at line 325 of file core/Classes/Resource/Folder.php.
Returns a combined identifier of this folder, i.e. the storage UID and the folder identifier separated by a colon ":".
Definition at line 181 of file core/Classes/Resource/Folder.php.
Referenced by FolderUtilityRenderer\createFolder(), FileLinkHandler\expandFolder(), FileList\getButtonsAndOtherMarkers(), ResourceStorage\isProcessingFolder(), FileList\linkWrapDir(), FolderBrowser\renderFolders(), and FolderUtilityRenderer\uploadForm().
Definition at line 244 of file core/Classes/Resource/Folder.php.
Returns a list of files in this folder, optionally filtered. There are several filter modes available, see the FILTER_MODE_* constants for more information.
int $filterMode The filter mode to use for the filelist.
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".
Definition at line 218 of file core/Classes/Resource/Folder.php.
Definition at line 170 of file core/Classes/Resource/Folder.php.
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.
Definition at line 160 of file core/Classes/Resource/Folder.php.
Referenced by ResourceStorage\addFile(), ResourceStorage\assureFileCopyPermissions(), ResourceStorage\assureFileMovePermissions(), ResourceStorage\countFilesInFolder(), ResourceStorage\countFoldersInFolder(), ResourceStorage\createFile(), FolderUtilityRenderer\createFolder(), FileLinkHandler\expandFolder(), ElementBrowserFolderTreeView\ext_isLinkable(), Folder\getCombinedIdentifier(), ResourceStorage\getFileInFolder(), ResourceStorage\getFilesInFolder(), ResourceStorage\getFolderInFolder(), ResourceStorage\getFoldersInFolder(), FileList\getLinkToParentFolder(), Folder\getParentFolder(), ResourceStorage\getUniqueName(), ResourceStorage\hasFileInFolder(), ResourceStorage\hasFolderInFolder(), ResourceStorage\isWithinFolder(), ResourceStorage\moveFolder(), FileBrowser\renderFilesInFolder(), AddImageHandler\renderFilesInFolder(), and FolderUtilityRenderer\uploadForm().
Returns the name of this folder.
Definition at line 93 of file core/Classes/Resource/Folder.php.
Referenced by ResourceStorage\assureFolderDeletePermission(), ResourceStorage\moveFolder(), and FolderBrowser\renderFolders().
In non-hierarchical storages, that always is the root folder.
The parent folder of the root folder is the root folder.
Definition at line 520 of file core/Classes/Resource/Folder.php.
Referenced by FileList\getLinkToParentFolder(), Folder\getReadablePath(), and ResourceStorage\moveFolder().
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.
Definition at line 195 of file core/Classes/Resource/Folder.php.
Returns the full path of this folder, from the root.
Definition at line 105 of file core/Classes/Resource/Folder.php.
Referenced by FileList\getButtonsAndOtherMarkers(), and FileList\start().
Returns the role of this folder (if any). See FolderInterface::ROLE_* constants for possible values.
Definition at line 506 of file core/Classes/Resource/Folder.php.
Returns the storage this folder belongs to.
Definition at line 149 of file core/Classes/Resource/Folder.php.
Referenced by ResourceStorage\assureFileCopyPermissions(), ResourceStorage\assureFileMovePermissions(), Folder\checkActionPermission(), Folder\copyTo(), AbstractFile\copyTo(), AbstractOnlineMediaHelper\findExistingFileByOnlineMediaId(), FileList\getButtonsAndOtherMarkers(), Folder\getCombinedIdentifier(), FileList\getLinkToParentFolder(), Folder\getParentFolder(), Folder\getPublicUrl(), ResourceStorage\isWithinFolder(), FileList\makeClip(), ResourceStorage\moveFolder(), Folder\moveTo(), and AbstractFile\moveTo().
Returns the object for a subfolder of the current folder, if it exists.
Definition at line 256 of file core/Classes/Resource/Folder.php.
Definition at line 273 of file core/Classes/Resource/Folder.php.
Referenced by FolderLinkHandler\getFolderContent(), FolderTreeView\getNumberOfSubfolders(), and FolderBrowser\renderFolders().
Definition at line 384 of file core/Classes/Resource/Folder.php.
Checks if a folder exists in this folder.
Definition at line 395 of file core/Classes/Resource/Folder.php.
Folder $targetFolder Target folder to move to.
Definition at line 373 of file core/Classes/Resource/Folder.php.
Prepares the filters in this folder's storage according to a set filter mode.
Definition at line 441 of file core/Classes/Resource/Folder.php.
Referenced by Folder\getFiles(), and Folder\getSubfolders().
Definition at line 314 of file core/Classes/Resource/Folder.php.
Restores the filters of a storage.
array $backedUpFilters The filters to restore; might be NULL if no filters have been backed up, in which case this method does nothing.
Definition at line 483 of file core/Classes/Resource/Folder.php.
Definition at line 496 of file core/Classes/Resource/Folder.php.
Definition at line 139 of file core/Classes/Resource/Folder.php.
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)!
Definition at line 424 of file core/Classes/Resource/Folder.php.
Definition at line 61 of file core/Classes/Resource/Folder.php.
Definition at line 47 of file core/Classes/Resource/Folder.php.
Referenced by Folder\__construct(), and Folder\getIdentifier().
Definition at line 54 of file core/Classes/Resource/Folder.php.
Referenced by Folder\__construct(), Folder\getName(), Folder\getSubfolder(), Folder\hasFile(), Folder\hasFolder(), and Folder\setName().
Definition at line 38 of file core/Classes/Resource/Folder.php.
Referenced by Folder\__construct(), and Folder\getStorage().
Definition at line 66 of file core/Classes/Resource/Folder.php.
Definition at line 68 of file core/Classes/Resource/Folder.php.
Referenced by FileCollector\addFilesFromFolder(), FolderTest\getFilesHandsOverRecursiveTRUEifSet(), and FolderBasedFileCollection\loadContents().
Definition at line 72 of file core/Classes/Resource/Folder.php.
Definition at line 70 of file core/Classes/Resource/Folder.php.