Inheritance diagram for ResourceStorage:

Public Member Functions
	__construct (Driver\DriverInterface $driver, array $storageRecord)

	getConfiguration ()

	setConfiguration (array $configuration)

	getStorageRecord ()

	setDriver (Driver\DriverInterface $driver)

	getName ()

	getUid ()

	hasChildren ()

	getCapabilities ()

	isPublic ()

	isWritable ()

	isBrowsable ()

	usesCaseSensitiveIdentifiers ()

	isOnline ()

	autoExtractMetadataEnabled ()

	markAsPermanentlyOffline ()

	markAsTemporaryOffline ()

	addFileMount ($folderIdentifier, $additionalData=array())

	getFileMounts ()

	isWithinFileMountBoundaries ($subject, $checkWriteAccess=false)

	setEvaluatePermissions ($evaluatePermissions)

	getEvaluatePermissions ()

	setUserPermissions (array $userPermissions)

	checkUserActionPermission ($action, $type)

	checkFileActionPermission ($action, FileInterface $file)

	checkFolderActionPermission ($action, Folder $folder=null)

	sanitizeFileName ($fileName, Folder $targetFolder=null)

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

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

	hashFile (FileInterface $fileObject, $hash)

	hashFileByIdentifier ($fileIdentifier, $hash)

	getPublicUrl (ResourceInterface $resourceObject, $relativeToCurrentScript=false)

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

	getFileForLocalProcessing (FileInterface $fileObject, $writable=true)

	getFile ($identifier)

	getFileInfo (FileInterface $fileObject)

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

	unsetFileAndFolderNameFilters ()

	resetFileAndFolderNameFiltersToDefault ()

	getFileAndFolderNameFilters ()

	setFileAndFolderNameFilters (array $filters)

	addFileAndFolderNameFilter ($filter)

	getFolderIdentifierFromFileIdentifier ($fileIdentifier)

	getFileInFolder ($fileName, Folder $folder)

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

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

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

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

	hasFile ($identifier)

	isProcessingFolder (Folder $folder)

	hasFileInFolder ($fileName, Folder $folder)

	getFileContents ($file)

	dumpFileContents (FileInterface $file, $asDownload=false, $alternativeFilename=null, $overrideMimeType=null)

	setFileContents (AbstractFile $file, $contents)

	createFile ($fileName, Folder $targetFolderObject)

	deleteFile ($fileObject)

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

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

	renameFile ($file, $targetFileName)

	replaceFile (FileInterface $file, $localFilePath)

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

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

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

	renameFolder ($folderObject, $newName)

	deleteFolder ($folderObject, $deleteRecursively=false)

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

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

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

	hasFolder ($identifier)

	hasFolderInFolder ($folderName, Folder $folder)

	createFolder ($folderName, Folder $parentFolder=null)

	getDefaultFolder ()

	getFolder ($identifier, $returnInaccessibleFolderObject=false)

	isWithinProcessingFolder ($identifier)

	isWithinFolder (Folder $folder, ResourceInterface $resource)

	getRootLevelFolder ($respectFileMounts=true)

	getRole (FolderInterface $folder)

	getProcessingFolder ()

	getDriverType ()

	setDefault ($isDefault)

	isDefault ()

Protected Member Functions
	getDriver ()

	hasCapability ($capability)

	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)

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

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

	emitSanitizeFileNameSignal ($fileName, Folder $targetFolder)

	emitPreFileAddSignal ($targetFileName, Folder $targetFolder, $sourceFilePath)

	emitPostFileAddSignal (FileInterface $file, Folder $targetFolder)

	emitPreFileCopySignal (FileInterface $file, Folder $targetFolder)

	emitPostFileCopySignal (FileInterface $file, Folder $targetFolder)

	emitPreFileMoveSignal (FileInterface $file, Folder $targetFolder)

	emitPostFileMoveSignal (FileInterface $file, Folder $targetFolder, Folder $originalFolder)

	emitPreFileRenameSignal (FileInterface $file, $targetFolder)

	emitPostFileRenameSignal (FileInterface $file, $targetFolder)

	emitPreFileReplaceSignal (FileInterface $file, $localFilePath)

	emitPostFileReplaceSignal (FileInterface $file, $localFilePath)

	emitPostFileCreateSignal ($newFileIdentifier, Folder $targetFolder)

	emitPreFileDeleteSignal (FileInterface $file)

	emitPostFileDeleteSignal (FileInterface $file)

	emitPostFileSetContentsSignal (FileInterface $file, $content)

	emitPreFolderAddSignal (Folder $targetFolder, $name)

	emitPostFolderAddSignal (Folder $folder)

	emitPreFolderCopySignal (Folder $folder, Folder $targetFolder, $newName)

	emitPostFolderCopySignal (Folder $folder, Folder $targetFolder, $newName)

	emitPreFolderMoveSignal (Folder $folder, Folder $targetFolder, $newName)

	emitPostFolderMoveSignal (Folder $folder, Folder $targetFolder, $newName, Folder $originalFolder)

	emitPreFolderRenameSignal (Folder $folder, $newName)

	emitPostFolderRenameSignal (Folder $folder, $newName)

	emitPreFolderDeleteSignal (Folder $folder)

	emitPostFolderDeleteSignal (Folder $folder)

	emitPreGeneratePublicUrlSignal (ResourceInterface $resourceObject, $relativeToCurrentScript, array $urlData)

	getUniqueName (Folder $folder, $theFile, $dontCheckForUnique=false)

	getSignalSlotDispatcher ()

	getObjectManager ()

	getFileFactory ()

	getFileIndexRepository ()

	getFileProcessingService ()

	getIndexer ()

Protected Attributes
	$driver

	$storageRecord

	$configuration

	$fileProcessingService

	$evaluatePermissions = false

	$fileMounts = array()

	$userPermissions = array()

	$capabilities

	$signalSlotDispatcher

	$processingFolder

	$processingFolders

	$isOnline = null

	$isDefault = false

	$fileAndFolderNameFilters = array()

Additional Inherited Members
Public Attributes inherited from ResourceStorageInterface
const	SIGNAL_SanitizeFileName = 'sanitizeFileName'

const	SIGNAL_PreFileAdd = 'preFileAdd'

const	SIGNAL_PostFileAdd = 'postFileAdd'

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_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	DEFAULT_ProcessingFolder = '_processed_'

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 56 of file ResourceStorage.php.

Constructor & Destructor Documentation

__construct	(	Driver\DriverInterface	$driver,
		array	$storageRecord
	)

Constructor for a storage object.

Parameters

Driver\DriverInterface	$driver
array	$storageRecord	The storage record row from the database

Definition at line 159 of file ResourceStorage.php.

References ResourceStorage\$driver, ResourceStorage\$storageRecord, ResourceFactory\getInstance(), ResourceStorage\isDefault(), ResourceStorage\markAsPermanentlyOffline(), and ResourceStorage\resetFileAndFolderNameFiltersToDefault().

Member Function Documentation

addFile	(		$localFilePath,
		Folder	$targetFolder,
			$targetFileName = `''`,
			$conflictMode = `DuplicationBehavior::RENAME`
	)

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 enumeration

Exceptions

\InvalidArgumentException
Exception\ExistingTargetFileNameException

Returns: FileInterface

Definition at line 1152 of file ResourceStorage.php.

References ResourceStorage\assureFileAddPermissions(), ResourceStorage\autoExtractMetadataEnabled(), PathUtility\basename(), DuplicationBehavior\CANCEL, Enumeration\cast(), elseif, ResourceStorage\emitPostFileAddSignal(), ResourceStorage\emitPreFileAddSignal(), PathUtility\getCanonicalPath(), ResourceStorage\getDefaultFolder(), Folder\getIdentifier(), ResourceFactory\getInstance(), ResourceStorage\getUid(), ResourceStorage\getUniqueName(), GeneralUtility\makeInstance(), DuplicationBehavior\RENAME, and ResourceStorage\sanitizeFileName().

Referenced by ResourceStorage\addUploadedFile().

addFileAndFolderNameFilter ( $filter )

Parameters

array $filter

Definition at line 1425 of file ResourceStorage.php.

addFileMount	(	$folderIdentifier,
		$additionalData = `array()`
	)

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\FolderDoesNotExistException

Returns: void

Definition at line 428 of file ResourceStorage.php.

References ResourceFactory\getInstance().

Referenced by StoragePermissionsAspect\addFileMountsToStorage().

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

Adds an uploaded file into the Storage. Previously in ::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 enumeration

Returns: FileInterface The file object

Definition at line 1915 of file ResourceStorage.php.

References ResourceStorage\addFile(), ResourceStorage\assureFileUploadPermissions(), Enumeration\cast(), ResourceStorage\getDefaultFolder(), ResourceStorage\getFileInFolder(), ResourceStorage\hasFileInFolder(), DuplicationBehavior\REPLACE, and ResourceStorage\replaceFile().

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

Returns: void

Exceptions

Exception\InsufficientFolderWritePermissionsException
Exception\IllegalFileExtensionException
Exception\InsufficientUserPermissionsException

Definition at line 895 of file ResourceStorage.php.

References ResourceStorage\checkFileExtensionPermission(), ResourceStorage\checkFolderActionPermission(), ResourceStorage\checkUserActionPermission(), and ResourceStorage\getUid().

Referenced by ResourceStorage\addFile(), ResourceStorage\assureFileUploadPermissions(), and ResourceStorage\createFile().

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\InsufficientFolderWritePermissionsException
Exception\IllegalFileExtensionException
Exception\InsufficientFileReadPermissionsException
Exception\InsufficientUserPermissionsException

Returns: void

Definition at line 1019 of file ResourceStorage.php.

References ResourceStorage\checkFileExtensionPermission(), ResourceStorage\checkFolderActionPermission(), ResourceInterface\getIdentifier(), Folder\getIdentifier(), ResourceInterface\getName(), ResourceInterface\getStorage(), Folder\getStorage(), and ResourceStorage\getUid().

assureFileDeletePermissions ( FileInterface $file )

protected

Assures delete permission for given file.

Parameters

FileInterface $file

Returns: void

Exceptions

Exception\IllegalFileExtensionException
Exception\InsufficientFileWritePermissionsException
Exception\InsufficientFolderWritePermissionsException

Definition at line 862 of file ResourceStorage.php.

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

Referenced by ResourceStorage\deleteFile().

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

protected

Checks for permissions to move a file.

Exceptions

\RuntimeException
Exception\InsufficientFolderAccessPermissionsException
Exception\InsufficientUserPermissionsException
Exception\IllegalFileExtensionException

Parameters

FileInterface	$file
Folder	$targetFolder
string	$targetFileName

Returns: void

Definition at line 954 of file ResourceStorage.php.

References ResourceStorage\checkFileExtensionPermission(), ResourceStorage\checkFolderActionPermission(), Folder\getIdentifier(), ResourceInterface\getStorage(), Folder\getStorage(), and ResourceStorage\getUid().

Referenced by ResourceStorage\moveFile().

assureFileReadPermission ( FileInterface $file )

protected

Assures read permission for given file.

Parameters

FileInterface $file

Returns: void

Exceptions

Exception\InsufficientFileAccessPermissionsException
Exception\IllegalFileExtensionException

Definition at line 797 of file ResourceStorage.php.

References ResourceStorage\checkFileActionPermission(), ResourceStorage\checkFileExtensionPermission(), and ResourceInterface\getName().

Referenced by ResourceStorage\getFileContents().

assureFileRenamePermissions	(	FileInterface	$file,
			$targetFileName
	)

protected

Checks for permissions to rename a file.

Parameters

FileInterface	$file
string	$targetFileName

Exceptions

Exception\InsufficientFileWritePermissionsException
Exception\IllegalFileExtensionException
Exception\InsufficientFileReadPermissionsException
Exception\InsufficientUserPermissionsException

Returns: void

Definition at line 985 of file ResourceStorage.php.

References ResourceStorage\checkFileActionPermission(), ResourceStorage\checkFileExtensionPermission(), ResourceStorage\checkFolderActionPermission(), and ResourceInterface\getName().

Referenced by ResourceStorage\renameFile().

assureFileReplacePermissions ( FileInterface $file )

protected

Assure replace permission for given file.

Parameters

FileInterface $file

Returns: void

Exceptions

Exception\InsufficientFileWritePermissionsException
Exception\InsufficientFolderWritePermissionsException

Definition at line 841 of file ResourceStorage.php.

References ResourceStorage\checkFileActionPermission(), ResourceStorage\checkFolderActionPermission(), ResourceInterface\getIdentifier(), and ResourceInterface\getParentFolder().

Referenced by ResourceStorage\replaceFile().

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

Returns: void

Exceptions

Exception\InsufficientFolderWritePermissionsException
Exception\UploadException
Exception\IllegalFileExtensionException
Exception\UploadSizeException
Exception\InsufficientUserPermissionsException

Definition at line 927 of file ResourceStorage.php.

References ResourceStorage\assureFileAddPermissions(), and GeneralUtility\getMaxUploadFileSize().

Referenced by ResourceStorage\addUploadedFile().

assureFileWritePermissions ( FileInterface $file )

protected

Assures write permission for given file.

Parameters

FileInterface $file

Returns: void

Exceptions

Exception\IllegalFileExtensionException
Exception\InsufficientFileWritePermissionsException
Exception\InsufficientUserPermissionsException

Definition at line 822 of file ResourceStorage.php.

References ResourceStorage\checkFileActionPermission(), ResourceStorage\checkFileExtensionPermission(), FileInterface\getExtension(), ResourceInterface\getIdentifier(), and ResourceInterface\getName().

Referenced by ResourceStorage\setFileContents().

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

Returns: void

Exceptions

Exception
Exception\InsufficientFolderWritePermissionsException
Exception\IllegalFileExtensionException
Exception\InsufficientFileReadPermissionsException
Exception\InsufficientUserPermissionsException
\RuntimeException

Definition at line 1054 of file ResourceStorage.php.

References ResourceStorage\checkFolderActionPermission(), ResourceInterface\getIdentifier(), ResourceInterface\getStorage(), and ResourceStorage\getUid().

Referenced by ResourceStorage\copyFolder().

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

Returns: void

Exceptions

Exception\InsufficientFolderAccessPermissionsException
Exception\InsufficientFolderWritePermissionsException
Exception\InsufficientUserPermissionsException

Definition at line 768 of file ResourceStorage.php.

References ResourceStorage\checkFolderActionPermission(), ResourceStorage\checkUserActionPermission(), and Folder\getName().

Referenced by ResourceStorage\deleteFolder().

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

\InvalidArgumentException
Exception\InsufficientFolderWritePermissionsException
Exception\IllegalFileExtensionException
Exception\InsufficientFileReadPermissionsException
Exception\InsufficientUserPermissionsException
\RuntimeException

Returns: void

Definition at line 1091 of file ResourceStorage.php.

References ResourceStorage\checkFolderActionPermission(), ResourceInterface\getIdentifier(), ResourceInterface\getStorage(), and ResourceStorage\getUid().

Referenced by ResourceStorage\moveFolder().

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.

Returns: void

Exceptions

Exception\InsufficientFolderAccessPermissionsException

Definition at line 741 of file ResourceStorage.php.

References ResourceStorage\checkFolderActionPermission().

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

autoExtractMetadataEnabled ( )

Returns TRUE if auto extracting of metadata is enabled

Returns: bool

Definition at line 375 of file ResourceStorage.php.

Referenced by ResourceStorage\addFile(), and ResourceStorage\replaceFile().

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
FileInterface	$file

Returns: bool

Definition at line 583 of file ResourceStorage.php.

References ResourceStorage\checkFileExtensionPermission(), ResourceStorage\checkUserActionPermission(), ResourceInterface\getIdentifier(), ResourceInterface\getName(), ResourceStorage\isWithinFileMountBoundaries(), and ResourceStorage\isWritable().

Referenced by ResourceStorage\assureFileDeletePermissions(), ResourceStorage\assureFileReadPermission(), ResourceStorage\assureFileRenamePermissions(), ResourceStorage\assureFileReplacePermissions(), and ResourceStorage\assureFileWritePermissions().

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 697 of file ResourceStorage.php.

References $GLOBALS, GeneralUtility\inList(), PathUtility\pathinfo(), GeneralUtility\uniqueList(), and GeneralUtility\verifyFilenameAgainstDenyPattern().

Referenced by ResourceStorage\assureFileAddPermissions(), ResourceStorage\assureFileCopyPermissions(), ResourceStorage\assureFileDeletePermissions(), ResourceStorage\assureFileMovePermissions(), ResourceStorage\assureFileReadPermission(), ResourceStorage\assureFileRenamePermissions(), ResourceStorage\assureFileWritePermissions(), ResourceStorage\checkFileActionPermission(), and ResourceStorage\replaceFile().

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 646 of file ResourceStorage.php.

References ResourceStorage\checkUserActionPermission(), ResourceStorage\isBrowsable(), ResourceStorage\isWithinFileMountBoundaries(), and ResourceStorage\isWritable().

Referenced by ResourceStorage\assureFileAddPermissions(), ResourceStorage\assureFileCopyPermissions(), ResourceStorage\assureFileMovePermissions(), ResourceStorage\assureFileRenamePermissions(), ResourceStorage\assureFileReplacePermissions(), ResourceStorage\assureFolderCopyPermissions(), ResourceStorage\assureFolderDeletePermission(), ResourceStorage\assureFolderMovePermissions(), ResourceStorage\assureFolderReadPermission(), ResourceStorage\createFolder(), and ResourceStorage\renameFolder().

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 556 of file ResourceStorage.php.

Referenced by ResourceStorage\assureFileAddPermissions(), ResourceStorage\assureFileDeletePermissions(), ResourceStorage\assureFolderDeletePermission(), ResourceStorage\checkFileActionPermission(), and ResourceStorage\checkFolderActionPermission().

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

Previously in ::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 enumeration

Exceptions

\Exception\|Exception\AbstractFileOperationException
Exception\ExistingTargetFileNameException

Returns: FileInterface

Definition at line 1745 of file ResourceStorage.php.

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 enumeration

Returns: Folder The new (copied) folder object

Exceptions

InvalidTargetFolderException

Definition at line 2041 of file ResourceStorage.php.

References ResourceStorage\assureFolderCopyPermissions(), ResourceStorage\copyFolderBetweenStorages(), ResourceStorage\emitPostFolderCopySignal(), ResourceStorage\emitPreFolderCopySignal(), ResourceStorage\getFolder(), ResourceInterface\getIdentifier(), ResourceInterface\getName(), ResourceInterface\getStorage(), FolderInterface\getSubfolder(), and ResourceStorage\isWithinFolder().

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

protected

Copies a folder between storages.

Parameters

Folder	$folderToCopy
Folder	$targetParentFolder
string	$newFolderName

Returns: bool

Exceptions

\RuntimeException

Definition at line 2083 of file ResourceStorage.php.

Referenced by ResourceStorage\copyFolder().

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

Parameters

Folder	$folder
bool	$useFilters
bool	$recursive

Returns: int Number of files in folder

Exceptions

Exception\InsufficientFolderAccessPermissionsException

Definition at line 1515 of file ResourceStorage.php.

References ResourceStorage\assureFolderReadPermission(), and Folder\getIdentifier().

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

Parameters

Folder	$folder
bool	$useFilters
bool	$recursive

Returns: int Number of subfolders

Exceptions

Exception\InsufficientFolderAccessPermissionsException

Definition at line 2219 of file ResourceStorage.php.

References ResourceStorage\assureFolderReadPermission(), and Folder\getIdentifier().

createFile	(		$fileName,
		Folder	$targetFolderObject
	)

Creates a new file

previously in ::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\IllegalFileExtensionException
Exception\InsufficientFolderWritePermissionsException

Returns: FileInterface The file object

Definition at line 1693 of file ResourceStorage.php.

References ResourceStorage\assureFileAddPermissions(), ResourceStorage\emitPostFileCreateSignal(), Folder\getIdentifier(), ResourceFactory\getInstance(), and ResourceStorage\getUid().

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

Creates a new folder.

previously in ::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\ExistingTargetFolderException
Exception\InsufficientFolderAccessPermissionsException
Exception\InsufficientFolderWritePermissionsException
\Exception

Definition at line 2264 of file ResourceStorage.php.

References ResourceStorage\checkFolderActionPermission(), elseif, ResourceStorage\emitPostFolderAddSignal(), ResourceStorage\emitPreFolderAddSignal(), ResourceStorage\getDriver(), ResourceStorage\getFolder(), and ResourceStorage\getRootLevelFolder().

Referenced by ResourceStorage\getProcessingFolder().

deleteFile ( $fileObject )

Previously in ::deleteFile()

Parameters

$fileObject FileInterface

Exceptions

Exception\InsufficientFileAccessPermissionsException
Exception\FileOperationErrorException

Returns: bool TRUE if deletion succeeded

Definition at line 1709 of file ResourceStorage.php.

References ResourceStorage\assureFileDeletePermissions(), and ResourceStorage\emitPreFileDeleteSignal().

Referenced by ResourceStorage\deleteFolder().

deleteFolder	(	$folderObject,
		$deleteRecursively = `false`
	)

Previously in ::folder_delete()

Parameters

Folder	$folderObject
bool	$deleteRecursively

Exceptions

\RuntimeException
Exception\InsufficientFolderAccessPermissionsException
Exception\InsufficientUserPermissionsException
Exception\FileOperationErrorException
Exception\InvalidPathException

Returns: bool

Definition at line 2141 of file ResourceStorage.php.

References ResourceStorage\assureFolderDeletePermission(), ResourceStorage\deleteFile(), ResourceStorage\emitPostFolderDeleteSignal(), ResourceStorage\emitPreFolderDeleteSignal(), and ResourceStorage\getFilesInFolder().

dumpFileContents	(	FileInterface	$file,
			$asDownload = `false`,
			$alternativeFilename = `null`,
			$overrideMimeType = `null`
	)

Outputs file Contents, clears output buffer first and sends headers accordingly.

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: void

Definition at line 1635 of file ResourceStorage.php.

References ResourceInterface\getIdentifier(), FileInterface\getMimeType(), ResourceInterface\getName(), and FileInterface\getSize().

emitPostFileAddSignal	(	FileInterface	$file,
		Folder	$targetFolder
	)

protected

Emits the file post-add signal.

Parameters

FileInterface	$file
Folder	$targetFolder

Returns: void

Definition at line 2421 of file ResourceStorage.php.

References ResourceStorage\getSignalSlotDispatcher().

Referenced by ResourceStorage\addFile().

emitPostFileCopySignal	(	FileInterface	$file,
		Folder	$targetFolder
	)

protected

Emits the file post-copy signal.

Parameters

FileInterface	$file
Folder	$targetFolder

Returns: void

Definition at line 2445 of file ResourceStorage.php.

References ResourceStorage\getSignalSlotDispatcher().

emitPostFileCreateSignal	(		$newFileIdentifier,
		Folder	$targetFolder
	)

protected

Emits the file post-create signal

Parameters

string	$newFileIdentifier
Folder	$targetFolder

Definition at line 2529 of file ResourceStorage.php.

References ResourceStorage\getSignalSlotDispatcher().

Referenced by ResourceStorage\createFile().

emitPostFileDeleteSignal ( FileInterface $file )

protected

Emits the file post-deletion signal

Parameters

FileInterface $file

Returns: void

Definition at line 2551 of file ResourceStorage.php.

References ResourceStorage\getSignalSlotDispatcher().

emitPostFileMoveSignal	(	FileInterface	$file,
		Folder	$targetFolder,
		Folder	$originalFolder
	)

protected

Emits the file post-move signal.

Parameters

FileInterface	$file
Folder	$targetFolder
Folder	$originalFolder

Returns: void

Definition at line 2470 of file ResourceStorage.php.

References ResourceStorage\getSignalSlotDispatcher().

Referenced by ResourceStorage\moveFile().

emitPostFileRenameSignal	(	FileInterface	$file,
			$targetFolder
	)

protected

Emits the file post-rename signal.

Parameters

FileInterface	$file
	$targetFolder

Returns: void

Definition at line 2494 of file ResourceStorage.php.

References ResourceStorage\getSignalSlotDispatcher().

Referenced by ResourceStorage\renameFile().

emitPostFileReplaceSignal	(	FileInterface	$file,
			$localFilePath
	)

protected

Emits the file post-replace signal

Parameters

FileInterface	$file
string	$localFilePath

Returns: void

Definition at line 2518 of file ResourceStorage.php.

References ResourceStorage\getSignalSlotDispatcher().

Referenced by ResourceStorage\replaceFile().

emitPostFileSetContentsSignal	(	FileInterface	$file,
			$content
	)

protected

Emits the file post-set-contents signal

Parameters

FileInterface	$file
mixed	$content

Returns: void

Definition at line 2563 of file ResourceStorage.php.

References ResourceStorage\getSignalSlotDispatcher().

Referenced by ResourceStorage\setFileContents().

emitPostFolderAddSignal ( Folder $folder )

protected

Emits the folder post-add signal.

Parameters

Folder $folder

Returns: void

Definition at line 2586 of file ResourceStorage.php.

References ResourceStorage\getSignalSlotDispatcher().

Referenced by ResourceStorage\createFolder().

emitPostFolderCopySignal	(	Folder	$folder,
		Folder	$targetFolder,
			$newName
	)

protected

Emits the folder post-copy signal.

Parameters

Folder	$folder
Folder	$targetFolder
	$newName

Returns: void

Definition at line 2612 of file ResourceStorage.php.

References ResourceStorage\getSignalSlotDispatcher().

Referenced by ResourceStorage\copyFolder().

emitPostFolderDeleteSignal ( Folder $folder )

protected

Emits folder post-deletion signal..

Parameters

Folder $folder

Returns: void

Definition at line 2685 of file ResourceStorage.php.

References ResourceStorage\getSignalSlotDispatcher().

Referenced by ResourceStorage\deleteFolder().

emitPostFolderMoveSignal	(	Folder	$folder,
		Folder	$targetFolder,
			$newName,
		Folder	$originalFolder
	)

protected

Emits the folder post-move signal.

Parameters

Folder	$folder
Folder	$targetFolder
	$newName
Folder	$originalFolder

Returns: void

Definition at line 2639 of file ResourceStorage.php.

References ResourceStorage\getSignalSlotDispatcher().

Referenced by ResourceStorage\moveFolder().

emitPostFolderRenameSignal	(	Folder	$folder,
			$newName
	)

protected

Emits the folder post-rename signal.

Parameters

Folder	$folder
	$newName

Returns: void

Definition at line 2663 of file ResourceStorage.php.

References ResourceStorage\getSignalSlotDispatcher().

Referenced by ResourceStorage\renameFolder().

emitPreFileAddSignal	(		$targetFileName,
		Folder	$targetFolder,
			$sourceFilePath
	)

protected

Emits file pre-add signal.

Parameters

string	$targetFileName
Folder	$targetFolder
string	$sourceFilePath

Returns: string Modified target file name

Definition at line 2408 of file ResourceStorage.php.

References ResourceStorage\getSignalSlotDispatcher().

Referenced by ResourceStorage\addFile().

emitPreFileCopySignal	(	FileInterface	$file,
		Folder	$targetFolder
	)

protected

Emits file pre-copy signal.

Parameters

FileInterface	$file
Folder	$targetFolder

Returns: void

Definition at line 2433 of file ResourceStorage.php.

References ResourceStorage\getSignalSlotDispatcher().

emitPreFileDeleteSignal ( FileInterface $file )

protected

Emits the file pre-deletion signal.

Parameters

FileInterface $file

Returns: void

Definition at line 2540 of file ResourceStorage.php.

References ResourceStorage\getSignalSlotDispatcher().

Referenced by ResourceStorage\deleteFile().

emitPreFileMoveSignal	(	FileInterface	$file,
		Folder	$targetFolder
	)

protected

Emits the file pre-move signal.

Parameters

FileInterface	$file
Folder	$targetFolder

Returns: void

Definition at line 2457 of file ResourceStorage.php.

References ResourceStorage\getSignalSlotDispatcher().

Referenced by ResourceStorage\moveFile().

emitPreFileRenameSignal	(	FileInterface	$file,
			$targetFolder
	)

protected

Emits the file pre-rename signal

Parameters

FileInterface	$file
	$targetFolder

Returns: void

Definition at line 2482 of file ResourceStorage.php.

References ResourceStorage\getSignalSlotDispatcher().

Referenced by ResourceStorage\renameFile().

emitPreFileReplaceSignal	(	FileInterface	$file,
			$localFilePath
	)

protected

Emits the file pre-replace signal.

Parameters

FileInterface	$file
	$localFilePath

Returns: void

Definition at line 2506 of file ResourceStorage.php.

References ResourceStorage\getSignalSlotDispatcher().

Referenced by ResourceStorage\replaceFile().

emitPreFolderAddSignal	(	Folder	$targetFolder,
			$name
	)

protected

Emits the folder pre-add signal.

Parameters

Folder	$targetFolder
string	$name

Returns: void

Definition at line 2575 of file ResourceStorage.php.

References ResourceStorage\getSignalSlotDispatcher().

Referenced by ResourceStorage\createFolder().

emitPreFolderCopySignal	(	Folder	$folder,
		Folder	$targetFolder,
			$newName
	)

protected

Emits the folder pre-copy signal.

Parameters

Folder	$folder
Folder	$targetFolder
	$newName

Returns: void

Definition at line 2599 of file ResourceStorage.php.

References ResourceStorage\getSignalSlotDispatcher().

Referenced by ResourceStorage\copyFolder().

emitPreFolderDeleteSignal ( Folder $folder )

protected

Emits the folder pre-deletion signal.

Parameters

Folder $folder

Returns: void

Definition at line 2674 of file ResourceStorage.php.

References ResourceStorage\getSignalSlotDispatcher().

Referenced by ResourceStorage\deleteFolder().

emitPreFolderMoveSignal	(	Folder	$folder,
		Folder	$targetFolder,
			$newName
	)

protected

Emits the folder pre-move signal.

Parameters

Folder	$folder
Folder	$targetFolder
	$newName

Returns: void

Definition at line 2625 of file ResourceStorage.php.

References ResourceStorage\getSignalSlotDispatcher().

Referenced by ResourceStorage\moveFolder().

emitPreFolderRenameSignal	(	Folder	$folder,
			$newName
	)

protected

Emits the folder pre-rename signal.

Parameters

Folder	$folder
	$newName

Returns: void

Definition at line 2651 of file ResourceStorage.php.

References ResourceStorage\getSignalSlotDispatcher().

Referenced by ResourceStorage\renameFolder().

emitPreGeneratePublicUrlSignal	(	ResourceInterface	$resourceObject,
			$relativeToCurrentScript,
		array	$urlData
	)

protected

Emits file pre-processing signal when generating a public url for a file or folder.

Parameters

ResourceInterface	$resourceObject
bool	$relativeToCurrentScript
array	$urlData

Definition at line 2697 of file ResourceStorage.php.

References ResourceStorage\getSignalSlotDispatcher().

Referenced by ResourceStorage\getPublicUrl().

emitSanitizeFileNameSignal	(		$fileName,
		Folder	$targetFolder
	)

protected

Emits sanitize fileName signal.

Parameters

string	$fileName
Folder	$targetFolder

Returns: string Modified target file name

Definition at line 2394 of file ResourceStorage.php.

References ResourceStorage\getSignalSlotDispatcher().

Referenced by ResourceStorage\sanitizeFileName().

getCapabilities ( )

Returns the capabilities of this storage.

Returns: int

See Also: CAPABILITY_* constants

Definition at line 276 of file ResourceStorage.php.

References ResourceStorage\$capabilities.

getConfiguration ( )

Gets the configuration.

Returns: array

Definition at line 190 of file ResourceStorage.php.

References ResourceStorage\$configuration.

getDefaultFolder ( )

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

Returns: Folder

Definition at line 2293 of file ResourceStorage.php.

References ResourceStorage\getFolder().

Referenced by ResourceStorage\addFile(), ResourceStorage\addUploadedFile(), and ResourceStorage\sanitizeFileName().

getDriver ( )

protected

Returns the driver object belonging to this storage.

Returns: Driver

Definition at line 232 of file ResourceStorage.php.

References ResourceStorage\$driver.

Referenced by ResourceStorage\createFolder().

getDriverType ( )

Gets the driver Type configured for this storage.

Returns: string

Definition at line 2877 of file ResourceStorage.php.

getEvaluatePermissions ( )

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

Returns: bool $evaluatePermissions

Definition at line 532 of file ResourceStorage.php.

References ResourceStorage\$evaluatePermissions.

getFile ( $identifier )

Gets a file by identifier.

Parameters

string $identifier

Returns: FileInterface

Definition at line 1348 of file ResourceStorage.php.

References ResourceStorage\getFileFactory(), and ResourceStorage\getUid().

getFileAndFolderNameFilters ( )

Returns the file and folder name filters used by this storage.

Returns: array

Definition at line 1407 of file ResourceStorage.php.

References ResourceStorage\$fileAndFolderNameFilters.

getFileContents ( $file )

Get contents of a file object

Parameters

FileInterface $file

Exceptions

Exception\InsufficientFileReadPermissionsException

Returns: string

Definition at line 1619 of file ResourceStorage.php.

References ResourceStorage\assureFileReadPermission().

getFileFactory ( )

protected

Returns: ResourceFactory

Definition at line 2781 of file ResourceStorage.php.

References GeneralUtility\makeInstance().

Referenced by ResourceStorage\getFile(), ResourceStorage\getFileInFolder(), and ResourceStorage\getFilesInFolder().

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 1336 of file ResourceStorage.php.

References ResourceInterface\getIdentifier().

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

Parameters

string	$folderIdentifier
bool	$useFilters
bool	$recursive

Returns: array

Definition at line 1502 of file ResourceStorage.php.

getFileIndexRepository ( )

protected

Returns

Definition at line 2789 of file ResourceStorage.php.

References FileIndexRepository\getInstance().

Referenced by ResourceStorage\getFilesInFolder().

getFileInfo ( FileInterface $fileObject )

Gets information about a file.

Parameters

FileInterface $fileObject

Returns: array

Definition at line 1364 of file ResourceStorage.php.

References ResourceStorage\getFileInfoByIdentifier(), and ResourceInterface\getIdentifier().

getFileInfoByIdentifier	(		$identifier,
		array	$propertiesToExtract = `array()`
	)

Gets information about a file by its identifier.

Parameters

string	$identifier
array	$propertiesToExtract

Returns: array

Definition at line 1377 of file ResourceStorage.php.

Referenced by ResourceStorage\getFileInfo().

getFileInFolder	(		$fileName,
		Folder	$folder
	)

Get file from folder

Parameters

string	$fileName
Folder	$folder

Returns: NULL|File|ProcessedFile

Definition at line 1447 of file ResourceStorage.php.

References ResourceStorage\getFileFactory(), Folder\getIdentifier(), and ResourceStorage\getUid().

Referenced by ResourceStorage\addUploadedFile().

getFileMounts ( )

Returns all file mounts that are registered with this storage.

Returns: array

Definition at line 468 of file ResourceStorage.php.

References ResourceStorage\$fileMounts.

getFileProcessingService ( )

protected

Returns: Service

Definition at line 2797 of file ResourceStorage.php.

References ResourceStorage\$fileProcessingService, and GeneralUtility\makeInstance().

Referenced by ResourceStorage\processFile().

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\InsufficientFolderAccessPermissionsException

Definition at line 1468 of file ResourceStorage.php.

References ResourceStorage\assureFolderReadPermission(), ResourceStorage\getFileFactory(), ResourceStorage\getFileIndexRepository(), Folder\getIdentifier(), and ResourceStorage\getUid().

Referenced by ResourceStorage\deleteFolder().

getFolder	(	$identifier,
		$returnInaccessibleFolderObject = `false`
	)

Parameters

string	$identifier
bool	$returnInaccessibleFolderObject

Returns: Folder|InaccessibleFolder

Exceptions

\Exception
Exception\InsufficientFolderAccessPermissionsException

Definition at line 2306 of file ResourceStorage.php.

References ResourceStorage\assureFolderReadPermission(), ResourceFactory\getInstance(), and GeneralUtility\makeInstance().

Referenced by ResourceStorage\copyFolder(), ResourceStorage\createFolder(), ResourceStorage\getDefaultFolder(), ResourceStorage\getFolderInFolder(), ResourceStorage\getFoldersInFolder(), ResourceStorage\moveFolder(), and ResourceStorage\renameFolder().

getFolderIdentifierFromFileIdentifier ( $fileIdentifier )

Parameters

string $fileIdentifier

Returns: string

Definition at line 1435 of file ResourceStorage.php.

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

Parameters

string	$folderIdentifier
bool	$useFilters
bool	$recursive

Returns: array

Definition at line 1528 of file ResourceStorage.php.

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

\Exception
Exception\InsufficientFolderAccessPermissionsException

Definition at line 2172 of file ResourceStorage.php.

References ResourceStorage\getFolder(), and Folder\getIdentifier().

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 2192 of file ResourceStorage.php.

References ResourceStorage\$processingFolder, ResourceStorage\getFolder(), and Folder\getIdentifier().

getIndexer ( )

protected

Gets the Indexer.

Returns

Definition at line 2887 of file ResourceStorage.php.

References GeneralUtility\makeInstance().

Referenced by ResourceStorage\moveFile(), ResourceStorage\moveFolder(), ResourceStorage\renameFile(), ResourceStorage\renameFolder(), ResourceStorage\replaceFile(), and ResourceStorage\setFileContents().

getName ( )

Returns the name of this storage.

Returns: string

Definition at line 242 of file ResourceStorage.php.

getObjectManager ( )

protected

Gets the ObjectManager.

Returns

Definition at line 2773 of file ResourceStorage.php.

References GeneralUtility\makeInstance().

Referenced by ResourceStorage\getSignalSlotDispatcher().

getProcessingFolder ( )

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

Returns: Folder

Definition at line 2841 of file ResourceStorage.php.

References ResourceStorage\$processingFolder, ResourceStorage\createFolder(), ResourceFactory\getInstance(), and GeneralUtility\makeInstance().

Referenced by ResourceStorage\updateProcessedFile().

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

Definition at line 1261 of file ResourceStorage.php.

References PathUtility\dirname(), elseif, ResourceStorage\emitPreGeneratePublicUrlSignal(), ResourceInterface\getIdentifier(), OnlineMediaHelperRegistry\getInstance(), PathUtility\getRelativePathTo(), ResourceStorage\hasCapability(), GeneralUtility\hmac(), ResourceStorage\isOnline(), and GeneralUtility\isValidUrl().

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 2811 of file ResourceStorage.php.

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

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 2377 of file ResourceStorage.php.

References ResourceFactory\getInstance().

Referenced by ResourceStorage\createFolder(), and ResourceStorage\isWithinFileMountBoundaries().

getSignalSlotDispatcher ( )

protected

Get the SignalSlot dispatcher.

Returns

Definition at line 2760 of file ResourceStorage.php.

References ResourceStorage\$signalSlotDispatcher, and ResourceStorage\getObjectManager().

getStorageRecord ( )

Gets the storage record.

Returns: array

Definition at line 210 of file ResourceStorage.php.

References ResourceStorage\$storageRecord.

getUid ( )

Returns the UID of this storage.

Returns: int

Definition at line 252 of file ResourceStorage.php.

Referenced by ResourceStorage\addFile(), StoragePermissionsAspect\addFileMountsToStorage(), StoragePermissionsAspect\addUserPermissionsToStorage(), ResourceStorage\assureFileAddPermissions(), ResourceStorage\assureFileCopyPermissions(), ResourceStorage\assureFileMovePermissions(), ResourceStorage\assureFolderCopyPermissions(), ResourceStorage\assureFolderMovePermissions(), ResourceStorage\createFile(), ProcessedFileRepository\findByStorageAndIdentifier(), ResourceStorage\getFile(), ResourceStorage\getFileInFolder(), ResourceStorage\getFilesInFolder(), FolderTreeView\getShortHashNumberForStorage(), ResourceStorage\isOnline(), ResourceStorage\markAsPermanentlyOffline(), ResourceStorage\markAsTemporaryOffline(), ResourceStorage\moveFile(), ResourceStorage\moveFolder(), and AbstractFile\setStorage().

getUniqueName	(	Folder	$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. TCEmain when files are attached to records and needs to be uniquely named in the uploads/* folders

Parameters

Folder	$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

\RuntimeException

Returns: string A unique fileName inside $folder, based on $theFile.

See Also: ::getUniqueName()

Definition at line 2715 of file ResourceStorage.php.

References Folder\getIdentifier(), and PathUtility\pathinfo().

Referenced by ResourceStorage\addFile(), and ResourceStorage\moveFile().

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 287 of file ResourceStorage.php.

Referenced by ResourceStorage\getPublicUrl(), ResourceStorage\isBrowsable(), ResourceStorage\isPublic(), and ResourceStorage\isWritable().

hasChildren ( )

Tells whether there are children in this storage.

Returns: bool

Definition at line 262 of file ResourceStorage.php.

hasFile ( $identifier )

Returns TRUE if the specified file exists

Parameters

string $identifier

Returns: bool

Definition at line 1540 of file ResourceStorage.php.

References ResourceStorage\assureFolderReadPermission(), and ResourceStorage\isWithinProcessingFolder().

Referenced by ProcessedFileRepository\findByStorageAndIdentifier().

hasFileInFolder	(		$fileName,
		Folder	$folder
	)

Checks if the queried file in the given folder exists

Parameters

string	$fileName
Folder	$folder

Returns: bool

Definition at line 1605 of file ResourceStorage.php.

References ResourceStorage\assureFolderReadPermission(), and Folder\getIdentifier().

Referenced by ResourceStorage\addUploadedFile().

hasFolder ( $identifier )

Returns TRUE if the specified folder exists.

Parameters

string $identifier

Returns: bool

Definition at line 2232 of file ResourceStorage.php.

References ResourceStorage\assureFolderReadPermission().

hasFolderInFolder	(		$folderName,
		Folder	$folder
	)

Checks if the given file exists in the given folder

Parameters

string	$folderName
Folder	$folder

Returns: bool

Definition at line 2245 of file ResourceStorage.php.

References ResourceStorage\assureFolderReadPermission(), and Folder\getIdentifier().

hashFile	(	FileInterface	$fileObject,
			$hash
	)

Creates a (cryptographic) hash for a file.

Parameters

FileInterface	$fileObject
string	$hash

Returns: string

Definition at line 1216 of file ResourceStorage.php.

References ResourceInterface\getIdentifier(), and ResourceStorage\hashFileByIdentifier().

hashFileByIdentifier	(	$fileIdentifier,
		$hash
	)

Creates a (cryptographic) hash for a fileIdentifier.

Parameters

string	$fileIdentifier
string	$hash

Returns: string

Definition at line 1229 of file ResourceStorage.php.

Referenced by ResourceStorage\hashFile().

isBrowsable ( )

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

Returns: bool

Definition at line 321 of file ResourceStorage.php.

References ResourceStorage\hasCapability(), and ResourceStorage\isOnline().

Referenced by ResourceStorage\checkFolderActionPermission().

isDefault ( )

Returns: bool

Definition at line 2904 of file ResourceStorage.php.

References ResourceStorage\$isDefault.

Referenced by ResourceStorage\__construct(), and ResourceStorage\setDefault().

isOnline ( )

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

Returns: bool

Definition at line 341 of file ResourceStorage.php.

References ResourceStorage\$isOnline, ResourceStorage\getUid(), and GeneralUtility\makeInstance().

Referenced by ResourceStorage\getPublicUrl(), ResourceStorage\isBrowsable(), ResourceStorage\markAsPermanentlyOffline(), and ResourceStorage\markAsTemporaryOffline().

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 1586 of file ResourceStorage.php.

References ResourceStorage\$processingFolder, and Folder\getCombinedIdentifier().

Referenced by ResourceStorage\getRole().

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 300 of file ResourceStorage.php.

References ResourceStorage\hasCapability().

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 481 of file ResourceStorage.php.

References elseif, ResourceStorage\getRootLevelFolder(), and ResourceStorage\isWithinProcessingFolder().

Referenced by ResourceStorage\checkFileActionPermission(), and ResourceStorage\checkFolderActionPermission().

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

\InvalidArgumentException

Definition at line 2358 of file ResourceStorage.php.

References ResourceInterface\getIdentifier(), Folder\getIdentifier(), ResourceInterface\getStorage(), and Folder\getStorage().

Referenced by ResourceStorage\copyFolder(), and ResourceStorage\moveFolder().

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 2338 of file ResourceStorage.php.

References ResourceStorage\$processingFolder.

Referenced by ResourceStorage\hasFile(), and ResourceStorage\isWithinFileMountBoundaries().

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 311 of file ResourceStorage.php.

References ResourceStorage\hasCapability().

Referenced by ResourceStorage\checkFileActionPermission(), and ResourceStorage\checkFolderActionPermission().

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.

Returns: void

Definition at line 389 of file ResourceStorage.php.

References $GLOBALS, ResourceStorage\getUid(), and ResourceStorage\isOnline().

Referenced by ResourceStorage\__construct().

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.

Returns: void

Definition at line 407 of file ResourceStorage.php.

References ResourceStorage\getUid(), ResourceStorage\isOnline(), and GeneralUtility\makeInstance().

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 ::func_move()

Parameters

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

Exceptions

Exception\ExistingTargetFileNameException
\RuntimeException

Returns: FileInterface

Definition at line 1791 of file ResourceStorage.php.

References ResourceStorage\assureFileMovePermissions(), DuplicationBehavior\CANCEL, Enumeration\cast(), elseif, ResourceStorage\emitPostFileMoveSignal(), ResourceStorage\emitPreFileMoveSignal(), ResourceStorage\getIndexer(), ResourceStorage\getUid(), ResourceStorage\getUniqueName(), and DuplicationBehavior\RENAME.

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 enumeration

Exceptions

\Exception\|\TYPO3\CMS\Core\Exception
\InvalidArgumentException
InvalidTargetFolderException

Returns: Folder

Definition at line 1978 of file ResourceStorage.php.

References ResourceStorage\assureFolderMovePermissions(), ResourceStorage\emitPostFolderMoveSignal(), ResourceStorage\emitPreFolderMoveSignal(), ResourceStorage\getFolder(), Folder\getIdentifier(), ResourceStorage\getIndexer(), Folder\getName(), Folder\getParentFolder(), Folder\getStorage(), ResourceStorage\getUid(), ResourceStorage\isWithinFolder(), and ResourceStorage\moveFolderBetweenStorages().

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

Returns: bool

Exceptions

\RuntimeException

Definition at line 2026 of file ResourceStorage.php.

Referenced by ResourceStorage\moveFolder().

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

\InvalidArgumentException

Definition at line 1319 of file ResourceStorage.php.

References ResourceStorage\getFileProcessingService(), and ResourceInterface\getStorage().

renameFile	(	$file,
		$targetFileName
	)

Previously in ::func_rename()

Parameters

FileInterface	$file
string	$targetFileName

Exceptions

Exception\InsufficientFileWritePermissionsException
Exception\InsufficientFileReadPermissionsException
Exception\InsufficientUserPermissionsException

Returns: FileInterface

Definition at line 1845 of file ResourceStorage.php.

References ResourceStorage\assureFileRenamePermissions(), ResourceStorage\emitPostFileRenameSignal(), ResourceStorage\emitPreFileRenameSignal(), and ResourceStorage\getIndexer().

renameFolder	(	$folderObject,
		$newName
	)

Previously in ::folder_move()

Parameters

Folder	$folderObject
string	$newName

Exceptions

\Exception
\InvalidArgumentException

Returns: Folder

Definition at line 2097 of file ResourceStorage.php.

References ResourceStorage\checkFolderActionPermission(), ResourceStorage\emitPostFolderRenameSignal(), ResourceStorage\emitPreFolderRenameSignal(), ResourceStorage\getFolder(), and ResourceStorage\getIndexer().

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\IllegalFileExtensionException
\InvalidArgumentException

Definition at line 1883 of file ResourceStorage.php.

References ResourceStorage\assureFileReplacePermissions(), ResourceStorage\autoExtractMetadataEnabled(), ResourceStorage\checkFileExtensionPermission(), ResourceStorage\emitPostFileReplaceSignal(), ResourceStorage\emitPreFileReplaceSignal(), ResourceInterface\getIdentifier(), ResourceStorage\getIndexer(), and GeneralUtility\makeInstance().

Referenced by ResourceStorage\addUploadedFile().

resetFileAndFolderNameFiltersToDefault ( )

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

Returns: void

Definition at line 1397 of file ResourceStorage.php.

References $GLOBALS.

Referenced by ResourceStorage\__construct().

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

Clean a fileName from not allowed characters

Parameters

string	$fileName	The name of the file to be add, If not set, the local file name is used
Folder	$targetFolder	The target folder where the file should be added

Exceptions