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

Public Member Functions
	__construct (DriverInterface $driver, array $storageRecord, EventDispatcherInterface $eventDispatcher=null)

array	getConfiguration ()

	setConfiguration (array $configuration)

array	getStorageRecord ()

ResourceStorage	setDriver (DriverInterface $driver)

string	getName ()

int	getUid ()

bool	hasChildren ()

int	getCapabilities ()

bool	isPublic ()

bool	isWritable ()

bool	isBrowsable ()

bool	hasHierarchicalIdentifiers ()

FileSearchResultInterface	searchFiles (FileSearchDemand $searchDemand, Folder $folder=null, bool $useFilters=true)

bool	usesCaseSensitiveIdentifiers ()

bool	isOnline ()

bool	autoExtractMetadataEnabled ()

	markAsPermanentlyOffline ()

	markAsTemporaryOffline ()

	addFileMount ($folderIdentifier, $additionalData=[])

array	getFileMounts ()

bool	isWithinFileMountBoundaries ($subject, $checkWriteAccess=false)

	setEvaluatePermissions ($evaluatePermissions)

bool	getEvaluatePermissions ()

	setUserPermissions (array $userPermissions)

bool	checkUserActionPermission ($action, $type)

bool	checkFileActionPermission ($action, FileInterface $file)

bool	checkFolderActionPermission ($action, Folder $folder=null)

bool	checkFileAndFolderNameFilters (ResourceInterface $fileOrFolder)

string	sanitizeFileName ($fileName, Folder $targetFolder=null)

FileInterface	addFile ($localFilePath, Folder $targetFolder, $targetFileName='', $conflictMode=DuplicationBehavior::RENAME, $removeOriginal=true)

FileInterface	updateProcessedFile ($localFilePath, ProcessedFile $processedFile, Folder $processingFolder=null)

string	hashFile (FileInterface $fileObject, $hash)

string	hashFileByIdentifier ($fileIdentifier, $hash)

string	hashFileIdentifier ($file)

string null	getPublicUrl (ResourceInterface $resourceObject, $relativeToCurrentScript=false)

ProcessedFile	processFile (FileInterface $fileObject, $context, array $configuration)

string	getFileForLocalProcessing (FileInterface $fileObject, $writable=true)

FileInterface	getFile ($identifier)

array	getFileInfo (FileInterface $fileObject)

array	getFileInfoByIdentifier ($identifier, array $propertiesToExtract=[])

	unsetFileAndFolderNameFilters ()

	resetFileAndFolderNameFiltersToDefault ()

	addFileAndFolderNameFilter ($filter)

string	getFolderIdentifierFromFileIdentifier ($fileIdentifier)

File ProcessedFile null	getFileInFolder ($fileName, Folder $folder)

File[]	getFilesInFolder (Folder $folder, $start=0, $maxNumberOfItems=0, $useFilters=true, $recursive=false, $sort='', $sortRev=false)

array	getFileIdentifiersInFolder ($folderIdentifier, $useFilters=true, $recursive=false)

int	countFilesInFolder (Folder $folder, $useFilters=true, $recursive=false)

array	getFolderIdentifiersInFolder ($folderIdentifier, $useFilters=true, $recursive=false)

bool	hasFile ($identifier)

Folder[]	getProcessingFolders ()

bool	isProcessingFolder (Folder $folder)

bool	hasFileInFolder ($fileName, Folder $folder)

string	getFileContents ($file)

ResponseInterface	streamFile (FileInterface $file, bool $asDownload=false, string $alternativeFilename=null, string $overrideMimeType=null)

int	setFileContents (AbstractFile $file, $contents)

FileInterface	createFile ($fileName, Folder $targetFolderObject)

bool	deleteFile ($fileObject)

FileInterface	copyFile (FileInterface $file, Folder $targetFolder, $targetFileName=null, $conflictMode=DuplicationBehavior::RENAME)

FileInterface	moveFile ($file, $targetFolder, $targetFileName=null, $conflictMode=DuplicationBehavior::RENAME)

FileInterface	renameFile ($file, $targetFileName, $conflictMode=DuplicationBehavior::RENAME)

FileInterface	replaceFile (FileInterface $file, $localFilePath)

FileInterface	addUploadedFile (array $uploadedFileData, Folder $targetFolder=null, $targetFileName=null, $conflictMode=DuplicationBehavior::CANCEL)

Folder	moveFolder (Folder $folderToMove, Folder $targetParentFolder, $newFolderName=null, $conflictMode=DuplicationBehavior::RENAME)

Folder	copyFolder (FolderInterface $folderToCopy, FolderInterface $targetParentFolder, $newFolderName=null, $conflictMode=DuplicationBehavior::RENAME)

Folder	renameFolder ($folderObject, $newName)

bool	deleteFolder ($folderObject, $deleteRecursively=false)

Folder InaccessibleFolder	getFolderInFolder ($folderName, Folder $parentFolder, $returnInaccessibleFolderObject=false)

Folder[]	getFoldersInFolder (Folder $folder, $start=0, $maxNumberOfItems=0, $useFilters=true, $recursive=false, $sort='', $sortRev=false)

int	countFoldersInFolder (Folder $folder, $useFilters=true, $recursive=false)

bool	hasFolder ($identifier)

bool	hasFolderInFolder ($folderName, Folder $folder)

Folder	createFolder ($folderName, Folder $parentFolder=null)

array	getFolderInfo (Folder $folder)

Folder	getDefaultFolder ()

Folder InaccessibleFolder	getFolder ($identifier, $returnInaccessibleFolderObject=false)

bool	isWithinProcessingFolder ($identifier)

bool	isWithinFolder (Folder $folder, ResourceInterface $resource)

Folder	getRootLevelFolder ($respectFileMounts=true)

string	getRole (FolderInterface $folder)

Folder	getProcessingFolder (File $file=null)

string	getDriverType ()

	setDefault ($isDefault)

bool	isDefault ()

ResourceFactory	getResourceFactoryInstance ()

Public Attributes
const	PROCESSING_FOLDER_LEVELS = 2

array< int, function getImportExportFilter():array { $filter=GeneralUtility::makeInstance(ImportExportFilter::class);return[ $filter, 'filterImportExportFilesAndFolders'];} public array function getFileAndFolderNameFilters() { return array_merge( $this->fileAndFolderNameFilters,[ $this->getImportExportFilter()]);} public $this function setFileAndFolderNameFilters(array $filters) { $this->	fileAndFolderNameFilters = $filters

return	$this

‪Public Attributes inherited from ‪TYPO3\CMS\Core\Resource\ResourceStorageInterface
const	SIGNAL_SanitizeFileName = 'sanitizeFileName'

const	SIGNAL_PreFileAdd = 'preFileAdd'

const	SIGNAL_PostFileAdd = 'postFileAdd'

const	SIGNAL_PreFileCreate = 'preFileCreate'

const	SIGNAL_PostFileCreate = 'postFileCreate'

const	SIGNAL_PreFileCopy = 'preFileCopy'

const	SIGNAL_PostFileCopy = 'postFileCopy'

const	SIGNAL_PreFileMove = 'preFileMove'

const	SIGNAL_PostFileMove = 'postFileMove'

const	SIGNAL_PreFileDelete = 'preFileDelete'

const	SIGNAL_PostFileDelete = 'postFileDelete'

const	SIGNAL_PreFileRename = 'preFileRename'

const	SIGNAL_PostFileRename = 'postFileRename'

const	SIGNAL_PreFileReplace = 'preFileReplace'

const	SIGNAL_PostFileReplace = 'postFileReplace'

const	SIGNAL_PreFileSetContents = 'preFileSetContents'

const	SIGNAL_PostFileSetContents = 'postFileSetContents'

const	SIGNAL_PreFolderAdd = 'preFolderAdd'

const	SIGNAL_PostFolderAdd = 'postFolderAdd'

const	SIGNAL_PreFolderCopy = 'preFolderCopy'

const	SIGNAL_PostFolderCopy = 'postFolderCopy'

const	SIGNAL_PreFolderMove = 'preFolderMove'

const	SIGNAL_PostFolderMove = 'postFolderMove'

const	SIGNAL_PreFolderDelete = 'preFolderDelete'

const	SIGNAL_PostFolderDelete = 'postFolderDelete'

const	SIGNAL_PreFolderRename = 'preFolderRename'

const	SIGNAL_PostFolderRename = 'postFolderRename'

const	SIGNAL_PreGeneratePublicUrl = 'preGeneratePublicUrl'

const	CAPABILITY_BROWSABLE = 1

const	CAPABILITY_PUBLIC = 2

const	CAPABILITY_WRITABLE = 4

const	CAPABILITY_HIERARCHICAL_IDENTIFIERS = 8

const	DEFAULT_ProcessingFolder = '_processed_'

Protected Member Functions
Driver DriverInterface	getDriver ()

bool	hasCapability ($capability)

bool	checkFileExtensionPermission ($fileName)

	assureFolderReadPermission (Folder $folder=null)

	assureFolderDeletePermission (Folder $folder, $checkDeleteRecursively)

	assureFileReadPermission (FileInterface $file)

	assureFileWritePermissions (FileInterface $file)

	assureFileReplacePermissions (FileInterface $file)

	assureFileDeletePermissions (FileInterface $file)

	assureFileAddPermissions ($targetFolder, $targetFileName)

	assureFileUploadPermissions ($localFilePath, $targetFolder, $targetFileName, $uploadedFileSize)

	assureFileMovePermissions (FileInterface $file, Folder $targetFolder, $targetFileName)

	assureFileRenamePermissions (FileInterface $file, $targetFileName)

	assureFileCopyPermissions (FileInterface $file, Folder $targetFolder, $targetFileName)

	assureFolderCopyPermissions (FolderInterface $folderToCopy, FolderInterface $targetParentFolder)

	assureFolderMovePermissions (FolderInterface $folderToMove, FolderInterface $targetParentFolder)

ResponseInterface	getPseudoStream (FileInterface $file, bool $asDownload=false, string $alternativeFilename=null, string $overrideMimeType=null)

File[]	getAllFileObjectsInFolder (Folder $folder)

	moveFolderBetweenStorages (Folder $folderToMove, Folder $targetParentFolder, $newFolderName)

	copyFolderBetweenStorages (FolderInterface $folderToCopy, FolderInterface $targetParentFolder, $newFolderName)

string	getUniqueName (FolderInterface $folder, $theFile, $dontCheckForUnique=false)

ResourceFactory	getFileFactory ()

Index FileIndexRepository	getFileIndexRepository ()

Service FileProcessingService	getFileProcessingService ()

Folder	getNestedProcessingFolder (File $file, Folder $rootProcessingFolder)

string[]	getNamesForNestedProcessingFolder ($fileIdentifier, $levels)

Index Indexer	getIndexer ()

TYPO3 CMS Core Authentication BackendUserAuthentication	getBackendUser ()

Folder null	getNearestRecyclerFolder (FileInterface $file)

Protected Attributes
Driver DriverInterface	$driver

array	$storageRecord

array	$configuration

Service FileProcessingService	$fileProcessingService

bool	$evaluatePermissions = false

array	$fileMounts = array( )

array	$userPermissions = array( )

int	$capabilities

EventDispatcherInterface	$eventDispatcher

Folder	$processingFolder

Folder[]	$processingFolders

bool	$isOnline

bool	$isDefault = false

array	$fileAndFolderNameFilters = array( )

Detailed Description

A "mount point" inside the TYPO3 file handling.

A "storage" object handles

‪abstraction to the driver
‪permissions (from the driver, and from the user, + capabilities)
‪an entry point for files, folders, and for most other operations

== Driver entry point The driver itself, that does the actual work on the file system, is inside the storage but completely shadowed by the storage, as the storage also handles the abstraction to the driver

The storage can be on the local system, but can also be on a remote system. The combination of driver + configurable capabilities (storage is read-only e.g.) allows for flexible uses.

== Permission system As all requests have to run through the storage, the storage knows about the permissions of a BE/FE user, the file permissions / limitations of the driver and has some configurable capabilities. Additionally, a BE user can use "filemounts" (known from previous installations) to limit his/her work-zone to only a subset (identifier and its subfolders/subfolders) of the user itself.

Check 1: "User Permissions" [is the user allowed to write a file) [is the user allowed to write a file] Check 2: "File Mounts" of the User (act as subsets / filters to the identifiers) [is the user allowed to do something in this folder?] Check 3: "Capabilities" of Storage (then: of Driver) [is the storage/driver writable?] Check 4: "File permissions" of the Driver [is the folder writable?]

Definition at line 121 of file ResourceStorage.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Core\Resource\ResourceStorage::__construct	(	DriverInterface	$driver,
		array	$storageRecord,
		EventDispatcherInterface	$eventDispatcher = `null`
	)

Constructor for a storage object.

Parameters

Driver\DriverInterface	$driver
array	$storageRecord	‪The storage record row from the database
EventDispatcherInterface \| null	$eventDispatcher

Definition at line 216 of file ResourceStorage.php.

Member Function Documentation

◆ addFile()

FileInterface TYPO3\CMS\Core\Resource\ResourceStorage::addFile	(		$localFilePath,
		Folder	$targetFolder,
			$targetFileName = `''`,
			$conflictMode = `DuplicationBehavior::RENAME`,
			$removeOriginal = `true`
	)

Moves a file from the local filesystem to this storage.

Parameters

string	$localFilePath	‪The file on the server's hard disk to add
Folder	$targetFolder	‪The target folder where the file should be added
string	$targetFileName	‪The name of the file to be add, If not set, the local file name is used
string	$conflictMode	‪a value of the DuplicationBehavior enumeration
bool	$removeOriginal	‪if set the original file will be removed after successful operation

Exceptions

Definition at line 1249 of file ResourceStorage.php.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\addUploadedFile().

◆ addFileAndFolderNameFilter()

TYPO3\CMS\Core\Resource\ResourceStorage::addFileAndFolderNameFilter ( $filter )

Parameters

callable $filter

Definition at line 1543 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\fileAndFolderNameFilters.

◆ addFileMount()

TYPO3\CMS\Core\Resource\ResourceStorage::addFileMount	(	$folderIdentifier,
		$additionalData = `[]`
	)

Adds a filemount as a "filter" for users to only work on a subset of a storage object

Parameters

string	$folderIdentifier
array	$additionalData

Exceptions

Exception

Definition at line 536 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\$this, TYPO3\CMS\Core\Resource\ResourceFactory\createFolderObject(), TYPO3\CMS\Core\Resource\Folder\getIdentifier(), and TYPO3\CMS\Core\Resource\ResourceStorage\getResourceFactoryInstance().

Referenced by TYPO3\CMS\Core\Resource\Security\StoragePermissionsAspect\addFileMountsToStorage().

◆ addUploadedFile()

FileInterface TYPO3\CMS\Core\Resource\ResourceStorage::addUploadedFile	(	array	$uploadedFileData,
		Folder	$targetFolder = `null`,
			$targetFileName = `null`,
			$conflictMode = `DuplicationBehavior::CANCEL`
	)

Adds an uploaded file into the Storage. Previously in \TYPO3\CMS\Core\Utility\File\ExtendedFileUtility::file_upload()

Parameters

array	$uploadedFileData	‪contains information about the uploaded file given by $_FILES['file1']
Folder	$targetFolder	‪the target folder
string	$targetFileName	‪the file name to be written
string	$conflictMode	‪a value of the DuplicationBehavior enumeration

Returns: ‪FileInterface The file object

Definition at line 2119 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\addFile(), TYPO3\CMS\Core\Resource\ResourceStorage\assureFileUploadPermissions(), TYPO3\CMS\Core\Type\Enumeration\cast(), TYPO3\CMS\Core\Resource\ResourceStorage\getDefaultFolder(), TYPO3\CMS\Core\Resource\ResourceStorage\getFileInFolder(), TYPO3\CMS\Core\Resource\ResourceStorage\hasFileInFolder(), TYPO3\CMS\Core\Resource\DuplicationBehavior\REPLACE, and TYPO3\CMS\Core\Resource\ResourceStorage\replaceFile().

◆ assureFileAddPermissions()

TYPO3\CMS\Core\Resource\ResourceStorage::assureFileAddPermissions	(	$targetFolder,
		$targetFileName
	)

protected

Checks if a file/user has the permission to be written to a Folder/Storage. If not, throws an exception.

Parameters

Folder	$targetFolder	‪The target folder where the file should be written
string	$targetFileName	‪The file name which should be written into the storage

Exceptions

Exception

Definition at line 998 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\checkFileExtensionPermission(), TYPO3\CMS\Core\Resource\ResourceStorage\checkFolderActionPermission(), TYPO3\CMS\Core\Resource\ResourceStorage\checkUserActionPermission(), and TYPO3\CMS\Core\Resource\ResourceStorage\getUid().

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\addFile(), TYPO3\CMS\Core\Resource\ResourceStorage\assureFileUploadPermissions(), and TYPO3\CMS\Core\Resource\ResourceStorage\createFile().

◆ assureFileCopyPermissions()

TYPO3\CMS\Core\Resource\ResourceStorage::assureFileCopyPermissions	(	FileInterface	$file,
		Folder	$targetFolder,
			$targetFileName
	)

protected

Check if a file has the permission to be copied on a File/Folder/Storage, if not throw an exception

Parameters

FileInterface	$file
Folder	$targetFolder
string	$targetFileName

Exceptions

Exception
Exception

Definition at line 1118 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\checkFileActionPermission(), TYPO3\CMS\Core\Resource\ResourceStorage\checkFileExtensionPermission(), TYPO3\CMS\Core\Resource\ResourceStorage\checkFolderActionPermission(), TYPO3\CMS\Core\Resource\ResourceInterface\getIdentifier(), TYPO3\CMS\Core\Resource\Folder\getIdentifier(), TYPO3\CMS\Core\Resource\ResourceInterface\getName(), TYPO3\CMS\Core\Resource\ResourceInterface\getStorage(), TYPO3\CMS\Core\Resource\Folder\getStorage(), and TYPO3\CMS\Core\Resource\ResourceStorage\getUid().

◆ assureFileDeletePermissions()

TYPO3\CMS\Core\Resource\ResourceStorage::assureFileDeletePermissions ( FileInterface $file )

protected

Assures delete permission for given file.

Parameters

FileInterface $file

Exceptions

Exception

Definition at line 966 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\checkFileActionPermission(), TYPO3\CMS\Core\Resource\ResourceStorage\checkFileExtensionPermission(), TYPO3\CMS\Core\Resource\ResourceStorage\checkUserActionPermission(), TYPO3\CMS\Core\Resource\FileInterface\getExtension(), TYPO3\CMS\Core\Resource\ResourceInterface\getIdentifier(), and TYPO3\CMS\Core\Resource\ResourceInterface\getName().

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\deleteFile().

◆ assureFileMovePermissions()

TYPO3\CMS\Core\Resource\ResourceStorage::assureFileMovePermissions	(	FileInterface	$file,
		Folder	$targetFolder,
			$targetFileName
	)

protected

Checks for permissions to move a file.

Exceptions

Definition at line 1055 of file ResourceStorage.php.

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

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\moveFile().

◆ assureFileReadPermission()

TYPO3\CMS\Core\Resource\ResourceStorage::assureFileReadPermission ( FileInterface $file )

protected

Assures read permission for given file.

Parameters

FileInterface $file

Exceptions

Exception

Definition at line 904 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\checkFileActionPermission(), TYPO3\CMS\Core\Resource\ResourceStorage\checkFileExtensionPermission(), and TYPO3\CMS\Core\Resource\ResourceInterface\getName().

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\getFileContents().

◆ assureFileRenamePermissions()

TYPO3\CMS\Core\Resource\ResourceStorage::assureFileRenamePermissions	(	FileInterface	$file,
			$targetFileName
	)

protected

Checks for permissions to rename a file.

Parameters

FileInterface	$file
string	$targetFileName

Exceptions

Exception

Definition at line 1085 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\checkFileActionPermission(), TYPO3\CMS\Core\Resource\ResourceStorage\checkFileExtensionPermission(), TYPO3\CMS\Core\Resource\ResourceStorage\checkFolderActionPermission(), and TYPO3\CMS\Core\Resource\ResourceInterface\getName().

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\renameFile().

◆ assureFileReplacePermissions()

TYPO3\CMS\Core\Resource\ResourceStorage::assureFileReplacePermissions ( FileInterface $file )

protected

Assure replace permission for given file.

Parameters

FileInterface $file

Exceptions

Exception

Definition at line 946 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\checkFileActionPermission(), TYPO3\CMS\Core\Resource\ResourceStorage\checkFolderActionPermission(), TYPO3\CMS\Core\Resource\ResourceInterface\getIdentifier(), and TYPO3\CMS\Core\Resource\ResourceInterface\getParentFolder().

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\replaceFile().

◆ assureFileUploadPermissions()

TYPO3\CMS\Core\Resource\ResourceStorage::assureFileUploadPermissions	(	$localFilePath,
		$targetFolder,
		$targetFileName,
		$uploadedFileSize
	)

protected

Checks if a file has the permission to be uploaded to a Folder/Storage. If not, throws an exception.

Parameters

string	$localFilePath	‪the temporary file name from $_FILES['file1']['tmp_name']
Folder	$targetFolder	‪The target folder where the file should be uploaded
string	$targetFileName	‪the destination file name $_FILES['file1']['name']
int	$uploadedFileSize

Exceptions

Exception

Definition at line 1029 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\assureFileAddPermissions().

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\addUploadedFile().

◆ assureFileWritePermissions()

TYPO3\CMS\Core\Resource\ResourceStorage::assureFileWritePermissions ( FileInterface $file )

protected

Assures write permission for given file.

Parameters

FileInterface $file

Exceptions

Exception

Definition at line 928 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\checkFileActionPermission(), TYPO3\CMS\Core\Resource\ResourceStorage\checkFileExtensionPermission(), TYPO3\CMS\Core\Resource\FileInterface\getExtension(), TYPO3\CMS\Core\Resource\ResourceInterface\getIdentifier(), and TYPO3\CMS\Core\Resource\ResourceInterface\getName().

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\setFileContents().

◆ assureFolderCopyPermissions()

TYPO3\CMS\Core\Resource\ResourceStorage::assureFolderCopyPermissions	(	FolderInterface	$folderToCopy,
		FolderInterface	$targetParentFolder
	)

protected

Check if a file has the permission to be copied on a File/Folder/Storage, if not throw an exception

Parameters

FolderInterface	$folderToCopy
FolderInterface	$targetParentFolder

Exceptions

Exception
Exception

Definition at line 1152 of file ResourceStorage.php.

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

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\copyFolder().

◆ assureFolderDeletePermission()

TYPO3\CMS\Core\Resource\ResourceStorage::assureFolderDeletePermission	(	Folder	$folder,
			$checkDeleteRecursively
	)

protected

Assures delete permission for given folder.

Parameters

Folder	$folder	‪If a folder is given, mountpoints are checked. If not only user folder delete permissions are checked.
bool	$checkDeleteRecursively

Exceptions

Exception

Definition at line 876 of file ResourceStorage.php.

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

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\deleteFolder().

◆ assureFolderMovePermissions()

TYPO3\CMS\Core\Resource\ResourceStorage::assureFolderMovePermissions	(	FolderInterface	$folderToMove,
		FolderInterface	$targetParentFolder
	)

protected

Check if a file has the permission to be copied on a File/Folder/Storage, if not throw an exception

Parameters

FolderInterface	$folderToMove
FolderInterface	$targetParentFolder

Exceptions

Definition at line 1188 of file ResourceStorage.php.

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

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\moveFolder().

◆ assureFolderReadPermission()

TYPO3\CMS\Core\Resource\ResourceStorage::assureFolderReadPermission ( Folder $folder = null )

protected

Assures read permission for given folder.

Parameters

Folder $folder ‪If a folder is given, mountpoints are checked. If not only user folder read permissions are checked.

Exceptions

Exception

Definition at line 851 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\checkFolderActionPermission().

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\countFilesInFolder(), TYPO3\CMS\Core\Resource\ResourceStorage\countFoldersInFolder(), TYPO3\CMS\Core\Resource\ResourceStorage\getFilesInFolder(), TYPO3\CMS\Core\Resource\ResourceStorage\getFolder(), TYPO3\CMS\Core\Resource\ResourceStorage\hasFile(), TYPO3\CMS\Core\Resource\ResourceStorage\hasFileInFolder(), TYPO3\CMS\Core\Resource\ResourceStorage\hasFolder(), and TYPO3\CMS\Core\Resource\ResourceStorage\hasFolderInFolder().

◆ autoExtractMetadataEnabled()

bool TYPO3\CMS\Core\Resource\ResourceStorage::autoExtractMetadataEnabled ( )

Returns TRUE if auto extracting of metadata is enabled

Returns: ‪bool

Definition at line 482 of file ResourceStorage.php.

◆ checkFileActionPermission()

bool TYPO3\CMS\Core\Resource\ResourceStorage::checkFileActionPermission	(		$action,
		FileInterface	$file
	)

Checks if a file operation (= action) is allowed on a File/Folder/Storage (= subject).

This method, by design, does not throw exceptions or do logging. Besides the usage from other methods in this class, it is also used by the Filelist UI to check whether an action is allowed and whether action related UI elements should thus be shown (move icon, edit icon, etc.)

Parameters

string	$action	‪action, can be read, write, delete, editMeta
FileInterface	$file

Returns: ‪bool

Definition at line 693 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\checkFileExtensionPermission(), TYPO3\CMS\Core\Resource\ResourceStorage\checkUserActionPermission(), TYPO3\CMS\Core\Resource\ResourceInterface\getIdentifier(), TYPO3\CMS\Core\Resource\ResourceInterface\getName(), TYPO3\CMS\Core\Resource\ResourceStorage\isWithinFileMountBoundaries(), and TYPO3\CMS\Core\Resource\ResourceStorage\isWritable().

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\assureFileCopyPermissions(), TYPO3\CMS\Core\Resource\ResourceStorage\assureFileDeletePermissions(), TYPO3\CMS\Core\Resource\ResourceStorage\assureFileMovePermissions(), TYPO3\CMS\Core\Resource\ResourceStorage\assureFileReadPermission(), TYPO3\CMS\Core\Resource\ResourceStorage\assureFileRenamePermissions(), TYPO3\CMS\Core\Resource\ResourceStorage\assureFileReplacePermissions(), TYPO3\CMS\Core\Resource\ResourceStorage\assureFileWritePermissions(), and TYPO3\CMS\Core\Resource\File\checkActionPermission().

◆ checkFileAndFolderNameFilters()

bool TYPO3\CMS\Core\Resource\ResourceStorage::checkFileAndFolderNameFilters ( ResourceInterface $fileOrFolder )

Parameters

ResourceInterface $fileOrFolder

Deprecated:: ‪This method will be removed without substitution, use the ResourceStorage API instead

Returns: ‪bool

Definition at line 809 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\$this, TYPO3\CMS\Core\Resource\ResourceInterface\getIdentifier(), TYPO3\CMS\Core\Resource\ResourceInterface\getName(), and TYPO3\CMS\Core\Resource\ResourceInterface\getParentFolder().

◆ checkFileExtensionPermission()

bool TYPO3\CMS\Core\Resource\ResourceStorage::checkFileExtensionPermission ( $fileName )

protected

If the fileName is given, checks it against the TYPO3_CONF_VARS[BE][fileDenyPattern] + and if the file extension is allowed.

Parameters

string $fileName ‪full filename

Returns: ‪bool TRUE if extension/filename is allowed

Definition at line 839 of file ResourceStorage.php.

◆ checkFolderActionPermission()

bool TYPO3\CMS\Core\Resource\ResourceStorage::checkFolderActionPermission	(		$action,
		Folder	$folder = `null`
	)

Checks if a folder operation (= action) is allowed on a Folder.

This method, by design, does not throw exceptions or do logging. See the checkFileActionPermission() method above for the reasons.

Parameters

string	$action
Folder	$folder

Returns: ‪bool

Definition at line 760 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\checkUserActionPermission(), TYPO3\CMS\Core\Resource\ResourceStorage\isBrowsable(), TYPO3\CMS\Core\Resource\ResourceStorage\isWithinFileMountBoundaries(), and TYPO3\CMS\Core\Resource\ResourceStorage\isWritable().

◆ checkUserActionPermission()

bool TYPO3\CMS\Core\Resource\ResourceStorage::checkUserActionPermission	(	$action,
		$type
	)

Checks if the ACL settings allow for a certain action (is a user allowed to read a file or copy a folder).

Parameters

string	$action
string	$type	‪either File or Folder

Returns: ‪bool

Definition at line 666 of file ResourceStorage.php.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\assureFileAddPermissions(), TYPO3\CMS\Core\Resource\ResourceStorage\assureFileDeletePermissions(), TYPO3\CMS\Core\Resource\ResourceStorage\assureFolderDeletePermission(), TYPO3\CMS\Core\Resource\ResourceStorage\checkFileActionPermission(), TYPO3\CMS\Core\Resource\ResourceStorage\checkFolderActionPermission(), and TYPO3\CMS\Backend\Form\Container\InlineControlContainer\renderPossibleRecordsSelectorTypeGroupDB().

◆ copyFile()

FileInterface TYPO3\CMS\Core\Resource\ResourceStorage::copyFile	(	FileInterface	$file,
		Folder	$targetFolder,
			$targetFileName = `null`,
			$conflictMode = `DuplicationBehavior::RENAME`
	)

Previously in \TYPO3\CMS\Core\Utility\File\ExtendedFileUtility::func_copy() copies a source file (from any location) in to the target folder, the latter has to be part of this storage

Parameters

FileInterface	$file
Folder	$targetFolder
string	$targetFileName	‪an optional destination fileName
string	$conflictMode	‪a value of the DuplicationBehavior enumeration

Exceptions

Definition at line 1918 of file ResourceStorage.php.

Referenced by TYPO3\CMS\Core\Resource\AbstractFile\copyTo().

◆ copyFolder()

Folder TYPO3\CMS\Core\Resource\ResourceStorage::copyFolder	(	FolderInterface	$folderToCopy,
		FolderInterface	$targetParentFolder,
			$newFolderName = `null`,
			$conflictMode = `DuplicationBehavior::RENAME`
	)

Copies a folder.

Parameters

FolderInterface	$folderToCopy	‪The folder to copy
FolderInterface	$targetParentFolder	‪The target folder
string	$newFolderName
string	$conflictMode	‪a value of the DuplicationBehavior enumeration

Returns: ‪Folder The new (copied) folder object

Exceptions

InvalidTargetFolderException

Definition at line 2248 of file ResourceStorage.php.

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

◆ copyFolderBetweenStorages()

TYPO3\CMS\Core\Resource\ResourceStorage::copyFolderBetweenStorages	(	FolderInterface	$folderToCopy,
		FolderInterface	$targetParentFolder,
			$newFolderName
	)

protected

Copies a folder between storages.

Parameters

FolderInterface	$folderToCopy
FolderInterface	$targetParentFolder
string	$newFolderName

Exceptions

NotImplementedMethodException

Definition at line 2298 of file ResourceStorage.php.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\copyFolder().

◆ countFilesInFolder()

int TYPO3\CMS\Core\Resource\ResourceStorage::countFilesInFolder	(	Folder	$folder,
			$useFilters = `true`,
			$recursive = `false`
	)

Parameters

Folder	$folder
bool	$useFilters
bool	$recursive

Returns: ‪int Number of files in folder

Exceptions

Exception

Definition at line 1633 of file ResourceStorage.php.

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

◆ countFoldersInFolder()

int TYPO3\CMS\Core\Resource\ResourceStorage::countFoldersInFolder	(	Folder	$folder,
			$useFilters = `true`,
			$recursive = `false`
	)

Parameters

Folder	$folder
bool	$useFilters
bool	$recursive

Returns: ‪int Number of subfolders

Exceptions

Exception

Definition at line 2439 of file ResourceStorage.php.

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

Referenced by TYPO3\CMS\Form\Domain\Finishers\DeleteUploadsFinisher\isEmptyFolder().

◆ createFile()

FileInterface TYPO3\CMS\Core\Resource\ResourceStorage::createFile	(		$fileName,
		Folder	$targetFolderObject
	)

Creates a new file

previously in \TYPO3\CMS\Core\Utility\File\ExtendedFileUtility::func_newfile()

Parameters

string	$fileName	‪The name of the file to be created
Folder	$targetFolderObject	‪The target folder where the file should be created

Exceptions

Exception

Definition at line 1843 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\assureFileAddPermissions(), TYPO3\CMS\Core\Resource\ResourceFactory\getFileObjectByStorageAndIdentifier(), TYPO3\CMS\Core\Resource\Folder\getIdentifier(), TYPO3\CMS\Core\Resource\ResourceStorage\getResourceFactoryInstance(), and TYPO3\CMS\Core\Resource\ResourceStorage\getUid().

◆ createFolder()

Folder TYPO3\CMS\Core\Resource\ResourceStorage::createFolder	(		$folderName,
		Folder	$parentFolder = `null`
	)

Creates a new folder.

previously in \TYPO3\CMS\Core\Utility\File\ExtendedFileUtility::func_newfolder()

Parameters

string	$folderName	‪The new folder name
Folder	$parentFolder	‪(optional) the parent folder to create the new folder inside of. If not given, the root folder is used

Returns: ‪Folder

Exceptions

Exception

Definition at line 2484 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\checkFolderActionPermission(), TYPO3\CMS\Core\Resource\Driver\DriverInterface\createFolder(), TYPO3\CMS\Core\Resource\ResourceStorage\getDriver(), TYPO3\CMS\Core\Resource\ResourceStorage\getFolder(), and TYPO3\CMS\Core\Resource\ResourceStorage\getRootLevelFolder().

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\getProcessingFolder().

◆ deleteFile()

bool TYPO3\CMS\Core\Resource\ResourceStorage::deleteFile ( $fileObject )

Previously in \TYPO3\CMS\Core\Utility\File\ExtendedFileUtility::deleteFile()

Parameters

FileInterface $fileObject

Exceptions

Exception

Definition at line 1864 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\$evaluatePermissions, TYPO3\CMS\Core\Resource\ResourceStorage\assureFileDeletePermissions(), TYPO3\CMS\Core\Resource\ResourceStorage\getNearestRecyclerFolder(), and TYPO3\CMS\Core\Resource\ResourceStorage\moveFile().

Referenced by TYPO3\CMS\Core\Resource\AbstractFile\delete(), and TYPO3\CMS\Core\Resource\ResourceStorage\deleteFolder().

◆ deleteFolder()

bool TYPO3\CMS\Core\Resource\ResourceStorage::deleteFolder	(	$folderObject,
		$deleteRecursively = `false`
	)

Previously in \TYPO3\CMS\Core\Utility\File\ExtendedFileUtility::folder_delete()

Parameters

Folder	$folderObject
bool	$deleteRecursively

Exceptions

Definition at line 2357 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\assureFolderDeletePermission(), TYPO3\CMS\Core\Resource\ResourceStorage\deleteFile(), and TYPO3\CMS\Core\Resource\ResourceStorage\getFilesInFolder().

Referenced by TYPO3\CMS\Core\Tests\Unit\Resource\ResourceStorageTest\deleteFolderThrowsExceptionIfFolderIsNotEmptyAndRecursiveDeleteIsDisabled().

◆ getAllFileObjectsInFolder()

File [] TYPO3\CMS\Core\Resource\ResourceStorage::getAllFileObjectsInFolder ( Folder $folder )

protected

Returns an array with all file objects in a folder and its subfolders, with the file identifiers as keys.

Todo:: ‪check if this is a duplicate

Parameters

Folder $folder

Returns: ‪File[]

Definition at line 2150 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\Folder\getFiles(), and TYPO3\CMS\Core\Resource\Folder\getSubfolders().

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

◆ getBackendUser()

TYPO3 CMS Core Authentication BackendUserAuthentication TYPO3\CMS\Core\Resource\ResourceStorage::getBackendUser ( )

protected

Returns the current BE user.

Returns: ‪\TYPO3\CMS\Core\Authentication\BackendUserAuthentication

Definition at line 2909 of file ResourceStorage.php.

References $GLOBALS.

◆ getCapabilities()

int TYPO3\CMS\Core\Resource\ResourceStorage::getCapabilities ( )

Returns the capabilities of this storage.

Returns: ‪int

See also: ‪\TYPO3\CMS\Core\Resource\ResourceStorageInterface::CAPABILITY_BROWSABLE; ‪\TYPO3\CMS\Core\Resource\ResourceStorageInterface::CAPABILITY_PUBLIC; ‪\TYPO3\CMS\Core\Resource\ResourceStorageInterface::CAPABILITY_WRITABLE; ‪\TYPO3\CMS\Core\Resource\ResourceStorageInterface::CAPABILITY_HIERARCHICAL_IDENTIFIERS

Definition at line 348 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\$capabilities.

◆ getConfiguration()

array TYPO3\CMS\Core\Resource\ResourceStorage::getConfiguration ( )

Gets the configuration.

Returns: ‪array

Definition at line 259 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\$configuration.

Referenced by TYPO3\CMS\Install\Service\Typo3tempFileService\getStatsFromStorage(), and TYPO3\CMS\Impexp\Import\isEquivalentObjectStorage().

◆ getDefaultFolder()

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

Returns the default folder where new files are stored if no other folder is given.

Returns: ‪Folder

Definition at line 2528 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\getFolder().

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\addUploadedFile(), and TYPO3\CMS\Core\Resource\ResourceStorage\sanitizeFileName().

◆ getDriver()

Driver DriverInterface TYPO3\CMS\Core\Resource\ResourceStorage::getDriver ( )

protected

Returns the driver object belonging to this storage.

Returns: ‪Driver\DriverInterface

Definition at line 301 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\$driver.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\createFolder(), and TYPO3\CMS\Core\Resource\ResourceStorage\isWithinProcessingFolder().

◆ getDriverType()

string TYPO3\CMS\Core\Resource\ResourceStorage::getDriverType ( )

Gets the driver Type configured for this storage.

Returns: ‪string

Definition at line 2865 of file ResourceStorage.php.

Referenced by TYPO3\CMS\Core\Resource\Service\ExtractorService\extractMetaData(), TYPO3\CMS\Core\Resource\Index\MetaDataRepository\findByFile(), TYPO3\CMS\Impexp\Import\isEquivalentObjectStorage(), and TYPO3\CMS\Core\Controller\FileDumpController\isFileValid().

◆ getEvaluatePermissions()

bool TYPO3\CMS\Core\Resource\ResourceStorage::getEvaluatePermissions ( )

Gets whether the permissions to access or write into this storage should be checked or not.

Returns: ‪bool $evaluatePermissions

Definition at line 643 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\$evaluatePermissions.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\getNestedProcessingFolder().

◆ getFile()

FileInterface TYPO3\CMS\Core\Resource\ResourceStorage::getFile ( $identifier )

Gets a file by identifier.

Parameters

string $identifier

Returns: ‪FileInterface

Definition at line 1457 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\getFileFactory(), TYPO3\CMS\Core\Resource\ResourceFactory\getFileObjectByStorageAndIdentifier(), TYPO3\CMS\Core\Resource\ResourceStorage\getUid(), and TYPO3\CMS\Core\Resource\File\setMissing().

◆ getFileContents()

string TYPO3\CMS\Core\Resource\ResourceStorage::getFileContents ( $file )

Get contents of a file object

Parameters

FileInterface $file

Exceptions

Exception

Definition at line 1737 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\assureFileReadPermission().

Referenced by TYPO3\CMS\Core\Resource\File\getContents(), and TYPO3\CMS\Core\Resource\AbstractFile\getContents().

◆ getFileFactory()

ResourceFactory TYPO3\CMS\Core\Resource\ResourceStorage::getFileFactory ( )

protected

Returns: ‪ResourceFactory

Definition at line 2677 of file ResourceStorage.php.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\getFile(), TYPO3\CMS\Core\Resource\ResourceStorage\getFileInFolder(), and TYPO3\CMS\Core\Resource\ResourceStorage\getFilesInFolder().

◆ getFileForLocalProcessing()

string TYPO3\CMS\Core\Resource\ResourceStorage::getFileForLocalProcessing	(	FileInterface	$fileObject,
			$writable = `true`
	)

Copies a file from the storage for local processing.

Parameters

FileInterface	$fileObject
bool	$writable

Returns: ‪string Path to local file (either original or copied to some temporary local location)

Definition at line 1445 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceInterface\getIdentifier().

Referenced by TYPO3\CMS\Core\Resource\AbstractFile\getForLocalProcessing().

◆ getFileIdentifiersInFolder()

array TYPO3\CMS\Core\Resource\ResourceStorage::getFileIdentifiersInFolder	(	$folderIdentifier,
		$useFilters = `true`,
		$recursive = `false`
	)

Parameters

string	$folderIdentifier
bool	$useFilters
bool	$recursive

Returns: ‪array

Definition at line 1620 of file ResourceStorage.php.

◆ getFileIndexRepository()

Index FileIndexRepository TYPO3\CMS\Core\Resource\ResourceStorage::getFileIndexRepository ( )

protected

Returns: ‪Index\FileIndexRepository

Definition at line 2685 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\Index\FileIndexRepository\getInstance().

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\getFilesInFolder().

◆ getFileInfo()

array TYPO3\CMS\Core\Resource\ResourceStorage::getFileInfo ( FileInterface $fileObject )

Gets information about a file.

Parameters

FileInterface $fileObject

Returns: ‪array

Definition at line 1473 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\getFileInfoByIdentifier(), and TYPO3\CMS\Core\Resource\ResourceInterface\getIdentifier().

Referenced by TYPO3\CMS\Core\Resource\File\toArray(), and TYPO3\CMS\Core\Resource\ProcessedFile\updateProperties().

◆ getFileInfoByIdentifier()

array TYPO3\CMS\Core\Resource\ResourceStorage::getFileInfoByIdentifier	(		$identifier,
		array	$propertiesToExtract = `[]`
	)

Gets information about a file by its identifier.

Parameters

string	$identifier
array	$propertiesToExtract

Returns: ‪array

Definition at line 1486 of file ResourceStorage.php.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\getFileInfo().

◆ getFileInFolder()

File ProcessedFile null TYPO3\CMS\Core\Resource\ResourceStorage::getFileInFolder	(		$fileName,
		Folder	$folder
	)

Get file from folder

Parameters

string	$fileName
Folder	$folder

Returns: ‪File|ProcessedFile|null

Definition at line 1565 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\getFileFactory(), TYPO3\CMS\Core\Resource\ResourceFactory\getFileObjectByStorageAndIdentifier(), TYPO3\CMS\Core\Resource\Folder\getIdentifier(), and TYPO3\CMS\Core\Resource\ResourceStorage\getUid().

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\addUploadedFile().

◆ getFileMounts()

array TYPO3\CMS\Core\Resource\ResourceStorage::getFileMounts ( )

Returns all file mounts that are registered with this storage.

Returns: ‪array

Definition at line 576 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\$fileMounts.

Referenced by TYPO3\CMS\Backend\Tree\View\FolderTreeView\getBrowseableTreeForStorage(), and TYPO3\CMS\Core\Resource\Service\UserFileMountService\renderTceformsSelectDropdown().

◆ getFileProcessingService()

Service FileProcessingService TYPO3\CMS\Core\Resource\ResourceStorage::getFileProcessingService ( )

protected

Returns: ‪Service\FileProcessingService

Definition at line 2693 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\$fileProcessingService, and TYPO3\CMS\Core\Resource\ResourceStorage\$this.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\processFile().

◆ getFilesInFolder()

File [] TYPO3\CMS\Core\Resource\ResourceStorage::getFilesInFolder	(	Folder	$folder,
			$start = `0`,
			$maxNumberOfItems = `0`,
			$useFilters = `true`,
			$recursive = `false`,
			$sort = `''`,
			$sortRev = `false`
	)

Parameters

Folder	$folder
int	$start
int	$maxNumberOfItems
bool	$useFilters
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: ‪File[]

Exceptions

Exception

Definition at line 1586 of file ResourceStorage.php.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\deleteFolder(), and TYPO3\CMS\Install\Updates\SvgFilesSanitization\resolveSvgFiles().

◆ getFolder()

Folder InaccessibleFolder TYPO3\CMS\Core\Resource\ResourceStorage::getFolder	(	$identifier,
		$returnInaccessibleFolderObject = `false`
	)

Parameters

string	$identifier
bool	$returnInaccessibleFolderObject

Returns: ‪Folder|InaccessibleFolder

Exceptions

Definition at line 2541 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\$this, TYPO3\CMS\Core\Resource\ResourceStorage\assureFolderReadPermission(), TYPO3\CMS\Core\Resource\ResourceFactory\createFolderObject(), and TYPO3\CMS\Core\Resource\ResourceStorage\getResourceFactoryInstance().

◆ getFolderIdentifierFromFileIdentifier()

string TYPO3\CMS\Core\Resource\ResourceStorage::getFolderIdentifierFromFileIdentifier ( $fileIdentifier )

Parameters

string $fileIdentifier

Returns: ‪string

Definition at line 1553 of file ResourceStorage.php.

◆ getFolderIdentifiersInFolder()

array TYPO3\CMS\Core\Resource\ResourceStorage::getFolderIdentifiersInFolder	(	$folderIdentifier,
		$useFilters = `true`,
		$recursive = `false`
	)

Parameters

string	$folderIdentifier
bool	$useFilters
bool	$recursive

Returns: ‪array

Definition at line 1646 of file ResourceStorage.php.

◆ getFolderInfo()

array TYPO3\CMS\Core\Resource\ResourceStorage::getFolderInfo ( Folder $folder )

Retrieves information about a folder

Parameters

Folder $folder

Returns: ‪array

Definition at line 2518 of file ResourceStorage.php.

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

◆ getFolderInFolder()

Folder InaccessibleFolder TYPO3\CMS\Core\Resource\ResourceStorage::getFolderInFolder	(		$folderName,
		Folder	$parentFolder,
			$returnInaccessibleFolderObject = `false`
	)

Returns the Identifier for a folder within a given folder.

Parameters

string	$folderName	‪The name of the target folder
Folder	$parentFolder
bool	$returnInaccessibleFolderObject

Returns: ‪Folder|InaccessibleFolder

Exceptions

Definition at line 2391 of file ResourceStorage.php.

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

◆ getFoldersInFolder()

Folder [] TYPO3\CMS\Core\Resource\ResourceStorage::getFoldersInFolder	(	Folder	$folder,
			$start = `0`,
			$maxNumberOfItems = `0`,
			$useFilters = `true`,
			$recursive = `false`,
			$sort = `''`,
			$sortRev = `false`
	)

Parameters

Folder	$folder
int	$start
int	$maxNumberOfItems
bool	$useFilters
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: ‪Folder[]

Definition at line 2411 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\$processingFolder, TYPO3\CMS\Core\Resource\ResourceStorage\getFolder(), TYPO3\CMS\Core\Resource\Folder\getIdentifier(), and TYPO3\CMS\Core\Resource\ResourceStorage\getProcessingFolders().

◆ getIndexer()

Index Indexer TYPO3\CMS\Core\Resource\ResourceStorage::getIndexer ( )

protected

Gets the Indexer.

Returns: ‪Index\Indexer

Definition at line 2875 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\$this.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\addFile(), TYPO3\CMS\Core\Resource\ResourceStorage\moveFile(), TYPO3\CMS\Core\Resource\ResourceStorage\moveFolder(), TYPO3\CMS\Core\Resource\ResourceStorage\renameFile(), TYPO3\CMS\Core\Resource\ResourceStorage\renameFolder(), TYPO3\CMS\Core\Resource\ResourceStorage\replaceFile(), and TYPO3\CMS\Core\Resource\ResourceStorage\setFileContents().

◆ getName()

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

Returns the name of this storage.

Returns: ‪string

Definition at line 311 of file ResourceStorage.php.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\__construct(), TYPO3\CMS\Backend\Tree\View\FolderTreeView\getBrowseableTreeForStorage(), TYPO3\CMS\Recordlist\Browser\FileBrowser\renderFilesInFolder(), and TYPO3\CMS\Core\Resource\Service\UserFileMountService\renderTceformsSelectDropdown().

◆ getNamesForNestedProcessingFolder()

string [] TYPO3\CMS\Core\Resource\ResourceStorage::getNamesForNestedProcessingFolder	(	$fileIdentifier,
		$levels
	)

protected

Generates appropriate hashed sub-folder path for a given file identifier

Parameters

string	$fileIdentifier
int	$levels

Returns: ‪string[]

Definition at line 2847 of file ResourceStorage.php.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\getNestedProcessingFolder().

◆ getNearestRecyclerFolder()

Folder null TYPO3\CMS\Core\Resource\ResourceStorage::getNearestRecyclerFolder ( FileInterface $file )

protected

Get the nearest Recycler folder for given file

Return null if:

‪There is no folder with ROLE_RECYCLER in the rootline of the given File
‪File is a ProcessedFile (we don't know the concept of recycler folders for processedFiles)
‪File is located in a folder with ROLE_RECYCLER

Parameters

FileInterface $file

Returns: ‪Folder|null

Definition at line 2925 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceInterface\getIdentifier(), TYPO3\CMS\Core\Resource\ResourceInterface\getParentFolder(), TYPO3\CMS\Core\Resource\ResourceStorage\isBrowsable(), and TYPO3\CMS\Core\Resource\FolderInterface\ROLE_RECYCLER.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\deleteFile().

◆ getNestedProcessingFolder()

Folder TYPO3\CMS\Core\Resource\ResourceStorage::getNestedProcessingFolder	(	File	$file,
		Folder	$rootProcessingFolder
	)

protected

Getter function to return the the file's corresponding hashed subfolder of the processed folder

Parameters

File	$file
Folder	$rootProcessingFolder

Returns: ‪Folder

Exceptions

Exception

Definition at line 2815 of file ResourceStorage.php.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\getProcessingFolder().

◆ getProcessingFolder()

Folder TYPO3\CMS\Core\Resource\ResourceStorage::getProcessingFolder ( File $file = null )

Getter function to return the folder where the files can be processed. Does not check for access rights here.

Parameters

File $file ‪Specific file you want to have the processing folder for

Returns: ‪Folder

Definition at line 2738 of file ResourceStorage.php.

Referenced by TYPO3\CMS\Core\Resource\ProcessedFile\__construct(), TYPO3\CMS\Backend\Resource\Processing\DeferredBackendImageProcessor\canProcessTask(), TYPO3\CMS\Core\Resource\Processing\LocalImageProcessor\checkForExistingTargetFile(), TYPO3\CMS\Core\Resource\ResourceStorage\getProcessingFolder(), TYPO3\CMS\Core\Resource\ResourceStorage\getProcessingFolders(), TYPO3\CMS\Install\Service\Typo3tempFileService\getStatsFromStorage(), and TYPO3\CMS\Core\Resource\ResourceStorage\updateProcessedFile().

◆ getProcessingFolders()

Folder [] TYPO3\CMS\Core\Resource\ResourceStorage::getProcessingFolders ( )

Get all processing folders that live in this storage

Returns: ‪Folder[]

Definition at line 1672 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\$processingFolders, TYPO3\CMS\Core\Resource\ResourceStorage\$this, TYPO3\CMS\Core\Resource\ResourceFactory\createFolderObject(), TYPO3\CMS\Core\Resource\ResourceStorage\getProcessingFolder(), TYPO3\CMS\Core\Resource\ResourceStorage\getResourceFactoryInstance(), TYPO3\CMS\Core\Resource\ResourceStorage\getUid(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\getFoldersInFolder(), TYPO3\CMS\Core\Resource\ResourceStorage\isProcessingFolder(), and TYPO3\CMS\Core\Resource\ResourceStorage\isWithinProcessingFolder().

◆ getPseudoStream()

ResponseInterface TYPO3\CMS\Core\Resource\ResourceStorage::getPseudoStream	(	FileInterface	$file,
		bool	$asDownload = `false`,
		string	$alternativeFilename = `null`,
		string	$overrideMimeType = `null`
	)

protected

Wrap DriverInterface::dumpFileContents into a SelfEmittableStreamInterface

Parameters

FileInterface	$file
bool	$asDownload	‪If set Content-Disposition attachment is sent, inline otherwise
string	$alternativeFilename	‪the filename for the download (if $asDownload is set)
string	$overrideMimeType	‪If set this will be used as Content-Type header instead of the automatically detected mime type.

Returns: ‪ResponseInterface

Definition at line 1779 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\$this, TYPO3\CMS\Core\Resource\ResourceInterface\getIdentifier(), TYPO3\CMS\Core\Resource\FileInterface\getMimeType(), TYPO3\CMS\Core\Resource\ResourceInterface\getName(), and TYPO3\CMS\Core\Resource\FileInterface\getSize().

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\streamFile().

◆ getPublicUrl()

string null TYPO3\CMS\Core\Resource\ResourceStorage::getPublicUrl	(	ResourceInterface	$resourceObject,
			$relativeToCurrentScript = `false`
	)

Returns a publicly accessible URL for a file.

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

Parameters

ResourceInterface	$resourceObject	‪The file or folder object
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

Definition at line 1369 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\$this, TYPO3\CMS\Core\Utility\PathUtility\dirname(), TYPO3\CMS\Core\Utility\PathUtility\getAbsoluteWebPath(), TYPO3\CMS\Core\Resource\ResourceInterface\getIdentifier(), TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\OnlineMediaHelperRegistry\getInstance(), TYPO3\CMS\Core\Core\Environment\getPublicPath(), TYPO3\CMS\Core\Utility\PathUtility\getRelativePathTo(), TYPO3\CMS\Core\Resource\ResourceStorage\hasCapability(), TYPO3\CMS\Core\Resource\ResourceStorage\isOnline(), and TYPO3\CMS\Core\Utility\GeneralUtility\isValidUrl().

Referenced by TYPO3\CMS\Core\Resource\Folder\getPublicUrl(), TYPO3\CMS\Core\Resource\File\getPublicUrl(), TYPO3\CMS\Core\Resource\AbstractFile\getPublicUrl(), TYPO3\CMS\Core\Resource\ProcessedFile\getPublicUrl(), and TYPO3\CMS\Core\Tests\Unit\Resource\ResourceStorageTest\getPublicUrlReturnsNullIfStorageIsNotOnline().

◆ getResourceFactoryInstance()

ResourceFactory TYPO3\CMS\Core\Resource\ResourceStorage::getResourceFactoryInstance ( )

Returns: ‪ResourceFactory

Definition at line 2899 of file ResourceStorage.php.

◆ getRole()

string TYPO3\CMS\Core\Resource\ResourceStorage::getRole ( FolderInterface $folder )

Gets the role of a folder.

Parameters

FolderInterface $folder ‪Folder object to get the role from

Returns: ‪string The role the folder has

Definition at line 2707 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceInterface\getIdentifier(), TYPO3\CMS\Core\Resource\ResourceStorage\isProcessingFolder(), TYPO3\CMS\Core\Resource\FolderInterface\ROLE_DEFAULT, TYPO3\CMS\Core\Resource\FolderInterface\ROLE_MOUNT, TYPO3\CMS\Core\Resource\FolderInterface\ROLE_PROCESSING, TYPO3\CMS\Core\Resource\FolderInterface\ROLE_READONLY_MOUNT, and TYPO3\CMS\Core\Resource\FolderInterface\ROLE_USER_MOUNT.

Referenced by TYPO3\CMS\Form\Slot\FilePersistenceSlot\isRecycleFolder().

◆ getRootLevelFolder()

Folder TYPO3\CMS\Core\Resource\ResourceStorage::getRootLevelFolder ( $respectFileMounts = true )

Returns the folders on the root level of the storage or the first mount point of this storage for this user if $respectFileMounts is set.

Parameters

bool $respectFileMounts

Returns: ‪Folder

Definition at line 2615 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\$this, TYPO3\CMS\Core\Resource\ResourceFactory\createFolderObject(), and TYPO3\CMS\Core\Resource\ResourceStorage\getResourceFactoryInstance().

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\createFolder(), TYPO3\CMS\Backend\Tree\View\FolderTreeView\getBrowseableTreeForStorage(), TYPO3\CMS\Core\Imaging\IconFactory\getIconForResource(), TYPO3\CMS\Core\Resource\ResourceStorage\getProcessingFolder(), TYPO3\CMS\Backend\Tree\View\FolderTreeView\getTableNameForClickMenu(), TYPO3\CMS\Core\Resource\ResourceStorage\isWithinFileMountBoundaries(), TYPO3\CMS\Core\Resource\Service\UserFileMountService\renderTceformsSelectDropdown(), TYPO3\CMS\Install\Updates\SvgFilesSanitization\resolveSvgFiles(), and TYPO3\CMS\Core\Resource\ResourceStorage\searchFiles().

◆ getStorageRecord()

array TYPO3\CMS\Core\Resource\ResourceStorage::getStorageRecord ( )

Gets the storage record.

Returns: ‪array

Definition at line 279 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\$storageRecord.

◆ getUid()

int TYPO3\CMS\Core\Resource\ResourceStorage::getUid ( )

Returns the UID of this storage.

Returns: ‪int

Definition at line 321 of file ResourceStorage.php.

◆ getUniqueName()

string TYPO3\CMS\Core\Resource\ResourceStorage::getUniqueName	(	FolderInterface	$folder,
			$theFile,
			$dontCheckForUnique = `false`
	)

protected

Returns the destination path/fileName of a unique fileName/foldername in that path. If $theFile exists in $theDest (directory) the file have numbers appended up to $this->maxNumber. Hereafter a unique string will be appended. This function is used by fx. DataHandler when files are attached to records and needs to be uniquely named in the uploads/* folders

Parameters

FolderInterface	$folder
string	$theFile	‪The input fileName to check
bool	$dontCheckForUnique	‪If set the fileName is returned with the path prepended without checking whether it already existed!

Exceptions

Definition at line 2639 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\$this, TYPO3\CMS\Core\Resource\ResourceInterface\getIdentifier(), TYPO3\CMS\Core\Utility\StringUtility\getUniqueId(), and TYPO3\CMS\Core\Utility\PathUtility\pathinfo().

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\addFile(), TYPO3\CMS\Core\Resource\ResourceStorage\copyFolder(), TYPO3\CMS\Core\Resource\ResourceStorage\moveFile(), and TYPO3\CMS\Core\Resource\ResourceStorage\renameFile().

◆ hasCapability()

bool TYPO3\CMS\Core\Resource\ResourceStorage::hasCapability ( $capability )

protected

Returns TRUE if this storage has the given capability.

Parameters

int $capability ‪A capability, as defined in a CAPABILITY_* constant

Returns: ‪bool

Definition at line 359 of file ResourceStorage.php.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\getPublicUrl(), TYPO3\CMS\Core\Resource\ResourceStorage\hasHierarchicalIdentifiers(), TYPO3\CMS\Core\Resource\ResourceStorage\isBrowsable(), TYPO3\CMS\Core\Resource\ResourceStorage\isPublic(), and TYPO3\CMS\Core\Resource\ResourceStorage\isWritable().

◆ hasChildren()

bool TYPO3\CMS\Core\Resource\ResourceStorage::hasChildren ( )

Tells whether there are children in this storage.

Returns: ‪bool

Definition at line 331 of file ResourceStorage.php.

◆ hasFile()

bool TYPO3\CMS\Core\Resource\ResourceStorage::hasFile ( $identifier )

Returns TRUE if the specified file exists

Parameters

string $identifier

Returns: ‪bool

Definition at line 1658 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\assureFolderReadPermission(), and TYPO3\CMS\Core\Resource\ResourceStorage\isWithinProcessingFolder().

Referenced by TYPO3\CMS\Core\Resource\ProcessedFileRepository\findByStorageAndIdentifier().

◆ hasFileInFolder()

bool TYPO3\CMS\Core\Resource\ResourceStorage::hasFileInFolder	(		$fileName,
		Folder	$folder
	)

Checks if the queried file in the given folder exists

Parameters

string	$fileName
Folder	$folder

Returns: ‪bool

Definition at line 1723 of file ResourceStorage.php.

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

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\addUploadedFile().

◆ hasFolder()

bool TYPO3\CMS\Core\Resource\ResourceStorage::hasFolder ( $identifier )

Returns TRUE if the specified folder exists.

Parameters

string $identifier

Returns: ‪bool

Definition at line 2452 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\assureFolderReadPermission().

◆ hasFolderInFolder()

bool TYPO3\CMS\Core\Resource\ResourceStorage::hasFolderInFolder	(		$folderName,
		Folder	$folder
	)

Checks if the given file exists in the given folder

Parameters

string	$folderName
Folder	$folder

Returns: ‪bool

Definition at line 2465 of file ResourceStorage.php.

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

◆ hashFile()

string TYPO3\CMS\Core\Resource\ResourceStorage::hashFile	(	FileInterface	$fileObject,
			$hash
	)

Creates a (cryptographic) hash for a file.

Parameters

FileInterface	$fileObject
string	$hash

Exceptions

Definition at line 1320 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceInterface\getIdentifier(), and TYPO3\CMS\Core\Resource\ResourceStorage\hashFileByIdentifier().

Referenced by TYPO3\CMS\Impexp\Export\export_addSysFile(), and TYPO3\CMS\Core\Resource\AbstractFile\getSha1().

◆ hashFileByIdentifier()

string TYPO3\CMS\Core\Resource\ResourceStorage::hashFileByIdentifier	(	$fileIdentifier,
		$hash
	)

Creates a (cryptographic) hash for a fileIdentifier.

Parameters

string	$fileIdentifier
string	$hash

Exceptions

Definition at line 1333 of file ResourceStorage.php.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\hashFile().

◆ hashFileIdentifier()

string TYPO3\CMS\Core\Resource\ResourceStorage::hashFileIdentifier ( $file )

Hashes a file identifier, taking the case sensitivity of the file system into account. This helps mitigating problems with case-insensitive databases.

Parameters

string | FileInterface $file

Returns: ‪string

Definition at line 1350 of file ResourceStorage.php.

Referenced by TYPO3\CMS\Core\Resource\Index\FileIndexRepository\findOneByStorageUidAndIdentifier(), and TYPO3\CMS\Core\Resource\FileReference\getHashedIdentifier().

◆ hasHierarchicalIdentifiers()

bool TYPO3\CMS\Core\Resource\ResourceStorage::hasHierarchicalIdentifiers ( )

Returns TRUE if this storage stores folder structure in file identifiers.

Returns: ‪bool

Definition at line 403 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\hasCapability().

◆ isBrowsable()

bool TYPO3\CMS\Core\Resource\ResourceStorage::isBrowsable ( )

Returns TRUE if this storage is browsable by a (backend) user of TYPO3.

Returns: ‪bool

Definition at line 393 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\hasCapability(), and TYPO3\CMS\Core\Resource\ResourceStorage\isOnline().

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\checkFolderActionPermission(), TYPO3\CMS\Backend\Tree\View\FolderTreeView\getBrowseableTreeForStorage(), TYPO3\CMS\Core\Imaging\IconFactory\getIconForResource(), TYPO3\CMS\Core\Resource\ResourceStorage\getNearestRecyclerFolder(), TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\getStorageByUid(), and TYPO3\CMS\Core\Resource\Service\UserFileMountService\renderTceformsSelectDropdown().

◆ isDefault()

bool TYPO3\CMS\Core\Resource\ResourceStorage::isDefault ( )

Returns: ‪bool

Definition at line 2891 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\$isDefault.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\__construct(), and TYPO3\CMS\Core\Resource\ResourceStorage\setDefault().

◆ isOnline()

bool TYPO3\CMS\Core\Resource\ResourceStorage::isOnline ( )

Returns TRUE if this storage is browsable by a (backend) user of TYPO3.

Returns: ‪bool

Definition at line 448 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\$isOnline, and TYPO3\CMS\Core\Resource\ResourceStorage\getUid().

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\__construct(), TYPO3\CMS\Backend\Tree\View\FolderTreeView\getBrowseableTreeForStorage(), TYPO3\CMS\Core\Resource\ResourceStorage\getPublicUrl(), TYPO3\CMS\Core\Resource\ResourceStorage\isBrowsable(), TYPO3\CMS\Impexp\Import\isEquivalentObjectStorage(), TYPO3\CMS\Core\Resource\ResourceStorage\markAsPermanentlyOffline(), and TYPO3\CMS\Core\Resource\ResourceStorage\markAsTemporaryOffline().

◆ isProcessingFolder()

bool TYPO3\CMS\Core\Resource\ResourceStorage::isProcessingFolder ( Folder $folder )

Returns TRUE if folder that is in current storage is set as processing folder for one of the existing storages

Parameters

Folder $folder

Returns: ‪bool

Definition at line 1704 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\$processingFolder, TYPO3\CMS\Core\Resource\Folder\getCombinedIdentifier(), and TYPO3\CMS\Core\Resource\ResourceStorage\getProcessingFolders().

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\getRole().

◆ isPublic()

bool TYPO3\CMS\Core\Resource\ResourceStorage::isPublic ( )

Returns TRUE if this storage is publicly available. This is just a configuration option and does not mean that it really is public. OTOH a storage that is marked as not publicly available will trigger the file publishing mechanisms of TYPO3.

Returns: ‪bool

Definition at line 372 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\hasCapability().

◆ isWithinFileMountBoundaries()

bool TYPO3\CMS\Core\Resource\ResourceStorage::isWithinFileMountBoundaries	(	$subject,
		$checkWriteAccess = `false`
	)

Checks if the given subject is within one of the registered user file mounts. If not, working with the file is not permitted for the user.

Parameters

ResourceInterface	$subject	‪file or folder
bool	$checkWriteAccess	‪If true, it is not only checked if the subject is within the file mount but also whether it isn't a read only file mount

Returns: ‪bool

Definition at line 589 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\getRootLevelFolder(), and TYPO3\CMS\Core\Resource\ResourceStorage\isWithinProcessingFolder().

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\checkFileActionPermission(), TYPO3\CMS\Core\Resource\ResourceStorage\checkFolderActionPermission(), and TYPO3\CMS\Backend\Template\Components\MetaInformation\getRecordInformations().

◆ isWithinFolder()

bool TYPO3\CMS\Core\Resource\ResourceStorage::isWithinFolder	(	Folder	$folder,
		ResourceInterface	$resource
	)

Checks if a resource (file or folder) is within the given folder

Parameters

Folder	$folder
ResourceInterface	$resource

Returns: ‪bool

Exceptions

Definition at line 2596 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\$this, TYPO3\CMS\Core\Resource\ResourceInterface\getIdentifier(), TYPO3\CMS\Core\Resource\Folder\getIdentifier(), TYPO3\CMS\Core\Resource\ResourceInterface\getStorage(), and TYPO3\CMS\Core\Resource\Folder\getStorage().

Referenced by TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\canBePastedInto(), TYPO3\CMS\Filelist\FileList\makeClip(), TYPO3\CMS\Core\Resource\ResourceStorage\moveFolder(), TYPO3\CMS\Filelist\Controller\FileListController\registerButtons(), and TYPO3\CMS\Filelist\FileList\renderClipboardHeaderRow().

◆ isWithinProcessingFolder()

bool TYPO3\CMS\Core\Resource\ResourceStorage::isWithinProcessingFolder ( $identifier )

Returns TRUE if the specified file is in a folder that is set a processing for a storage

Parameters

string $identifier

Returns: ‪bool

Definition at line 2576 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\$processingFolder, TYPO3\CMS\Core\Resource\ResourceStorage\getDriver(), TYPO3\CMS\Core\Resource\Folder\getIdentifier(), TYPO3\CMS\Core\Resource\ResourceStorage\getProcessingFolders(), TYPO3\CMS\Core\Resource\Folder\getStorage(), and TYPO3\CMS\Core\Resource\Driver\DriverInterface\isWithin().

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\hasFile(), and TYPO3\CMS\Core\Resource\ResourceStorage\isWithinFileMountBoundaries().

◆ isWritable()

bool TYPO3\CMS\Core\Resource\ResourceStorage::isWritable ( )

Returns TRUE if this storage is writable. This is determined by the driver and the storage configuration; user permissions are not taken into account.

Returns: ‪bool

Definition at line 383 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\hasCapability().

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\checkFileActionPermission(), TYPO3\CMS\Core\Resource\ResourceStorage\checkFolderActionPermission(), TYPO3\CMS\Impexp\Import\isEquivalentObjectStorage(), and TYPO3\CMS\Install\Updates\SvgFilesSanitization\resolveLocalStorages().

◆ markAsPermanentlyOffline()

TYPO3\CMS\Core\Resource\ResourceStorage::markAsPermanentlyOffline ( )

Blows the "fuse" and marks the storage as offline.

Can only be modified by an admin.

Typically, this is only done if the configuration is wrong.

Definition at line 494 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\getUid(), and TYPO3\CMS\Core\Resource\ResourceStorage\isOnline().

◆ markAsTemporaryOffline()

TYPO3\CMS\Core\Resource\ResourceStorage::markAsTemporaryOffline ( )

Marks this storage as offline for the next 5 minutes.

Non-permanent: This typically happens for remote storages that are "flaky" and not available all the time.

Definition at line 516 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\getUid(), and TYPO3\CMS\Core\Resource\ResourceStorage\isOnline().

◆ moveFile()

FileInterface TYPO3\CMS\Core\Resource\ResourceStorage::moveFile	(	$file,
		$targetFolder,
		$targetFileName = `null`,
		$conflictMode = `DuplicationBehavior::RENAME`
	)

Moves a $file into a $targetFolder the target folder has to be part of this storage

previously in \TYPO3\CMS\Core\Utility\File\ExtendedFileUtility::func_move()

Parameters

FileInterface	$file
Folder	$targetFolder
string	$targetFileName	‪an optional destination fileName
string	$conflictMode	‪a value of the DuplicationBehavior enumeration

Exceptions

Exception

Definition at line 1971 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\$this, TYPO3\CMS\Core\Resource\ResourceStorage\assureFileMovePermissions(), TYPO3\CMS\Core\Resource\DuplicationBehavior\CANCEL, TYPO3\CMS\Core\Type\Enumeration\cast(), TYPO3\CMS\Core\Resource\ResourceStorage\getIndexer(), TYPO3\CMS\Core\Resource\ResourceStorage\getUid(), TYPO3\CMS\Core\Resource\ResourceStorage\getUniqueName(), TYPO3\CMS\Core\Resource\DuplicationBehavior\RENAME, and TYPO3\CMS\Core\Resource\Index\Indexer\updateIndexEntry().

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\deleteFile(), TYPO3\CMS\Core\Tests\Unit\Resource\ResourceStorageTest\moveFileCallsDriversMethodsWithCorrectArguments(), and TYPO3\CMS\Core\Resource\AbstractFile\moveTo().

◆ moveFolder()

Folder TYPO3\CMS\Core\Resource\ResourceStorage::moveFolder	(	Folder	$folderToMove,
		Folder	$targetParentFolder,
			$newFolderName = `null`,
			$conflictMode = `DuplicationBehavior::RENAME`
	)

Moves a folder. If you want to move a folder from this storage to another one, call this method on the target storage, otherwise you will get an exception.

Parameters

Folder	$folderToMove	‪The folder to move.
Folder	$targetParentFolder	‪The target parent folder
string	$newFolderName
string	$conflictMode	‪a value of the DuplicationBehavior enumeration

Exceptions

Definition at line 2182 of file ResourceStorage.php.

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

◆ moveFolderBetweenStorages()

TYPO3\CMS\Core\Resource\ResourceStorage::moveFolderBetweenStorages	(	Folder	$folderToMove,
		Folder	$targetParentFolder,
			$newFolderName
	)

protected

Moves the given folder from a different storage to the target folder in this storage.

Parameters

Folder	$folderToMove
Folder	$targetParentFolder
string	$newFolderName

Exceptions

NotImplementedMethodException

Definition at line 2233 of file ResourceStorage.php.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\moveFolder().

◆ processFile()

ProcessedFile TYPO3\CMS\Core\Resource\ResourceStorage::processFile	(	FileInterface	$fileObject,
			$context,
		array	$configuration
	)

Passes a file to the File Processing Services and returns the resulting ProcessedFile object.

Parameters

FileInterface	$fileObject	‪The file object
string	$context
array	$configuration

Returns: ‪ProcessedFile

Exceptions

Definition at line 1428 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\$configuration, TYPO3\CMS\Core\Resource\ResourceStorage\$this, TYPO3\CMS\Core\Resource\ResourceStorage\getFileProcessingService(), TYPO3\CMS\Core\Resource\ResourceInterface\getStorage(), and TYPO3\CMS\Core\Resource\Service\FileProcessingService\processFile().

Referenced by TYPO3\CMS\Core\Resource\File\process().

◆ renameFile()

FileInterface TYPO3\CMS\Core\Resource\ResourceStorage::renameFile	(	$file,
		$targetFileName,
		$conflictMode = `DuplicationBehavior::RENAME`
	)

Previously in \TYPO3\CMS\Core\Utility\File\ExtendedFileUtility::func_rename()

Parameters

FileInterface	$file
string	$targetFileName
string	$conflictMode

Returns: ‪FileInterface

Exceptions

ExistingTargetFileNameException

Definition at line 2038 of file ResourceStorage.php.

Referenced by TYPO3\CMS\Core\Resource\AbstractFile\rename().

◆ renameFolder()

Folder TYPO3\CMS\Core\Resource\ResourceStorage::renameFolder	(	$folderObject,
		$newName
	)

Previously in \TYPO3\CMS\Core\Utility\File\ExtendedFileUtility::folder_move()

Parameters

Folder	$folderObject
string	$newName

Exceptions

Definition at line 2312 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\checkFolderActionPermission(), TYPO3\CMS\Core\Resource\ResourceStorage\getAllFileObjectsInFolder(), TYPO3\CMS\Core\Resource\ResourceStorage\getFolder(), TYPO3\CMS\Core\Resource\ResourceStorage\getIndexer(), and TYPO3\CMS\Core\Resource\Index\Indexer\updateIndexEntry().

◆ replaceFile()

FileInterface TYPO3\CMS\Core\Resource\ResourceStorage::replaceFile	(	FileInterface	$file,
			$localFilePath
	)

Replaces a file with a local file (e.g. a freshly uploaded file)

Parameters

FileInterface	$file
string	$localFilePath

Returns: ‪FileInterface

Exceptions

Exception

Definition at line 2091 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\assureFileReplacePermissions(), TYPO3\CMS\Core\Resource\ResourceInterface\getIdentifier(), TYPO3\CMS\Core\Resource\ResourceStorage\getIndexer(), and TYPO3\CMS\Core\Resource\Index\Indexer\updateIndexEntry().

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\addUploadedFile(), and TYPO3\CMS\Core\Resource\ResourceStorage\renameFile().

◆ resetFileAndFolderNameFiltersToDefault()

TYPO3\CMS\Core\Resource\ResourceStorage::resetFileAndFolderNameFiltersToDefault ( )

Resets the file and folder name filters to the default values defined in the TYPO3 configuration.

Definition at line 1502 of file ResourceStorage.php.

References $GLOBALS, and TYPO3\CMS\Core\Resource\ResourceStorage\fileAndFolderNameFilters.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\__construct(), and TYPO3\CMS\Install\Updates\SvgFilesSanitization\resolveSvgFiles().

◆ sanitizeFileName()

string TYPO3\CMS\Core\Resource\ResourceStorage::sanitizeFileName	(		$fileName,
		Folder	$targetFolder = `null`
	)

Clean up a fileName from not allowed characters

Parameters

string	$fileName	‪The name of the file to be sanitized
Folder \| null	$targetFolder	‪The target folder where the file is located or should be added

Returns: ‪string

Definition at line 1220 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\$this, and TYPO3\CMS\Core\Resource\ResourceStorage\getDefaultFolder().

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

◆ searchFiles()

FileSearchResultInterface TYPO3\CMS\Core\Resource\ResourceStorage::searchFiles	(	FileSearchDemand	$searchDemand,
		Folder	$folder = `null`,
		bool	$useFilters = `true`
	)

Search for files in a storage based on given restrictions and a possibly given folder.

Parameters

FileSearchDemand	$searchDemand
Folder \| null	$folder
bool	$useFilters	‪Whether storage filters should be applied

Returns: ‪FileSearchResultInterface

Definition at line 417 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\$this, TYPO3\CMS\Core\Resource\ResourceStorage\getRootLevelFolder(), and TYPO3\CMS\Core\Resource\Search\FileSearchDemand\withFolder().

◆ setConfiguration()

TYPO3\CMS\Core\Resource\ResourceStorage::setConfiguration ( array $configuration )

Sets the configuration.

Parameters

array $configuration

Definition at line 269 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\$configuration.

◆ setDefault()

TYPO3\CMS\Core\Resource\ResourceStorage::setDefault ( $isDefault )

Parameters

bool $isDefault

Definition at line 2883 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\$isDefault, and TYPO3\CMS\Core\Resource\ResourceStorage\isDefault().

◆ setDriver()

ResourceStorage TYPO3\CMS\Core\Resource\ResourceStorage::setDriver ( DriverInterface $driver )

Sets the storage that belongs to this storage.

Parameters

Driver\DriverInterface $driver

Returns: ‪ResourceStorage

Definition at line 290 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\$driver, and TYPO3\CMS\Core\Resource\ResourceStorage\$this.

Referenced by TYPO3\CMS\Core\Tests\Unit\Resource\ResourceStorageTest\checkFolderPermissionsRespectsFilesystemPermissions().

◆ setEvaluatePermissions()

TYPO3\CMS\Core\Resource\ResourceStorage::setEvaluatePermissions ( $evaluatePermissions )

Sets whether the permissions to access or write into this storage should be checked or not.

Parameters

bool $evaluatePermissions

Definition at line 632 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\$evaluatePermissions.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\getNestedProcessingFolder().

◆ setFileContents()

int TYPO3\CMS\Core\Resource\ResourceStorage::setFileContents	(	AbstractFile	$file,
			$contents
	)

Set contents of a file object.

Parameters

AbstractFile	$file
string	$contents

Exceptions

Definition at line 1813 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\assureFileWritePermissions(), TYPO3\CMS\Core\Resource\AbstractFile\getIdentifier(), TYPO3\CMS\Core\Resource\ResourceStorage\getIndexer(), and TYPO3\CMS\Core\Resource\Index\Indexer\updateIndexEntry().

Referenced by TYPO3\CMS\Core\Resource\File\setContents(), and TYPO3\CMS\Core\Resource\AbstractFile\setContents().

◆ setUserPermissions()

TYPO3\CMS\Core\Resource\ResourceStorage::setUserPermissions ( array $userPermissions )

Sets the user permissions of the storage.

Parameters

array $userPermissions

Definition at line 653 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\$userPermissions.

◆ streamFile()

ResponseInterface TYPO3\CMS\Core\Resource\ResourceStorage::streamFile	(	FileInterface	$file,
		bool	$asDownload = `false`,
		string	$alternativeFilename = `null`,
		string	$overrideMimeType = `null`
	)

Returns a PSR-7 Response which can be used to stream the requested file

Parameters

FileInterface	$file
bool	$asDownload	‪If set Content-Disposition attachment is sent, inline otherwise
string	$alternativeFilename	‪the filename for the download (if $asDownload is set)
string	$overrideMimeType	‪If set this will be used as Content-Type header instead of the automatically detected mime type.

Returns: ‪ResponseInterface

Definition at line 1752 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceInterface\getIdentifier(), and TYPO3\CMS\Core\Resource\ResourceStorage\getPseudoStream().

◆ unsetFileAndFolderNameFilters()

TYPO3\CMS\Core\Resource\ResourceStorage::unsetFileAndFolderNameFilters ( )

Unsets the file and folder name filters, thus making this storage return unfiltered filelists.

Definition at line 1494 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\fileAndFolderNameFilters.

◆ updateProcessedFile()

FileInterface TYPO3\CMS\Core\Resource\ResourceStorage::updateProcessedFile	(		$localFilePath,
		ProcessedFile	$processedFile,
		Folder	$processingFolder = `null`
	)

Updates a processed file with a new file from the local filesystem.

Parameters

string	$localFilePath
ProcessedFile	$processedFile
Folder	$processingFolder

Returns: ‪FileInterface

Exceptions

Definition at line 1298 of file ResourceStorage.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\$processingFolder, TYPO3\CMS\Core\Resource\Folder\getIdentifier(), TYPO3\CMS\Core\Resource\ProcessedFile\getName(), TYPO3\CMS\Core\Resource\ProcessedFile\getOriginalFile(), TYPO3\CMS\Core\Resource\ResourceStorage\getProcessingFolder(), and TYPO3\CMS\Core\Resource\AbstractFile\setIdentifier().

◆ usesCaseSensitiveIdentifiers()

bool TYPO3\CMS\Core\Resource\ResourceStorage::usesCaseSensitiveIdentifiers ( )

Returns TRUE if the identifiers used by this storage are case-sensitive.

Returns: ‪bool

Definition at line 438 of file ResourceStorage.php.

Member Data Documentation

◆ $capabilities

int TYPO3\CMS\Core\Resource\ResourceStorage::$capabilities

protected

The capabilities of this storage as defined in the storage record. Also see the CAPABILITY_* constants below

Definition at line 172 of file ResourceStorage.php.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\getCapabilities().

◆ $configuration

array TYPO3\CMS\Core\Resource\ResourceStorage::$configuration

protected

The configuration belonging to this storage (decoded from the configuration field).

Definition at line 139 of file ResourceStorage.php.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\getConfiguration(), TYPO3\CMS\Core\Resource\ResourceStorage\processFile(), and TYPO3\CMS\Core\Resource\ResourceStorage\setConfiguration().

◆ $driver

Driver DriverInterface TYPO3\CMS\Core\Resource\ResourceStorage::$driver

protected

The storage driver instance belonging to this storage.

Definition at line 127 of file ResourceStorage.php.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\__construct(), TYPO3\CMS\Core\Resource\ResourceStorage\getDriver(), and TYPO3\CMS\Core\Resource\ResourceStorage\setDriver().

◆ $evaluatePermissions

bool TYPO3\CMS\Core\Resource\ResourceStorage::$evaluatePermissions = false

protected

Whether to check if file or folder is in user mounts and the action is allowed for a user Default is FALSE so that resources are accessible for front end rendering or admins.

Definition at line 152 of file ResourceStorage.php.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\deleteFile(), TYPO3\CMS\Core\Resource\ResourceStorage\getEvaluatePermissions(), TYPO3\CMS\Core\Resource\ResourceStorage\getProcessingFolder(), and TYPO3\CMS\Core\Resource\ResourceStorage\setEvaluatePermissions().

◆ $eventDispatcher

EventDispatcherInterface TYPO3\CMS\Core\Resource\ResourceStorage::$eventDispatcher

protected

Definition at line 176 of file ResourceStorage.php.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\__construct().

◆ $fileAndFolderNameFilters

array TYPO3\CMS\Core\Resource\ResourceStorage::$fileAndFolderNameFilters = array( )

protected

The filters used for the files and folder names.

Definition at line 202 of file ResourceStorage.php.

◆ $fileMounts

array TYPO3\CMS\Core\Resource\ResourceStorage::$fileMounts = array( )

protected

User filemounts, added as an array, and used as filters

Definition at line 158 of file ResourceStorage.php.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\getFileMounts().

◆ $fileProcessingService

Service FileProcessingService TYPO3\CMS\Core\Resource\ResourceStorage::$fileProcessingService

protected

Definition at line 143 of file ResourceStorage.php.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\getFileProcessingService().

◆ $isDefault

bool TYPO3\CMS\Core\Resource\ResourceStorage::$isDefault = false

protected

Definition at line 196 of file ResourceStorage.php.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\isDefault(), and TYPO3\CMS\Core\Resource\ResourceStorage\setDefault().

◆ $isOnline

bool TYPO3\CMS\Core\Resource\ResourceStorage::$isOnline

protected

whether this storage is online or offline in this request

Definition at line 192 of file ResourceStorage.php.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\isOnline().

◆ $processingFolder

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

protected

Definition at line 180 of file ResourceStorage.php.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\getFoldersInFolder(), TYPO3\CMS\Core\Resource\ResourceStorage\getNestedProcessingFolder(), TYPO3\CMS\Core\Resource\ResourceStorage\getProcessingFolder(), TYPO3\CMS\Core\Resource\ResourceStorage\isProcessingFolder(), TYPO3\CMS\Core\Resource\ResourceStorage\isWithinProcessingFolder(), and TYPO3\CMS\Core\Resource\ResourceStorage\updateProcessedFile().

◆ $processingFolders

Folder [] TYPO3\CMS\Core\Resource\ResourceStorage::$processingFolders

protected

All processing folders of this storage used in any storage

Definition at line 186 of file ResourceStorage.php.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\getProcessingFolders().

◆ $storageRecord

array TYPO3\CMS\Core\Resource\ResourceStorage::$storageRecord

protected

The database record for this storage

Definition at line 133 of file ResourceStorage.php.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\__construct(), and TYPO3\CMS\Core\Resource\ResourceStorage\getStorageRecord().

◆ $this

return TYPO3\CMS\Core\Resource\ResourceStorage::$this

Definition at line 1537 of file ResourceStorage.php.

◆ $userPermissions

array TYPO3\CMS\Core\Resource\ResourceStorage::$userPermissions = array( )

protected

The file permissions of the user (and their group) merged together and available as an array

Definition at line 165 of file ResourceStorage.php.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\setUserPermissions().

◆ fileAndFolderNameFilters

array<int, function getImportExportFilter(): array { $filter = GeneralUtility::makeInstance(ImportExportFilter::class); return [$filter, 'filterImportExportFilesAndFolders']; } public array function getFileAndFolderNameFilters() { return array_merge($this->fileAndFolderNameFilters, [$this->getImportExportFilter()]); } public $this function setFileAndFolderNameFilters(array $filters) { $this-> TYPO3\CMS\Core\Resource\ResourceStorage::fileAndFolderNameFilters = $filters

Returns a filter for files generated by EXT:impexp

Returns: ‪array<int, ImportExportFilter|string>

Definition at line 1536 of file ResourceStorage.php.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\addFileAndFolderNameFilter(), TYPO3\CMS\Core\Resource\ResourceStorage\resetFileAndFolderNameFiltersToDefault(), and TYPO3\CMS\Core\Resource\ResourceStorage\unsetFileAndFolderNameFilters().

◆ PROCESSING_FOLDER_LEVELS

const TYPO3\CMS\Core\Resource\ResourceStorage::PROCESSING_FOLDER_LEVELS = 2

Levels numbers used to generate hashed subfolders in the processing folder

Definition at line 207 of file ResourceStorage.php.

Referenced by TYPO3\CMS\Core\Tests\Functional\Resource\ResourceStorageTest\getNestedProcessingFolderTest().

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addFile()

◆ addFileAndFolderNameFilter()

◆ addFileMount()

◆ addUploadedFile()

◆ assureFileAddPermissions()

◆ assureFileCopyPermissions()

◆ assureFileDeletePermissions()

◆ assureFileMovePermissions()

◆ assureFileReadPermission()

◆ assureFileRenamePermissions()

◆ assureFileReplacePermissions()

◆ assureFileUploadPermissions()

◆ assureFileWritePermissions()

◆ assureFolderCopyPermissions()

◆ assureFolderDeletePermission()

◆ assureFolderMovePermissions()

◆ assureFolderReadPermission()

◆ autoExtractMetadataEnabled()

◆ checkFileActionPermission()

◆ checkFileAndFolderNameFilters()

◆ checkFileExtensionPermission()

◆ checkFolderActionPermission()

◆ checkUserActionPermission()

◆ copyFile()

◆ copyFolder()

◆ copyFolderBetweenStorages()

◆ countFilesInFolder()

◆ countFoldersInFolder()

◆ createFile()

◆ createFolder()

◆ deleteFile()

◆ deleteFolder()

◆ getAllFileObjectsInFolder()

◆ getBackendUser()

◆ getCapabilities()

◆ getConfiguration()

◆ getDefaultFolder()

◆ getDriver()

◆ getDriverType()

◆ getEvaluatePermissions()

◆ getFile()

◆ getFileContents()

◆ getFileFactory()

◆ getFileForLocalProcessing()

◆ getFileIdentifiersInFolder()

◆ getFileIndexRepository()

◆ getFileInfo()

◆ getFileInfoByIdentifier()

◆ getFileInFolder()

◆ getFileMounts()

◆ getFileProcessingService()

◆ getFilesInFolder()

◆ getFolder()

◆ getFolderIdentifierFromFileIdentifier()

◆ getFolderIdentifiersInFolder()

◆ getFolderInfo()

◆ getFolderInFolder()

◆ getFoldersInFolder()

◆ getIndexer()

◆ getName()

◆ getNamesForNestedProcessingFolder()

◆ getNearestRecyclerFolder()

◆ getNestedProcessingFolder()

◆ getProcessingFolder()

◆ getProcessingFolders()

◆ getPseudoStream()

◆ getPublicUrl()

◆ getResourceFactoryInstance()

◆ getRole()

◆ getRootLevelFolder()

◆ getStorageRecord()

◆ getUid()