Your IP : 216.73.217.13
<?php
/*
* This file is part of the TYPO3 CMS project.
*
* It is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License, either version 2
* of the License, or any later version.
*
* For the full copyright and license information, please read the
* LICENSE.txt file that was distributed with this source code.
*
* The TYPO3 project - inspiring people to share!
*/
namespace TYPO3\CMS\Core\Resource\Driver;
/**
* An interface Drivers have to implement to fulfil the needs
* of the FAL API.
*/
interface DriverInterface
{
/**
* Processes the configuration for this driver.
*/
public function processConfiguration();
/**
* Sets the storage uid the driver belongs to
*
* @param int $storageUid
*/
public function setStorageUid($storageUid);
/**
* Initializes this object. This is called by the storage after the driver
* has been attached.
*/
public function initialize();
/**
* Returns the capabilities of this driver.
*
* @return int
* @see ResourceStorageInterface::CAPABILITY_ constants
*/
public function getCapabilities();
/**
* Merges the capabilities merged by the user at the storage
* configuration into the actual capabilities of the driver
* and returns the result.
*
* @param int $capabilities
* @return int
*/
public function mergeConfigurationCapabilities($capabilities);
/**
* Returns TRUE if this driver has the given capability.
*
* @param int $capability A capability, as defined in a CAPABILITY_* constant
* @return bool
*/
public function hasCapability($capability);
/**
* Returns TRUE if this driver uses case-sensitive identifiers. NOTE: This
* is a configurable setting, but the setting does not change the way the
* underlying file system treats the identifiers; the setting should
* therefore always reflect the file system and not try to change its
* behaviour
*
* @return bool
*/
public function isCaseSensitiveFileSystem();
/**
* Cleans a fileName from not allowed characters
*
* @param string $fileName
* @param string $charset Charset of the a fileName
* (defaults to current charset; depending on context)
* @return string the cleaned filename
*/
public function sanitizeFileName($fileName, $charset = '');
/**
* Hashes a file identifier, taking the case sensitivity of the file system
* into account. This helps mitigating problems with case-insensitive
* databases.
*
* @param string $identifier
* @return string
*/
public function hashIdentifier($identifier);
/**
* Returns the identifier of the root level folder of the storage.
*
* @return string
*/
public function getRootLevelFolder();
/**
* Returns the identifier of the default folder new files should be put into.
*
* @return string
*/
public function getDefaultFolder();
/**
* Returns the identifier of the folder the file resides in
*
* @param string $fileIdentifier
* @return string
*/
public function getParentFolderIdentifierOfIdentifier($fileIdentifier);
/**
* Returns the public URL to a file.
* Either fully qualified URL or relative to public web path (rawurlencoded).
*
* @param string $identifier
* @return string|null NULL if file is missing or deleted, the generated url otherwise
*/
public function getPublicUrl($identifier);
/**
* Creates a folder, within a parent folder.
* If no parent folder is given, a root level folder will be created
*
* @param string $newFolderName
* @param string $parentFolderIdentifier
* @param bool $recursive
* @return string the Identifier of the new folder
*/
public function createFolder($newFolderName, $parentFolderIdentifier = '', $recursive = false);
/**
* Renames a folder in this storage.
*
* @param string $folderIdentifier
* @param string $newName
* @return array A map of old to new file identifiers of all affected resources
*/
public function renameFolder($folderIdentifier, $newName);
/**
* Removes a folder in filesystem.
*
* @param string $folderIdentifier
* @param bool $deleteRecursively
* @return bool
*/
public function deleteFolder($folderIdentifier, $deleteRecursively = false);
/**
* Checks if a file exists.
*
* @param string $fileIdentifier
* @return bool
*/
public function fileExists($fileIdentifier);
/**
* Checks if a folder exists.
*
* @param string $folderIdentifier
* @return bool
*/
public function folderExists($folderIdentifier);
/**
* Checks if a folder contains files and (if supported) other folders.
*
* @param string $folderIdentifier
* @return bool TRUE if there are no files and folders within $folder
*/
public function isFolderEmpty($folderIdentifier);
/**
* Adds a file from the local server hard disk to a given path in TYPO3s
* virtual file system. This assumes that the local file exists, so no
* further check is done here! After a successful operation the original
* file must not exist anymore.
*
* @param string $localFilePath within public web path
* @param string $targetFolderIdentifier
* @param string $newFileName optional, if not given original name is used
* @param bool $removeOriginal if set the original file will be removed
* after successful operation
* @return string the identifier of the new file
*/
public function addFile($localFilePath, $targetFolderIdentifier, $newFileName = '', $removeOriginal = true);
/**
* Creates a new (empty) file and returns the identifier.
*
* @param string $fileName
* @param string $parentFolderIdentifier
* @return string
*/
public function createFile($fileName, $parentFolderIdentifier);
/**
* Copies a file *within* the current storage.
* Note that this is only about an inner storage copy action,
* where a file is just copied to another folder in the same storage.
*
* @param string $fileIdentifier
* @param string $targetFolderIdentifier
* @param string $fileName
* @return string the Identifier of the new file
*/
public function copyFileWithinStorage($fileIdentifier, $targetFolderIdentifier, $fileName);
/**
* Renames a file in this storage.
*
* @param string $fileIdentifier
* @param string $newName The target path (including the file name!)
* @return string The identifier of the file after renaming
*/
public function renameFile($fileIdentifier, $newName);
/**
* Replaces a file with file in local file system.
*
* @param string $fileIdentifier
* @param string $localFilePath
* @return bool TRUE if the operation succeeded
*/
public function replaceFile($fileIdentifier, $localFilePath);
/**
* Removes a file from the filesystem. This does not check if the file is
* still used or if it is a bad idea to delete it for some other reason
* this has to be taken care of in the upper layers (e.g. the Storage)!
*
* @param string $fileIdentifier
* @return bool TRUE if deleting the file succeeded
*/
public function deleteFile($fileIdentifier);
/**
* Creates a hash for a file.
*
* @param string $fileIdentifier
* @param string $hashAlgorithm The hash algorithm to use
* @return string
*/
public function hash($fileIdentifier, $hashAlgorithm);
/**
* Moves a file *within* the current storage.
* Note that this is only about an inner-storage move action,
* where a file is just moved to another folder in the same storage.
*
* @param string $fileIdentifier
* @param string $targetFolderIdentifier
* @param string $newFileName
* @return string
*/
public function moveFileWithinStorage($fileIdentifier, $targetFolderIdentifier, $newFileName);
/**
* Folder equivalent to moveFileWithinStorage().
*
* @param string $sourceFolderIdentifier
* @param string $targetFolderIdentifier
* @param string $newFolderName
* @return array All files which are affected, map of old => new file identifiers
*/
public function moveFolderWithinStorage($sourceFolderIdentifier, $targetFolderIdentifier, $newFolderName);
/**
* Folder equivalent to copyFileWithinStorage().
*
* @param string $sourceFolderIdentifier
* @param string $targetFolderIdentifier
* @param string $newFolderName
* @return bool
*/
public function copyFolderWithinStorage($sourceFolderIdentifier, $targetFolderIdentifier, $newFolderName);
/**
* Returns the contents of a file. Beware that this requires to load the
* complete file into memory and also may require fetching the file from an
* external location. So this might be an expensive operation (both in terms
* of processing resources and money) for large files.
*
* @param string $fileIdentifier
* @return string The file contents
*/
public function getFileContents($fileIdentifier);
/**
* Sets the contents of a file to the specified value.
*
* @param string $fileIdentifier
* @param string $contents
* @return int The number of bytes written to the file
*/
public function setFileContents($fileIdentifier, $contents);
/**
* Checks if a file inside a folder exists
*
* @param string $fileName
* @param string $folderIdentifier
* @return bool
*/
public function fileExistsInFolder($fileName, $folderIdentifier);
/**
* Checks if a folder inside a folder exists.
*
* @param string $folderName
* @param string $folderIdentifier
* @return bool
*/
public function folderExistsInFolder($folderName, $folderIdentifier);
/**
* Returns a path to a local copy of a file for processing it. When changing the
* file, you have to take care of replacing the current version yourself!
*
* @param string $fileIdentifier
* @param bool $writable Set this to FALSE if you only need the file for read
* operations. This might speed up things, e.g. by using
* a cached local version. Never modify the file if you
* have set this flag!
* @return string The path to the file on the local disk
*/
public function getFileForLocalProcessing($fileIdentifier, $writable = true);
/**
* Returns the permissions of a file/folder as an array
* (keys r, w) of boolean flags
*
* @param string $identifier
* @return array
*/
public function getPermissions($identifier);
/**
* Directly output the contents of the file to the output
* buffer. Should not take care of header files or flushing
* buffer before. Will be taken care of by the Storage.
*
* @param string $identifier
*/
public function dumpFileContents($identifier);
/**
* Checks if a given identifier is within a container, e.g. if
* a file or folder is within another folder.
* This can e.g. be used to check for web-mounts.
*
* Hint: this also needs to return TRUE if the given identifier
* matches the container identifier to allow access to the root
* folder of a filemount.
*
* @param string $folderIdentifier
* @param string $identifier identifier to be checked against $folderIdentifier
* @return bool TRUE if $content is within or matches $folderIdentifier
*/
public function isWithin($folderIdentifier, $identifier);
/**
* Returns information about a file.
*
* @param string $fileIdentifier
* @param array $propertiesToExtract Array of properties which are be extracted
* If empty all will be extracted
* @return array
*/
public function getFileInfoByIdentifier($fileIdentifier, array $propertiesToExtract = []);
/**
* Returns information about a file.
*
* @param string $folderIdentifier
* @return array
*/
public function getFolderInfoByIdentifier($folderIdentifier);
/**
* Returns the identifier of a file inside the folder
*
* @param string $fileName
* @param string $folderIdentifier
* @return string file identifier
*/
public function getFileInFolder($fileName, $folderIdentifier);
/**
* Returns a list of files inside the specified path
*
* @param string $folderIdentifier
* @param int $start
* @param int $numberOfItems
* @param bool $recursive
* @param array $filenameFilterCallbacks callbacks for filtering the items
* @param 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".
* @param bool $sortRev TRUE to indicate reverse sorting (last to first)
* @return array of FileIdentifiers
*/
public function getFilesInFolder($folderIdentifier, $start = 0, $numberOfItems = 0, $recursive = false, array $filenameFilterCallbacks = [], $sort = '', $sortRev = false);
/**
* Returns the identifier of a folder inside the folder
*
* @param string $folderName The name of the target folder
* @param string $folderIdentifier
* @return string folder identifier
*/
public function getFolderInFolder($folderName, $folderIdentifier);
/**
* Returns a list of folders inside the specified path
*
* @param string $folderIdentifier
* @param int $start
* @param int $numberOfItems
* @param bool $recursive
* @param array $folderNameFilterCallbacks callbacks for filtering the items
* @param 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".
* @param bool $sortRev TRUE to indicate reverse sorting (last to first)
* @return array<string|int, string> folder identifiers (where key and value are identical, but int-like identifiers
* will get converted to int array keys)
*/
public function getFoldersInFolder($folderIdentifier, $start = 0, $numberOfItems = 0, $recursive = false, array $folderNameFilterCallbacks = [], $sort = '', $sortRev = false);
/**
* Returns the number of files inside the specified path
*
* @param string $folderIdentifier
* @param bool $recursive
* @param array $filenameFilterCallbacks callbacks for filtering the items
* @return int Number of files in folder
*/
public function countFilesInFolder($folderIdentifier, $recursive = false, array $filenameFilterCallbacks = []);
/**
* Returns the number of folders inside the specified path
*
* @param string $folderIdentifier
* @param bool $recursive
* @param array $folderNameFilterCallbacks callbacks for filtering the items
* @return int Number of folders in folder
*/
public function countFoldersInFolder($folderIdentifier, $recursive = false, array $folderNameFilterCallbacks = []);
}