TYPO3 CMS  TYPO3_6-2
•All Classes Namespaces Files Functions Variables Pages
DriverInterface.php
Go to the documentation of this file.
1 <?php
2 namespace TYPO3\CMS\Core\Resource\Driver;
3 
22 interface DriverInterface {
23 
28  public function processConfiguration();
29 
36  public function setStorageUid($storageUid);
37 
44  public function initialize();
45 
52  public function getCapabilities();
53 
63  public function mergeConfigurationCapabilities($capabilities);
64 
71  public function hasCapability($capability);
72 
82  public function isCaseSensitiveFileSystem();
83 
92  public function sanitizeFileName($fileName, $charset = '');
93 
102  public function hashIdentifier($identifier);
103 
109  public function getRootLevelFolder();
110 
116  public function getDefaultFolder();
117 
125  public function getParentFolderIdentifierOfIdentifier($fileIdentifier);
126 
135  public function getPublicUrl($identifier);
136 
146  public function createFolder($newFolderName, $parentFolderIdentifier = '', $recursive = FALSE);
147 
155  public function renameFolder($folderIdentifier, $newName);
156 
164  public function deleteFolder($folderIdentifier, $deleteRecursively = FALSE);
165 
173  public function fileExists($fileIdentifier);
174 
182  public function folderExists($folderIdentifier);
183 
190  public function isFolderEmpty($folderIdentifier);
191 
205  public function addFile($localFilePath, $targetFolderIdentifier, $newFileName = '', $removeOriginal = TRUE);
206 
214  public function createFile($fileName, $parentFolderIdentifier);
215 
226  public function copyFileWithinStorage($fileIdentifier, $targetFolderIdentifier, $fileName);
227 
235  public function renameFile($fileIdentifier, $newName);
236 
244  public function replaceFile($fileIdentifier, $localFilePath);
245 
254  public function deleteFile($fileIdentifier);
255 
263  public function hash($fileIdentifier, $hashAlgorithm);
264 
265 
277  public function moveFileWithinStorage($fileIdentifier, $targetFolderIdentifier, $newFileName);
278 
279 
289  public function moveFolderWithinStorage($sourceFolderIdentifier, $targetFolderIdentifier, $newFolderName);
290 
300  public function copyFolderWithinStorage($sourceFolderIdentifier, $targetFolderIdentifier, $newFolderName);
301 
311  public function getFileContents($fileIdentifier);
312 
320  public function setFileContents($fileIdentifier, $contents);
321 
329  public function fileExistsInFolder($fileName, $folderIdentifier);
330 
338  public function folderExistsInFolder($folderName, $folderIdentifier);
339 
351  public function getFileForLocalProcessing($fileIdentifier, $writable = TRUE);
352 
360  public function getPermissions($identifier);
361 
370  public function dumpFileContents($identifier);
371 
385  public function isWithin($folderIdentifier, $identifier);
386 
395  public function getFileInfoByIdentifier($fileIdentifier, array $propertiesToExtract = array());
396 
403  public function getFolderInfoByIdentifier($folderIdentifier);
404 
416  public function getFilesInFolder($folderIdentifier, $start = 0, $numberOfItems = 0, $recursive = FALSE, array $filenameFilterCallbacks = array());
417 
429  public function getFoldersInFolder($folderIdentifier, $start = 0, $numberOfItems = 0, $recursive = FALSE, array $folderNameFilterCallbacks = array());
430 
431 }
TYPO3\CMS\Core\Resource\Driver\DriverInterface\createFile
createFile($fileName, $parentFolderIdentifier)
TYPO3\CMS\Core\Resource\Driver\DriverInterface\deleteFolder
deleteFolder($folderIdentifier, $deleteRecursively=FALSE)
TYPO3\CMS\Core\Resource\Driver\DriverInterface\folderExistsInFolder
folderExistsInFolder($folderName, $folderIdentifier)
TYPO3\CMS\Core\Resource\Driver\DriverInterface\hash
hash($fileIdentifier, $hashAlgorithm)
TYPO3\CMS\Core\Resource\Driver\DriverInterface\addFile
addFile($localFilePath, $targetFolderIdentifier, $newFileName='', $removeOriginal=TRUE)
TYPO3\CMS\Core\Resource\Driver\DriverInterface\copyFolderWithinStorage
copyFolderWithinStorage($sourceFolderIdentifier, $targetFolderIdentifier, $newFolderName)
TYPO3\CMS\Core\Resource\Driver\DriverInterface\moveFileWithinStorage
moveFileWithinStorage($fileIdentifier, $targetFolderIdentifier, $newFileName)
TYPO3\CMS\Core\Resource\Driver\DriverInterface\createFolder
createFolder($newFolderName, $parentFolderIdentifier='', $recursive=FALSE)
TYPO3\CMS\Core\Resource\Driver\DriverInterface\getFileInfoByIdentifier
getFileInfoByIdentifier($fileIdentifier, array $propertiesToExtract=array())
TYPO3\CMS\Core\Resource\Driver\DriverInterface\getFilesInFolder
getFilesInFolder($folderIdentifier, $start=0, $numberOfItems=0, $recursive=FALSE, array $filenameFilterCallbacks=array())
TYPO3\CMS\Core\Resource\Driver\DriverInterface\getFoldersInFolder
getFoldersInFolder($folderIdentifier, $start=0, $numberOfItems=0, $recursive=FALSE, array $folderNameFilterCallbacks=array())
TYPO3\CMS\Core\Resource\Driver\DriverInterface\renameFolder
renameFolder($folderIdentifier, $newName)
TYPO3\CMS\Core\Resource\Driver\DriverInterface\isWithin
isWithin($folderIdentifier, $identifier)
TYPO3\CMS\Core\Resource\Driver\DriverInterface\getFileForLocalProcessing
getFileForLocalProcessing($fileIdentifier, $writable=TRUE)
TYPO3\CMS\Core\Resource\Driver\DriverInterface\copyFileWithinStorage
copyFileWithinStorage($fileIdentifier, $targetFolderIdentifier, $fileName)
TYPO3\CMS\Core\Resource\Driver\DriverInterface\replaceFile
replaceFile($fileIdentifier, $localFilePath)
TYPO3\CMS\Core\Resource\Driver\DriverInterface\fileExistsInFolder
fileExistsInFolder($fileName, $folderIdentifier)
TYPO3\CMS\Core\Resource\Driver\DriverInterface\moveFolderWithinStorage
moveFolderWithinStorage($sourceFolderIdentifier, $targetFolderIdentifier, $newFolderName)
TYPO3\CMS\Core\Resource\Driver\DriverInterface\setFileContents
setFileContents($fileIdentifier, $contents)