.. include:: ../../../Includes.txt ======================= All The Links: Resource ======================= About `\\TYPO3\\CMS\\Core\\Resource` .. tip:: Hello **TYPO3 core developers,** here you have the links to the RESOURCE Api enriched by **YOUR descriptions** as you have given them in the PHPDoc blocks of the code. So please: **Start being more eloquent!** It's worth it! AbstractFile ============ :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\AbstractFile` ... :ref:`AbstractFile::copyTo ` Copies this file into a target folder :ref:`AbstractFile::delete ` Deletes this file from its storage. This also means that this object becomes useless. :ref:`AbstractFile::exists ` Checks if this file exists. This should normally always return TRUE; it might only return FALSE when this object has been created from an index record without checking for. :ref:`AbstractFile::getCombinedIdentifier ` Returns a combined identifier of this file, i.e. the storage UID and the folder identifier separated by a colon ":". :ref:`AbstractFile::getContents ` Get the contents of this file :ref:`AbstractFile::getCreationTime ` Returns the creation time of the file as Unix timestamp :ref:`AbstractFile::getExtension ` Get the extension of this file in a lower-case variant :ref:`AbstractFile::getForLocalProcessing ` Returns a path to a local version of this file to process it locally (e.g. with some system tool). If the file is normally located on a remote storages, this creates a local copy. If the file is already on the local system, this only makes a new copy if $writable is set to TRUE. :ref:`AbstractFile::getHashedIdentifier ` Get hashed identifier :ref:`AbstractFile::getIdentifier ` Returns the identifier of this file :ref:`AbstractFile::getMimeType ` Get the MIME type of this file :ref:`AbstractFile::getModificationTime ` Returns the date (as UNIX timestamp) the file was last modified. :ref:`AbstractFile::getName ` Returns the name of this file :ref:`AbstractFile::getNameWithoutExtension ` Returns the basename (the name without extension) of this file. :ref:`AbstractFile::getParentFolder ` Returns the parent folder. :ref:`AbstractFile::getProperties ` Returns the properties of this object. :ref:`AbstractFile::getProperty ` Returns a property value :ref:`AbstractFile::getPublicUrl ` Returns a publicly accessible URL for this 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. :ref:`AbstractFile::getSha1 ` Returns the Sha1 of this file :ref:`AbstractFile::getSize ` Returns the size of this file :ref:`AbstractFile::getStorage ` Get the storage this file is located in :ref:`AbstractFile::getType ` Returns the fileType of this file basically there are only five main "file types" "audio" "image" "software" "text" "video" "other" see the constants in this class :ref:`AbstractFile::getUid ` Returns the uid of this file :ref:`AbstractFile::hasProperty ` Returns true if the given property key exists for this file. :ref:`AbstractFile::isDeleted ` Returns TRUE if this file has been deleted :ref:`AbstractFile::moveTo ` Moves the file into the target folder :ref:`AbstractFile::rename ` Renames this file. :ref:`AbstractFile::setContents ` Replace the current file contents with the given string :ref:`AbstractFile::setDeleted ` ... :ref:`AbstractFile::setIdentifier ` Set the identifier of this file :ref:`AbstractFile::setStorage ` Sets the storage this file is located in. This is only meant for -internal usage; don't use it to move files. :ref:`AbstractFile::updateProperties ` Updates properties of this object. This method is used to reconstitute settings from the database into this object after being intantiated. AbstractRepository ================== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\AbstractRepository` ... :ref:`AbstractRepository::__call ` Magic call method for repository methods. :ref:`AbstractRepository::__construct ` Creates this object. :ref:`AbstractRepository::add ` Adds an object to this repository. :ref:`AbstractRepository::countAll ` Returns the total number objects of this repository. :ref:`AbstractRepository::createDomainObject ` Creates an object managed by this repository. :ref:`AbstractRepository::createQuery ` Returns a query for objects of this repository :ref:`AbstractRepository::findAll ` Returns all objects of this repository. :ref:`AbstractRepository::findByIdentifier ` Finds an object matching the given identifier. :ref:`AbstractRepository::findByUid ` Finds an object matching the given identifier. :ref:`AbstractRepository::getAddedObjects ` ... :ref:`AbstractRepository::getDatabaseConnection ` ... :ref:`AbstractRepository::getEntityClassName ` Returns the object type this repository is managing. :ref:`AbstractRepository::getEnvironmentMode ` Function to return the current TYPO3\_MODE. This function can be mocked in unit tests to be able to test frontend behaviour. :ref:`AbstractRepository::getRemovedObjects ` ... :ref:`AbstractRepository::getWhereClauseForEnabledFields ` get the WHERE clause for the enabled fields of this TCA table depending on the context :ref:`AbstractRepository::remove ` Removes an object from this repository. :ref:`AbstractRepository::removeAll ` ... :ref:`AbstractRepository::replace ` Replaces an object by another. :ref:`AbstractRepository::setDefaultOrderings ` Sets the property names to order the result by per default. Expected like this: array( 'foo' => Tx\_Extbase\_Persistence\_QueryInterface::ORDER\_ASCENDING, 'bar' => Tx\_Extbase\_Persistence\_QueryInterface::ORDER\_DESCENDING ) :ref:`AbstractRepository::setDefaultQuerySettings ` Sets the default query settings to be used in this repository :ref:`AbstractRepository::update ` Replaces an existing object with the same identifier by the given object AbstractFileCollection ====================== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Collection\\AbstractFileCollection` ... :ref:`AbstractFileCollection::add ` Adds a file to this collection. :ref:`AbstractFileCollection::fromArray ` Similar to method in , but without $this->itemTableName= $array['table\_name'], but with $this->storageItemsFieldContent = $array[self::$storageItemsField]; :ref:`AbstractFileCollection::getItemsCriteria ` Gets ths items criteria. :ref:`AbstractFileCollection::getPersistableDataArray ` Returns an array of the persistable properties and contents which are processable by TCEmain. :ref:`AbstractFileCollection::removeAll ` Removes all elements of the current collection. :ref:`AbstractFileCollection::setDescription ` Sets the description. :ref:`AbstractFileCollection::setItemsCriteria ` Sets the items criteria. :ref:`AbstractFileCollection::setTitle ` Sets the title. CategoryBasedFileCollection =========================== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Collection\\CategoryBasedFileCollection` ... :ref:`CategoryBasedFileCollection::getDatabaseConnection ` Gets the database object. :ref:`CategoryBasedFileCollection::loadContents ` Populates the content-entries of the collection FileCollectionRegistry ====================== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Collection\\FileCollectionRegistry` ... :ref:`FileCollectionRegistry::__construct ` Constructor :ref:`FileCollectionRegistry::addTypeToTCA ` Add the type to the TCA of sys\_file\_collection :ref:`FileCollectionRegistry::fileCollectionTypeExists ` Checks if the given FileCollection type exists :ref:`FileCollectionRegistry::getFileCollectionClass ` Returns a class name for a given type :ref:`FileCollectionRegistry::registerFileCollectionClass ` Register a (new) FileCollection type FolderBasedFileCollection ========================= :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Collection\\FolderBasedFileCollection` ... :ref:`FolderBasedFileCollection::getItemsCriteria ` Gets the items criteria. :ref:`FolderBasedFileCollection::getPersistableDataArray ` Returns an array of the persistable properties and contents which are processable by TCEmain. :ref:`FolderBasedFileCollection::loadContents ` Populates the content-entries of the storage Queries the underlying storage for entries of the collection and adds them to the collection data. If the content entries of the storage had not been loaded on creation ($fillItems = false) this function is to be used for loading the contents afterwards. StaticFileCollection ==================== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Collection\\StaticFileCollection` ... AbstractDriver ============== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Driver\\AbstractDriver` ... :ref:`AbstractDriver::__construct ` Creates this object. :ref:`AbstractDriver::canonicalizeAndCheckFileIdentifier ` Makes sure the identifier given as parameter is valid :ref:`AbstractDriver::canonicalizeAndCheckFilePath ` Makes sure the path given as parameter is valid :ref:`AbstractDriver::canonicalizeAndCheckFolderIdentifier ` Makes sure the identifier given as parameter is valid :ref:`AbstractDriver::getCapabilities ` Returns the capabilities of this driver. :ref:`AbstractDriver::getTemporaryPathForFile ` Returns a temporary path for a given file, including the file extension. :ref:`AbstractDriver::hasCapability ` Returns TRUE if this driver has the given capability. :ref:`AbstractDriver::hashIdentifier ` Hashes a file identifier, taking the case sensitivity of the file system into account. This helps mitigating problems with case-insensitive databases. :ref:`AbstractDriver::isCaseSensitiveFileSystem ` 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 :ref:`AbstractDriver::isValidFilename ` Checks a fileName for validity. This could be overidden in concrete drivers if they have different file naming rules. :ref:`AbstractDriver::sanitizeFileName ` Basic implementation of the method that does directly return the file name as is. :ref:`AbstractDriver::setStorageUid ` Sets the storage uid the driver belongs to AbstractHierarchicalFilesystemDriver ==================================== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Driver\\AbstractHierarchicalFilesystemDriver` ... :ref:`AbstractHierarchicalFilesystemDriver::canonicalizeAndCheckFileIdentifier ` Makes sure the Path given as parameter is valid :ref:`AbstractHierarchicalFilesystemDriver::canonicalizeAndCheckFilePath ` Makes sure the Path given as parameter is valid :ref:`AbstractHierarchicalFilesystemDriver::canonicalizeAndCheckFolderIdentifier ` Makes sure the Path given as parameter is valid :ref:`AbstractHierarchicalFilesystemDriver::getParentFolderIdentifierOfIdentifier ` Returns the identifier of the folder the file resides in :ref:`AbstractHierarchicalFilesystemDriver::isPathValid ` Wrapper for ::validPathStr() DriverInterface =============== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Driver\\DriverInterface` ... :ref:`DriverInterface::addFile ` 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 the original file must not exist anymore. :ref:`DriverInterface::copyFileWithinStorage ` ... :ref:`DriverInterface::copyFolderWithinStorage ` ... :ref:`DriverInterface::createFile ` Creates a new (empty) file and returns the identifier. :ref:`DriverInterface::createFolder ` Creates a folder, within a parent folder. If no parent folder is given, a root level folder will be created :ref:`DriverInterface::deleteFile ` 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)! :ref:`DriverInterface::deleteFolder ` Removes a folder in filesystem. :ref:`DriverInterface::dumpFileContents ` 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. :ref:`DriverInterface::fileExists ` Checks if a file exists. :ref:`DriverInterface::fileExistsInFolder ` Checks if a file inside a folder exists :ref:`DriverInterface::folderExists ` Checks if a folder exists. :ref:`DriverInterface::folderExistsInFolder ` Checks if a folder inside a folder exists. :ref:`DriverInterface::getCapabilities ` Returns the capabilities of this driver. :ref:`DriverInterface::getDefaultFolder ` Returns the identifier of the default folder new files should be put into. :ref:`DriverInterface::getFileContents ` 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. :ref:`DriverInterface::getFileForLocalProcessing ` 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! :ref:`DriverInterface::getFileInfoByIdentifier ` Returns information about a file. :ref:`DriverInterface::getFilesInFolder ` Returns a list of files inside the specified path :ref:`DriverInterface::getFolderInfoByIdentifier ` Returns information about a file. :ref:`DriverInterface::getFoldersInFolder ` Returns a list of folders inside the specified path :ref:`DriverInterface::getParentFolderIdentifierOfIdentifier ` Returns the identifier of the folder the file resides in :ref:`DriverInterface::getPermissions ` Returns the permissions of a file/folder as an array (keys r, w) of boolean flags :ref:`DriverInterface::getPublicUrl ` Returns the public URL to a file. Either fully qualified URL or relative to PATH\_site (rawurlencoded). :ref:`DriverInterface::getRootLevelFolder ` Returns the identifier of the root level folder of the storage. :ref:`DriverInterface::hasCapability ` Returns TRUE if this driver has the given capability. :ref:`DriverInterface::hash ` Creates a hash for a file. :ref:`DriverInterface::hashIdentifier ` Hashes a file identifier, taking the case sensitivity of the file system into account. This helps mitigating problems with case-insensitive databases. :ref:`DriverInterface::initialize ` Initializes this object. This is called by the storage after the driver has been attached. :ref:`DriverInterface::isCaseSensitiveFileSystem ` 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 :ref:`DriverInterface::isFolderEmpty ` Checks if a folder contains files and (if supported) other folders. :ref:`DriverInterface::isWithin ` 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. :ref:`DriverInterface::mergeConfigurationCapabilities ` Merges the capabilites merged by the user at the storage configuration into the actual capabilities of the driver and returns the result. :ref:`DriverInterface::moveFileWithinStorage ` ... :ref:`DriverInterface::moveFolderWithinStorage ` ... :ref:`DriverInterface::processConfiguration ` ... :ref:`DriverInterface::renameFile ` Renames a file in this storage. :ref:`DriverInterface::renameFolder ` Renames a folder in this storage. :ref:`DriverInterface::replaceFile ` Replaces a file with file in local file system. :ref:`DriverInterface::sanitizeFileName ` Cleans a fileName from not allowed characters :ref:`DriverInterface::setFileContents ` Sets the contents of a file to the specified value. :ref:`DriverInterface::setStorageUid ` Sets the storage uid the driver belongs to DriverRegistry ============== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Driver\\DriverRegistry` ... :ref:`DriverRegistry::__construct ` Creates this object. :ref:`DriverRegistry::addDriversToTCA ` ... :ref:`DriverRegistry::driverExists ` Checks if the given driver exists :ref:`DriverRegistry::getDriverClass ` Returns a class name for a given class name or short name. :ref:`DriverRegistry::registerDriverClass ` Registers a driver class with an optional short name. LocalDriver =========== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Driver\\LocalDriver` ... :ref:`LocalDriver::__construct ` ... :ref:`LocalDriver::addFile ` 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 the original file must not exist anymore. :ref:`LocalDriver::applyFilterMethodsToDirectoryItem ` Applies a set of filter methods to a file name to find out if it should be used or not. This is e.g. used by directory listings. :ref:`LocalDriver::calculateBasePath ` Calculates the absolute path to this drivers storage location. :ref:`LocalDriver::copyFileToTemporaryPath ` Copies a file to a temporary path and returns that path. :ref:`LocalDriver::copyFileWithinStorage ` ... :ref:`LocalDriver::createFile ` Creates a new (empty) file and returns the identifier. :ref:`LocalDriver::createFolder ` Creates a folder, within a parent folder. If no parent folder is given, a rootlevel folder will be created :ref:`LocalDriver::createIdentifierMap ` Creates a map of old and new file/folder identifiers after renaming or moving a folder. The old identifier is used as the key, the new one as the value. :ref:`LocalDriver::deleteFile ` 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)! :ref:`LocalDriver::deleteFolder ` Removes a folder from this storage. :ref:`LocalDriver::determineBaseUrl ` ... :ref:`LocalDriver::dumpFileContents ` 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. :ref:`LocalDriver::extractFileInformation ` Extracts information about a file from the filesystem. :ref:`LocalDriver::fileExists ` Checks if a file exists. :ref:`LocalDriver::fileExistsInFolder ` Checks if a file inside a folder exists :ref:`LocalDriver::folderExists ` Checks if a folder exists. :ref:`LocalDriver::folderExistsInFolder ` Checks if a folder inside a folder exists. :ref:`LocalDriver::getAbsoluteBasePath ` Returns the absolute path of the folder this driver operates on. :ref:`LocalDriver::getAbsolutePath ` Returns the absolute path of a file or folder. :ref:`LocalDriver::getCharsetConversion ` Gets the charset conversion object. :ref:`LocalDriver::getDefaultFolder ` Returns identifier of the default folder new files should be put into. :ref:`LocalDriver::getDirectoryItemList ` Generic wrapper for extracting a list of items from a path. :ref:`LocalDriver::getFileContents ` 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. :ref:`LocalDriver::getFileForLocalProcessing ` Returns (a local copy of) a file for processing it. This makes a copy first when in writable mode, so if you change the file, you have to update it yourself afterwards. :ref:`LocalDriver::getFileInfoByIdentifier ` Returns information about a file. :ref:`LocalDriver::getFilesInFolder ` Returns a list of files inside the specified path :ref:`LocalDriver::getFolderInfoByIdentifier ` Returns information about a folder. :ref:`LocalDriver::getFolderInFolder ` Returns the Identifier for a folder within a given folder. :ref:`LocalDriver::getFoldersInFolder ` Returns a list of folders inside the specified path :ref:`LocalDriver::getMimeTypeOfFile ` Get MIME type of file. :ref:`LocalDriver::getPermissions ` Returns the permissions of a file/folder as an array (keys r, w) of boolean flags :ref:`LocalDriver::getPublicUrl ` Returns the public URL to a file. For the local driver, this will always return a path relative to PATH\_site. :ref:`LocalDriver::getRole ` Returns the role of an item (currently only folders; can later be extended for files as well) :ref:`LocalDriver::getRootLevelFolder ` Returns the Identifier of the root level folder of the storage. :ref:`LocalDriver::getSpecificFileInformation ` Extracts a specific FileInformation from the FileSystems. :ref:`LocalDriver::hash ` Creates a (cryptographic) hash for a file. :ref:`LocalDriver::initialize ` Initializes this object. This is called by the storage after the driver has been attached. :ref:`LocalDriver::isFolderEmpty ` Checks if a folder contains files and (if supported) other folders. :ref:`LocalDriver::isWithin ` Checks if a given identifier is within a container, e.g. if a file or folder is within another folder. It will also return TRUE if both canonicalized identifiers are equal. :ref:`LocalDriver::mergeConfigurationCapabilities ` Merges the capabilites merged by the user at the storage configuration into the actual capabilities of the driver and returns the result. :ref:`LocalDriver::moveFileWithinStorage ` ... :ref:`LocalDriver::moveFolderWithinStorage ` ... :ref:`LocalDriver::processConfiguration ` Processes the configuration for this driver. :ref:`LocalDriver::renameFile ` Renames a file in this storage. :ref:`LocalDriver::renameFolder ` Renames a folder in this storage. :ref:`LocalDriver::replaceFile ` Replaces the contents (and file-specific metadata) of a file object with a local file. :ref:`LocalDriver::sanitizeFileName ` Returns a string where any character not matching [.a-zA-Z0-9\_-] is substituted by '\_' Trailing dots are removed Previously in ::cleanFileName() :ref:`LocalDriver::setFileContents ` Sets the contents of a file to the specified value. Exception ========= :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Exception` ... AbstractFileOperationException ============================== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Exception\\AbstractFileOperationException` ... ExistingTargetFileNameException =============================== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Exception\\ExistingTargetFileNameException` ... ExistingTargetFolderException ============================= :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Exception\\ExistingTargetFolderException` ... FileDoesNotExistException ========================= :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Exception\\FileDoesNotExistException` ... FileOperationErrorException =========================== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Exception\\FileOperationErrorException` ... FolderDoesNotExistException =========================== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Exception\\FolderDoesNotExistException` ... IllegalFileExtensionException ============================= :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Exception\\IllegalFileExtensionException` ... InsufficientFileAccessPermissionsException ========================================== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Exception\\InsufficientFileAccessPermissionsException` ... InsufficientFileReadPermissionsException ======================================== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Exception\\InsufficientFileReadPermissionsException` ... InsufficientFileWritePermissionsException ========================================= :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Exception\\InsufficientFileWritePermissionsException` ... InsufficientFolderAccessPermissionsException ============================================ :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Exception\\InsufficientFolderAccessPermissionsException` ... InsufficientFolderReadPermissionsException ========================================== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Exception\\InsufficientFolderReadPermissionsException` ... InsufficientFolderWritePermissionsException =========================================== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Exception\\InsufficientFolderWritePermissionsException` ... InsufficientUserPermissionsException ==================================== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Exception\\InsufficientUserPermissionsException` ... InvalidConfigurationException ============================= :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Exception\\InvalidConfigurationException` ... InvalidFileException ==================== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Exception\\InvalidFileException` ... InvalidFileNameException ======================== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Exception\\InvalidFileNameException` ... InvalidFolderException ====================== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Exception\\InvalidFolderException` ... InvalidPathException ==================== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Exception\\InvalidPathException` ... InvalidTargetFolderException ============================ :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Exception\\InvalidTargetFolderException` ... InvalidUidException =================== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Exception\\InvalidUidException` ... NotInMountPointException ======================== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Exception\\NotInMountPointException` ... ResourceDoesNotExistException ============================= :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Exception\\ResourceDoesNotExistException` ... ResourcePermissionsUnavailableException ======================================= :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Exception\\ResourcePermissionsUnavailableException` ... UploadException =============== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Exception\\UploadException` ... UploadSizeException =================== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Exception\\UploadSizeException` ... File ==== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\File` ... :ref:`File::__construct ` Constructor for a file object. Should normally not be used directly, use the corresponding factory methods instead. :ref:`File::_getMetaData ` Returns the MetaData :ref:`File::_getPropertyRaw ` ... :ref:`File::_updateMetaDataProperties ` Updates MetaData properties :ref:`File::calculateChecksum ` Creates a MD5 hash checksum based on the combined identifier of the file, the files' mimetype and the systems' encryption key. used to generate a thumbnail, and this hash is checked if valid :ref:`File::checkActionPermission ` Check if a file operation (= action) is allowed for this file :ref:`File::getContents ` Get the contents of this file :ref:`File::getFileIndexRepository ` ... :ref:`File::getIndexerService ` Internal function to retrieve the indexer service, if it does not exist, an instance will be created :ref:`File::getMetaDataRepository ` ... :ref:`File::getProperties ` Returns the properties of this object. :ref:`File::getProperty ` Returns a property value :ref:`File::getPublicUrl ` Returns a publicly accessible URL for this file When file is marked as missing or deleted no url is returned 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. :ref:`File::getSha1 ` Gets SHA1 hash. :ref:`File::getUpdatedProperties ` Returns the names of all properties that have been updated in this record :ref:`File::hasProperty ` Checks if the file has a (metadata) property which can be retrieved by "getProperty" :ref:`File::isIndexed ` Returns TRUE if this file is indexed :ref:`File::isMissing ` ... :ref:`File::loadMetaData ` ... :ref:`File::process ` Returns a modified version of the file. :ref:`File::setContents ` Replace the current file contents with the given string :ref:`File::setIndexingInProgess ` ... :ref:`File::setMissing ` ... :ref:`File::toArray ` Returns an array representation of the file. (This is used by the generic listing module vidi when displaying file records.) :ref:`File::updateProperties ` Updates the properties of this file, e.g. after re-indexing or moving it. By default, only properties that exist as a key in the $properties array are overwritten. If you want to explicitly unset a property, set the corresponding key to NULL in the array. FileCollectionRepository ======================== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\FileCollectionRepository` ... :ref:`FileCollectionRepository::createDomainObject ` Creates a record collection domain object. :ref:`FileCollectionRepository::findByUid ` Finds a record collection by uid. :ref:`FileCollectionRepository::getFileFactory ` Gets the file factory. FileInterface ============= :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\FileInterface` ... :ref:`FileInterface::delete ` Deletes this file from its storage. This also means that this object becomes useless. :ref:`FileInterface::getContents ` Get the contents of this file :ref:`FileInterface::getCreationTime ` Returns the creation time of the file as Unix timestamp :ref:`FileInterface::getExtension ` Get the file extension :ref:`FileInterface::getForLocalProcessing ` Returns a path to a local version of this file to process it locally (e.g. with some system tool). If the file is normally located on a remote storages, this creates a local copy. If the file is already on the local system, this only makes a new copy if $writable is set to TRUE. :ref:`FileInterface::getMimeType ` Get the MIME type of this file :ref:`FileInterface::getModificationTime ` Returns the modification time of the file as Unix timestamp :ref:`FileInterface::getNameWithoutExtension ` Returns the basename (the name without extension) of this file. :ref:`FileInterface::getProperty ` Get the value of the $key property. :ref:`FileInterface::getPublicUrl ` Returns a publicly accessible URL for this 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. :ref:`FileInterface::getSha1 ` Returns the Sha1 of this file :ref:`FileInterface::getSize ` Returns the size of this file :ref:`FileInterface::hasProperty ` Returns true if the given key exists for this file. :ref:`FileInterface::isIndexed ` Returns TRUE if this file is indexed :ref:`FileInterface::rename ` Renames this file. :ref:`FileInterface::setContents ` Replace the current file contents with the given string. :ref:`FileInterface::toArray ` Returns an array representation of the file. (This is used by the generic listing module vidi when displaying file records.) FileReference ============= :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\FileReference` ... :ref:`FileReference::delete ` ... :ref:`FileReference::getAlternative ` Returns the alternative text to this image TODO: Possibly move this to the image domain object instead :ref:`FileReference::getCombinedIdentifier ` Returns a combined identifier of the underlying original file :ref:`FileReference::getContents ` Get the contents of this file :ref:`FileReference::getCreationTime ` Returns the creation time of the file as Unix timestamp :ref:`FileReference::getDescription ` Returns the description text to this file TODO: Possibly move this to the image domain object instead :ref:`FileReference::getExtension ` Get the file extension of this file :ref:`FileReference::getForLocalProcessing ` Returns a path to a local version of this file to process it locally (e.g. with some system tool). If the file is normally located on a remote storages, this creates a local copy. If the file is already on the local system, this only makes a new copy if $writable is set to TRUE. :ref:`FileReference::getHashedIdentifier ` Get hashed identifier :ref:`FileReference::getIdentifier ` Returns the identifier of the underlying original file :ref:`FileReference::getLink ` Returns the link that should be active when clicking on this image TODO: Move this to the image domain object instead :ref:`FileReference::getMimeType ` Get the MIME type of this file :ref:`FileReference::getModificationTime ` Returns the modification time of the file as Unix timestamp :ref:`FileReference::getName ` Returns the name of this file :ref:`FileReference::getNameWithoutExtension ` Returns the basename (the name without extension) of this file. :ref:`FileReference::getOriginalFile ` Gets the original file being referenced. :ref:`FileReference::getParentFolder ` Returns the parent folder. :ref:`FileReference::getProperties ` Gets all properties, falling back to values of the parent. :ref:`FileReference::getProperty ` Gets a property, falling back to values of the parent. :ref:`FileReference::getPublicUrl ` Returns a publicly accessible URL for this 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. :ref:`FileReference::getReferenceProperties ` Gets all properties of the file reference. :ref:`FileReference::getReferenceProperty ` Gets a property of the file reference. :ref:`FileReference::getSha1 ` Returns the Sha1 of this file :ref:`FileReference::getSize ` Returns the size of this file :ref:`FileReference::getStorage ` Get the storage the original file is located in :ref:`FileReference::getTitle ` Returns the title text to this image TODO: Possibly move this to the image domain object instead :ref:`FileReference::getType ` Returns the fileType of this file :ref:`FileReference::getUid ` ... :ref:`FileReference::hasProperty ` Returns true if the given key exists for this file. :ref:`FileReference::isIndexed ` ... :ref:`FileReference::isMissing ` Check if file is marked as missing by indexer :ref:`FileReference::rename ` Renames the fileName in this particular usage. :ref:`FileReference::restoreNonNullValuesCallback ` Callback to handle the NULL value feature :ref:`FileReference::setContents ` Replace the current file contents with the given string :ref:`FileReference::toArray ` Returns an array representation of the file. (This is used by the generic listing module vidi when displaying file records.) FileRepository ============== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\FileRepository` ... :ref:`FileRepository::addToIndex ` ... :ref:`FileRepository::createDomainObject ` Creates an object managed by this repository. :ref:`FileRepository::createFileReferenceObject ` ... :ref:`FileRepository::findBySha1Hash ` Returns all files with the corresponding SHA-1 hash. This is queried against the database, so only indexed files will be found :ref:`FileRepository::findByUid ` ... :ref:`FileRepository::findFileReferenceByUid ` ... :ref:`FileRepository::getFileIndexRecord ` Returns an index record of a file, or FALSE if the file is not indexed. :ref:`FileRepository::getFileIndexRecordsForFolder ` Returns the index-data of all files within that folder :ref:`FileRepository::getFileIndexRepository ` Return a file index repository :ref:`FileRepository::getFileIndexStatus ` Checks the index status of a file and returns FALSE if the file is not indexed, the uid otherwise. :ref:`FileRepository::getIndexerService ` Internal function to retrieve the indexer service, if it does not exist, an instance will be created :ref:`FileRepository::update ` Updates an existing file object in the database FileExtensionFilter =================== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Filter\\FileExtensionFilter` ... :ref:`FileExtensionFilter::convertToLowercaseArray ` Converts mixed (string or array) input arguments into an array, NULL if empty. All array values will be converted to lower case. :ref:`FileExtensionFilter::filterFileList ` Entry method for use as file list filter. We have to use -1 as the „don't include“ return value, as call\_user\_func() will return FALSE if calling the method failed and thus we can't use that as a return value. :ref:`FileExtensionFilter::filterInlineChildren ` Entry method for use as TCEMain "inline" field filter :ref:`FileExtensionFilter::isAllowed ` Checks whether a file is allowed according to the criteria defined in the class variables ($this->allowedFileExtensions etc.) :ref:`FileExtensionFilter::setAllowedFileExtensions ` Set allowed file extensions :ref:`FileExtensionFilter::setDisallowedFileExtensions ` Set disallowed file extensions FileNameFilter ============== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Filter\\FileNameFilter` ... :ref:`FileNameFilter::filterHiddenFilesAndFolders ` ... :ref:`FileNameFilter::getShowHiddenFilesAndFolders ` Gets the info whether the hidden files are also displayed currently :ref:`FileNameFilter::setShowHiddenFilesAndFolders ` set the flag to show (or hide) the hidden files Folder ====== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Folder` ... :ref:`Folder::__construct ` Initialization of the folder :ref:`Folder::addFile ` Adds a file from the local server disk. If the file already exists and overwriting is disabled, :ref:`Folder::addUploadedFile ` Adds an uploaded file into the Storage. :ref:`Folder::checkActionPermission ` Check if a file operation (= action) is allowed on this folder :ref:`Folder::copyTo ` Copies folder to a target folder :ref:`Folder::createFile ` Creates a new blank file :ref:`Folder::createFolder ` Creates a new folder :ref:`Folder::delete ` Deletes this folder from its storage. This also means that this object becomes useless. :ref:`Folder::getCombinedIdentifier ` Returns a combined identifier of this folder, i.e. the storage UID and the folder identifier separated by a colon ":". :ref:`Folder::getFileCount ` Returns amount of all files within this folder, optionally filtered by the given pattern :ref:`Folder::getFiles ` Returns a list of files in this folder, optionally filtered. There are several filter modes available, see the FILTER\_MODE\_\* constants for more information. For performance reasons the returned items can also be limited to a given range :ref:`Folder::getHashedIdentifier ` Get hashed identifier :ref:`Folder::getIdentifier ` Returns the path of this folder inside the storage. It depends on the type of storage whether this is a real path or just some unique identifier. :ref:`Folder::getName ` Returns the name of this folder. :ref:`Folder::getParentFolder ` Returns the parent folder. In non-hierarchical storages, that always is the root folder. The parent folder of the root folder is the root folder. :ref:`Folder::getPublicUrl ` Returns a publicly accessible URL for this folder WARNING: Access to the folder may be restricted by further means, e.g. some web-based authentication. You have to take care of this yourself. :ref:`Folder::getReadablePath ` Returns the full path of this folder, from the root. :ref:`Folder::getRole ` Returns the role of this folder (if any). See FolderInterface::ROLE\_\* constants for possible values. :ref:`Folder::getStorage ` Returns the storage this folder belongs to. :ref:`Folder::getSubfolders ` Returns a list of subfolders :ref:`Folder::hasFile ` Checks if a file exists in this folder :ref:`Folder::hasFolder ` Checks if a folder exists in this folder. :ref:`Folder::moveTo ` Moves folder to a target folder :ref:`Folder::prepareFiltersInStorage ` Prepares the filters in this folder's storage according to a set filter mode. :ref:`Folder::rename ` Renames this folder. :ref:`Folder::restoreBackedUpFiltersInStorage ` Restores the filters of a storage. :ref:`Folder::setFileAndFolderNameFilters ` Sets the filters to use when listing files. These are only used if the filter mode is one of FILTER\_MODE\_USE\_OWN\_FILTERS and FILTER\_MODE\_USE\_OWN\_AND\_STORAGE\_FILTERS :ref:`Folder::setName ` Sets a new name of the folder currently this does not trigger the "renaming process" as the name is more seen as a label :ref:`Folder::updateProperties ` Updates the properties of this folder, e.g. after re-indexing or moving it. FolderInterface =============== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\FolderInterface` ... :ref:`FolderInterface::delete ` Deletes this folder from its storage. This also means that this object becomes useless. :ref:`FolderInterface::getSubfolder ` Returns the object for a subfolder of the current folder, if it exists. :ref:`FolderInterface::getSubfolders ` Returns a list of all subfolders :ref:`FolderInterface::hasFile ` Checks if a file exists in this folder :ref:`FolderInterface::hasFolder ` Checks if a folder exists in this folder. :ref:`FolderInterface::rename ` Renames this folder. FileDumpEIDHookInterface ======================== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Hook\\FileDumpEIDHookInterface` ... :ref:`FileDumpEIDHookInterface::checkFileAccess ` Perform custom security/access when accessing file Method should issue 403 if access is rejected or 401 if authentication is required FileInfoHook ============ :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Hook\\FileInfoHook` ... :ref:`FileInfoHook::renderFileInfo ` User function for sys\_file (element) :ref:`FileInfoHook::renderFileInformationContent ` Renders a HTML Block with file information :ref:`FileInfoHook::renderFileMetadataInfo ` User function for sys\_file\_meta (element) InaccessibleFolder ================== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\InaccessibleFolder` ... :ref:`InaccessibleFolder::addFile ` Adds a file from the local server disk. If the file already exists and overwriting is disabled, :ref:`InaccessibleFolder::addUploadedFile ` Adds an uploaded file into the Storage. :ref:`InaccessibleFolder::copyTo ` Copies folder to a target folder :ref:`InaccessibleFolder::createFile ` Creates a new blank file :ref:`InaccessibleFolder::createFolder ` Creates a new folder :ref:`InaccessibleFolder::delete ` Deletes this folder from its storage. This also means that this object becomes useless. :ref:`InaccessibleFolder::getFileCount ` Returns amount of all files within this folder, optionally filtered by the given pattern :ref:`InaccessibleFolder::getFiles ` Returns a list of files in this folder, optionally filtered. There are several filter modes available, see the FILTER\_MODE\_\* constants for more information. For performance reasons the returned items can also be limited to a given range :ref:`InaccessibleFolder::getPublicUrl ` Returns a publicly accessible URL for this folder WARNING: Access to the folder may be restricted by further means, e.g. some web-based authentication. You have to take care of this yourself. :ref:`InaccessibleFolder::getSubfolder ` Returns the object for a subfolder of the current folder, if it exists. :ref:`InaccessibleFolder::getSubfolders ` Returns a list of subfolders :ref:`InaccessibleFolder::hasFile ` Checks if a file exists in this folder :ref:`InaccessibleFolder::hasFolder ` Checks if a folder exists in this folder. :ref:`InaccessibleFolder::moveTo ` Moves folder to a target folder :ref:`InaccessibleFolder::rename ` Renames this folder. :ref:`InaccessibleFolder::setFileAndFolderNameFilters ` Sets the filters to use when listing files. These are only used if the filter mode is one of FILTER\_MODE\_USE\_OWN\_FILTERS and FILTER\_MODE\_USE\_OWN\_AND\_STORAGE\_FILTERS :ref:`InaccessibleFolder::setName ` Sets a new name of the folder currently this does not trigger the "renaming process" as the name is more seen as a label :ref:`InaccessibleFolder::throwInaccessibleException ` ... :ref:`InaccessibleFolder::updateProperties ` Updates the properties of this folder, e.g. after re-indexing or moving it. ExtractorInterface ================== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Index\\ExtractorInterface` ... :ref:`ExtractorInterface::canProcess ` Checks if the given file can be processed by this Extractor :ref:`ExtractorInterface::extractMetaData ` The actual processing TASK Should return an array with database properties for sys\_file\_metadata to write :ref:`ExtractorInterface::getDriverRestrictions ` Get all supported DriverClasses Since some extractors may only work for local files, and other extractors are especially made for grabbing data from remote. Returns array of string with driver names of Drivers which are supported, If the driver did not register a name, it's the classname. empty array indicates no restrictions :ref:`ExtractorInterface::getExecutionPriority ` ... :ref:`ExtractorInterface::getFileTypeRestrictions ` Returns an array of supported file types; An empty array indicates all filetypes :ref:`ExtractorInterface::getPriority ` ... ExtractorRegistry ================= :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Index\\ExtractorRegistry` ... :ref:`ExtractorRegistry::compareExtractorPriority ` Compare the priority of two Extractor classes. Is used for sorting array of Extractor instances by priority. We want the result to be ordered from high to low so a higher priority comes before a lower. :ref:`ExtractorRegistry::createExtractorInstance ` Create an instance of a Metadata Extractor :ref:`ExtractorRegistry::getExtractorsWithDriverSupport ` Get Extractors which work for a special driver :ref:`ExtractorRegistry::getInstance ` Returns an instance of this class :ref:`ExtractorRegistry::registerExtractionService ` ... FileIndexRepository =================== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Index\\FileIndexRepository` ... :ref:`FileIndexRepository::add ` Adds a file to the index :ref:`FileIndexRepository::addRaw ` Add data from record (at indexing time) :ref:`FileIndexRepository::emitRecordCreatedSignal ` Signal that is called after an IndexRecord is created :ref:`FileIndexRepository::emitRecordDeletedSignal ` Signal that is called after an IndexRecord is deleted :ref:`FileIndexRepository::emitRecordUpdatedSignal ` Signal that is called after an IndexRecord is updated :ref:`FileIndexRepository::findByContentHash ` Returns all indexed files which match the content hash Used by the indexer to detect already present files :ref:`FileIndexRepository::findByFolder ` ... :ref:`FileIndexRepository::findInStorageAndNotInUidList ` ... :ref:`FileIndexRepository::findInStorageWithIndexOutstanding ` Finds the files needed for second indexer step :ref:`FileIndexRepository::findOneByCombinedIdentifier ` ... :ref:`FileIndexRepository::findOneByFileObject ` ... :ref:`FileIndexRepository::findOneByStorageUidAndIdentifier ` ... :ref:`FileIndexRepository::findOneByStorageUidAndIdentifierHash ` ... :ref:`FileIndexRepository::findOneByUid ` ... :ref:`FileIndexRepository::getDatabaseConnection ` Gets database instance :ref:`FileIndexRepository::getInstance ` Returns an Instance of the Repository :ref:`FileIndexRepository::getObjectManager ` Get the ObjectManager :ref:`FileIndexRepository::getResourceFactory ` ... :ref:`FileIndexRepository::getSignalSlotDispatcher ` ... :ref:`FileIndexRepository::getWhereClauseForFile ` Returns a where clause to find a file in database :ref:`FileIndexRepository::hasIndexRecord ` Checks if a file is indexed :ref:`FileIndexRepository::insertRecord ` Helper to reduce code duplication :ref:`FileIndexRepository::markFileAsMissing ` Marks given file as missing in sys\_file :ref:`FileIndexRepository::remove ` Remove a sys\_file record from the database :ref:`FileIndexRepository::update ` Updates the index record in the database :ref:`FileIndexRepository::updateIndexingTime ` Updates the timestamp when the file indexer extracted metadata Indexer ======= :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Index\\Indexer` ... :ref:`Indexer::__construct ` ... :ref:`Indexer::createIndexEntry ` Create index entry :ref:`Indexer::detectChangedFilesInStorage ` Adds updated files to the processing queue :ref:`Indexer::detectMissingFiles ` Since by now all files in filesystem have been looked at it is save to assume, that files that are in indexed but not touched in this run are missing :ref:`Indexer::extractRequiredMetaData ` Since the core desperately needs image sizes in metadata table put them there This should be called after every "content" update and "record" creation :ref:`Indexer::gatherFileInformationArray ` Collects the information to be cached in sys\_file :ref:`Indexer::getExtractorRegistry ` ... :ref:`Indexer::getFileIndexRepository ` ... :ref:`Indexer::getFileType ` Maps the mimetype to a sys\_file table type :ref:`Indexer::getMetaDataRepository ` ... :ref:`Indexer::getResourceFactory ` ... :ref:`Indexer::processChangedAndNewFiles ` Processes the Files which have been detected as "changed or new" in the storage :ref:`Indexer::processChangesInStorages ` ... :ref:`Indexer::runMetaDataExtraction ` ... :ref:`Indexer::transformFromDriverFileInfoArrayToFileObjectFormat ` However it happened, the properties of a file object which are persisted to the database are named different than the properties the driver returns in getFileInfo. Therefore a mapping must happen. :ref:`Indexer::updateIndexEntry ` Update index entry MetaDataRepository ================== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Index\\MetaDataRepository` ... :ref:`MetaDataRepository::createMetaDataRecord ` Create empty :ref:`MetaDataRepository::emitRecordCreatedSignal ` Signal that is called after an IndexRecord is created :ref:`MetaDataRepository::emitRecordDeletedSignal ` Signal that is called after an IndexRecord is deleted :ref:`MetaDataRepository::emitRecordPostRetrievalSignal ` Signal that is called after a record has been loaded from database Allows other places to do extension of metadata at runtime or for example translation and workspace overlay :ref:`MetaDataRepository::emitRecordUpdatedSignal ` Signal that is called after an IndexRecord is updated :ref:`MetaDataRepository::findByFile ` Returns array of meta-data properties :ref:`MetaDataRepository::findByFileUid ` Retrieves metadata for file :ref:`MetaDataRepository::getDatabaseConnection ` Wrapper method for getting DatabaseConnection :ref:`MetaDataRepository::getGeneralWhereClause ` General Where-Clause which is needed to fetch only language 0 and live record. :ref:`MetaDataRepository::getInstance ` ... :ref:`MetaDataRepository::getObjectManager ` Get the ObjectManager :ref:`MetaDataRepository::getSignalSlotDispatcher ` Get the SignalSlot dispatcher :ref:`MetaDataRepository::removeByFileUid ` Remove all metadata records for a certain file from the database :ref:`MetaDataRepository::update ` Updates the metadata record in the database ProcessedFile ============= :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\ProcessedFile` ... :ref:`ProcessedFile::__construct ` Constructor for a processed file object. Should normally not be used directly, use the corresponding factory methods instead. :ref:`ProcessedFile::calculateChecksum ` Returns a unique checksum for this file's processing configuration and original file. :ref:`ProcessedFile::delete ` Delete processed file :ref:`ProcessedFile::generateProcessedFileNameWithoutExtension ` ... :ref:`ProcessedFile::getIdentifier ` Get the identifier of the file If there is no processed file in the file system (as the original file did not have to be modified e.g. when the original image is in the boundaries of the maxW/maxH stuff), then just return the identifier of the original file :ref:`ProcessedFile::getName ` Get the name of the file If there is no processed file in the file system (as the original file did not have to be modified e.g. when the original image is in the boundaries of the maxW/maxH stuff) then just return the name of the original file :ref:`ProcessedFile::getOriginalFile ` ... :ref:`ProcessedFile::getProcessingConfiguration ` Returns the processing information :ref:`ProcessedFile::getProperty ` Getter for file-properties :ref:`ProcessedFile::getPublicUrl ` Returns a publicly accessible URL for this file :ref:`ProcessedFile::getTask ` Returns the task object associated with this processed file. :ref:`ProcessedFile::getTaskIdentifier ` Getter for the task identifier. :ref:`ProcessedFile::getUid ` Returns the uid of this file :ref:`ProcessedFile::isIndexed ` Returns TRUE if this file is indexed :ref:`ProcessedFile::isNew ` ... :ref:`ProcessedFile::isOutdated ` Returns TRUE if the original file of this file changed and the file should be processed again. :ref:`ProcessedFile::isPersisted ` ... :ref:`ProcessedFile::isProcessed ` Returns TRUE if this file is already processed. :ref:`ProcessedFile::isUnchanged ` Returns TRUE if this file has not been changed during processing (i.e., we just deliver the original file) :ref:`ProcessedFile::isUpdated ` Checks whether the object since last reconstitution, and therefore needs persistence again :ref:`ProcessedFile::needsReprocessing ` ... :ref:`ProcessedFile::reconstituteFromDatabaseRecord ` ... :ref:`ProcessedFile::setContents ` Replace the current file contents with the given string :ref:`ProcessedFile::setName ` Sets a new file name :ref:`ProcessedFile::setUsesOriginalFile ` ... :ref:`ProcessedFile::toArray ` Basic array function for the DB update :ref:`ProcessedFile::updateProperties ` ... :ref:`ProcessedFile::updateWithLocalFile ` Injects a local file, which is a processing result into the object. :ref:`ProcessedFile::usesOriginalFile ` ... ProcessedFileRepository ======================= :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\ProcessedFileRepository` ... :ref:`ProcessedFileRepository::__construct ` Creates this object. :ref:`ProcessedFileRepository::add ` Adds a processedfile object in the database :ref:`ProcessedFileRepository::cleanUnavailableColumns ` Removes all array keys which cannot be persisted :ref:`ProcessedFileRepository::createDomainObject ` ... :ref:`ProcessedFileRepository::createNewProcessedFileObject ` ... :ref:`ProcessedFileRepository::findAllByOriginalFile ` ... :ref:`ProcessedFileRepository::findByStorageAndIdentifier ` ... :ref:`ProcessedFileRepository::findOneByOriginalFileAndTaskTypeAndConfiguration ` ... :ref:`ProcessedFileRepository::getLogger ` ... :ref:`ProcessedFileRepository::removeAll ` Removes all processed files and also deletes the associated physical files :ref:`ProcessedFileRepository::update ` Updates an existing file object in the database AbstractGraphicalTask ===================== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Processing\\AbstractGraphicalTask` ... :ref:`AbstractGraphicalTask::determineTargetFileExtension ` Gets the file extension the processed file should have in the filesystem by either using the configuration setting, or the extension of the original file. :ref:`AbstractGraphicalTask::getTargetFileExtension ` Determines the file extension the processed file should have in the filesystem. :ref:`AbstractGraphicalTask::getTargetFilename ` Returns the name the processed file should have in the filesystem. AbstractTask ============ :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Processing\\AbstractTask` ... :ref:`AbstractTask::__construct ` ... :ref:`AbstractTask::getChecksumData ` ... :ref:`AbstractTask::getConfiguration ` ... :ref:`AbstractTask::getConfigurationChecksum ` Returns the checksum for this task's configuration, also taking the file and task type into account. :ref:`AbstractTask::getName ` Returns the name of this task :ref:`AbstractTask::getSourceFile ` ... :ref:`AbstractTask::getTargetFile ` ... :ref:`AbstractTask::getTargetFileExtension ` Gets the file extension the processed file should have in the filesystem. :ref:`AbstractTask::getTargetFilename ` Returns the filename :ref:`AbstractTask::getType ` Returns the type of this task :ref:`AbstractTask::isExecuted ` Returns TRUE if this task has been executed, no matter if the execution was successful. :ref:`AbstractTask::isSuccessful ` ... :ref:`AbstractTask::isValidConfiguration ` Checks if the given configuration is sensible for this task, i.e. if all required parameters are given, within the boundaries and don't conflict with each other. :ref:`AbstractTask::setExecuted ` Set this task executed. This is used by the Processors in order to transfer the state of this task to the file processing service. :ref:`AbstractTask::setSourceFile ` ... :ref:`AbstractTask::setTargetFile ` ... FileDeletionAspect ================== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Processing\\FileDeletionAspect` ... :ref:`FileDeletionAspect::cleanupCategoryReferences ` Remove all category references of the deleted file. :ref:`FileDeletionAspect::cleanupProcessedFilesPostFileAdd ` Remove all processed files on SIGNAL\_PostFileAdd :ref:`FileDeletionAspect::cleanupProcessedFilesPostFileReplace ` Remove all processed files on SIGNAL\_PostFileReplace :ref:`FileDeletionAspect::getDatabaseConnection ` Wrapper method for getting DatabaseConnection :ref:`FileDeletionAspect::getFileIndexRepository ` Return a file index repository :ref:`FileDeletionAspect::getMetaDataRepository ` Return a metadata repository :ref:`FileDeletionAspect::getProcessedFileRepository ` Return a processed file repository :ref:`FileDeletionAspect::removeFromRepository ` Cleanup database record for a deleted file ImageCropScaleMaskTask ====================== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Processing\\ImageCropScaleMaskTask` ... :ref:`ImageCropScaleMaskTask::fileNeedsProcessing ` Returns TRUE if the file has to be processed at all, such as e.g. the original file does. :ref:`ImageCropScaleMaskTask::getTargetFileName ` ... :ref:`ImageCropScaleMaskTask::isValidConfiguration ` Checks if the given configuration is sensible for this task, i.e. if all required parameters are given, within the boundaries and don't conflict with each other. ImagePreviewTask ================ :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Processing\\ImagePreviewTask` ... :ref:`ImagePreviewTask::fileNeedsProcessing ` Returns TRUE if the file has to be processed at all, such as e.g. the original file does. :ref:`ImagePreviewTask::getTargetFileName ` Returns the target filename for this task. :ref:`ImagePreviewTask::isValidConfiguration ` Checks if the given configuration is sensible for this task, i.e. if all required parameters are given, within the boundaries and don't conflict with each other. LocalCropScaleMaskHelper ======================== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Processing\\LocalCropScaleMaskHelper` ... :ref:`LocalCropScaleMaskHelper::__construct ` ... :ref:`LocalCropScaleMaskHelper::getConfigurationForImageCropScaleMask ` ... :ref:`LocalCropScaleMaskHelper::getFilenameForImageCropScaleMask ` Returns the filename for a cropped/scaled/masked file. :ref:`LocalCropScaleMaskHelper::modifyImageMagickStripProfileParameters ` Modifies the parameters for ImageMagick for stripping of profile information. LocalImageProcessor =================== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Processing\\LocalImageProcessor` ... :ref:`LocalImageProcessor::canProcessTask ` Returns TRUE if this processor can process the given task. :ref:`LocalImageProcessor::getGraphicalFunctionsObject ` ... :ref:`LocalImageProcessor::getHelperByTaskName ` ... :ref:`LocalImageProcessor::getTemporaryImageWithText ` Creates error image based on gfx/notfound\_thumb.png Requires GD lib enabled, otherwise it will exit with the three textstrings outputted as text. Outputs the image stream to browser and exits! :ref:`LocalImageProcessor::processTask ` Processes the given task. :ref:`LocalImageProcessor::wrapFileName ` Escapes a file name so it can safely be used on the command line. LocalPreviewHelper ================== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Processing\\LocalPreviewHelper` ... :ref:`LocalPreviewHelper::__construct ` ... :ref:`LocalPreviewHelper::generatePreviewFromFile ` Generates a preview for a file :ref:`LocalPreviewHelper::getTemporaryFilePath ` Returns the path to a temporary file for processing :ref:`LocalPreviewHelper::process ` This method actually does the processing of files locally takes the original file (on remote storages this will be fetched from the remote server) does the IM magic on the local server by creating a temporary typo3temp/ file copies the typo3temp/ file to the processing folder of the target storage removes the typo3temp/ file ProcessorInterface ================== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Processing\\ProcessorInterface` ... :ref:`ProcessorInterface::canProcessTask ` Returns TRUE if this processor can process the given task. :ref:`ProcessorInterface::processTask ` Processes the given task and sets the processing result in the task object. TaskInterface ============= :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Processing\\TaskInterface` ... :ref:`TaskInterface::__construct ` ... :ref:`TaskInterface::fileNeedsProcessing ` Returns TRUE if the file has to be processed at all, such as e.g. the original file does. :ref:`TaskInterface::getConfiguration ` Returns the configuration for this task. :ref:`TaskInterface::getConfigurationChecksum ` Returns the configuration checksum of this task. :ref:`TaskInterface::getName ` Returns the name of this task. :ref:`TaskInterface::getSourceFile ` Returns the original file this task is based on. :ref:`TaskInterface::getTargetFile ` Returns the processed file this task is executed on. :ref:`TaskInterface::getTargetFileExtension ` Gets the file extension the processed file should have in the filesystem. :ref:`TaskInterface::getTargetFileName ` Returns the name the processed file should have in the filesystem. :ref:`TaskInterface::getType ` Returns the type of this task. :ref:`TaskInterface::isExecuted ` Returns TRUE if this task has been executed, no matter if the execution was successful. :ref:`TaskInterface::isSuccessful ` Returns TRUE if this task has been successfully executed. Only call this method if the task has been processed at all. :ref:`TaskInterface::setExecuted ` Mark this task as executed. This is used by the Processors in order to transfer the state of this task to the file processing service. TaskTypeRegistry ================ :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Processing\\TaskTypeRegistry` ... :ref:`TaskTypeRegistry::__construct ` Register task types from configuration :ref:`TaskTypeRegistry::getClassForTaskType ` Returns the class that implements the given task type. :ref:`TaskTypeRegistry::getTaskForType ` ... ResourceCompressor ================== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\ResourceCompressor` ... :ref:`ResourceCompressor::__construct ` Constructor :ref:`ResourceCompressor::checkBaseDirectory ` Decides whether a file comes from one of the baseDirectories :ref:`ResourceCompressor::compressCssFile ` Compresses a CSS file Options: baseDirectories If set, only include files below one of the base directories :ref:`ResourceCompressor::compressCssFiles ` Compress multiple css files :ref:`ResourceCompressor::compressCssPregCallback ` Callback function for preg\_replace :ref:`ResourceCompressor::compressJsFile ` Compresses a javascript file :ref:`ResourceCompressor::compressJsFiles ` Compress multiple javascript files :ref:`ResourceCompressor::concatenateCssFiles ` Concatenates the Stylesheet files Options: baseDirectories If set, only include files below one of the base directories :ref:`ResourceCompressor::concatenateJsFiles ` Concatenates the JavaScript files :ref:`ResourceCompressor::createMergedCssFile ` Creates a merged CSS file :ref:`ResourceCompressor::createMergedFile ` Creates a merged file with given file type :ref:`ResourceCompressor::createMergedJsFile ` Creates a merged JS file :ref:`ResourceCompressor::cssFixRelativeUrlPaths ` Fixes the relative paths inside of url() references in CSS files :ref:`ResourceCompressor::cssFixStatements ` ... :ref:`ResourceCompressor::findAndReplaceUrlPathsByRegex ` Finds and replaces all URLs by using a given regex :ref:`ResourceCompressor::getFilenameFromMainDir ` Finds the relative path to a file, relative to the root path. :ref:`ResourceCompressor::retrieveExternalFile ` Retrieves an external file and stores it locally. :ref:`ResourceCompressor::returnFileReference ` Decides whether a client can deal with gzipped content or not and returns the according file name, based on HTTP\_ACCEPT\_ENCODING :ref:`ResourceCompressor::setBackPath ` Sets relative back path :ref:`ResourceCompressor::setInitialBackPath ` Sets relative back path :ref:`ResourceCompressor::setInitialPaths ` Sets initial values for paths. :ref:`ResourceCompressor::setInitialRelativePath ` Sets relative path to PATH\_site :ref:`ResourceCompressor::setInitialRootPath ` Sets absolute path to working directory :ref:`ResourceCompressor::setRelativePath ` Sets relative path to PATH\_site :ref:`ResourceCompressor::setRootPath ` Sets absolute path to working directory :ref:`ResourceCompressor::writeFileAndCompressed ` Writes $contents into file $filename together with a gzipped version into $filename.gz ResourceFactory =============== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\ResourceFactory` ... :ref:`ResourceFactory::__construct ` Inject signal slot dispatcher :ref:`ResourceFactory::convertFlexFormDataToConfigurationArray ` Converts a flexform data string to a flat array with key value pairs :ref:`ResourceFactory::createFolderObject ` Creates a folder to directly access (a part of) a storage. :ref:`ResourceFactory::createStorageObject ` Creates a storage object from a storage database row. :ref:`ResourceFactory::emitPostProcessStorageSignal ` Emits a signal after a resource storage was initialized :ref:`ResourceFactory::findBestMatchingStorageByLocalPath ` Checks whether a file resides within a real storage in local file system. If no match is found, uid 0 is returned which is a fallback storage pointing to PATH\_site. The file identifier is adapted accordingly to match the new storage's base path. :ref:`ResourceFactory::getFileIndexRepository ` Returns an instance of the FileIndexRepository :ref:`ResourceFactory::getFileObject ` Creates an instance of the file given UID. The $fileData can be supplied to increase performance. :ref:`ResourceFactory::getFileObjectByStorageAndIdentifier ` Gets an file object from storage by file identifier If the file is outside of the process folder it gets indexed and returned as file object afterwards If the file is within processing folder the file object will be directly returned :ref:`ResourceFactory::getFileObjectFromCombinedIdentifier ` Gets an file object from an identifier [storage]:[fileId] :ref:`ResourceFactory::getFileReferenceObject ` ... :ref:`ResourceFactory::getFolderObjectFromCombinedIdentifier ` Gets a folder object from an identifier [storage]:[fileId] :ref:`ResourceFactory::getIndexer ` Returns an instance of the Indexer :ref:`ResourceFactory::getInstance ` Gets a singleton instance of this class. :ref:`ResourceFactory::getObjectFromCombinedIdentifier ` Gets a file or folder object. :ref:`ResourceFactory::getProcessedFileRepository ` ... :ref:`ResourceFactory::getStorageObjectFromCombinedIdentifier ` Gets a storage object from a combined identifier :ref:`ResourceFactory::retrieveFileOrFolderObject ` Bulk function, can be used for anything to get a file or folder ResourceFactoryInterface ======================== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\ResourceFactoryInterface` ... ResourceInterface ================= :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\ResourceInterface` ... :ref:`ResourceInterface::getHashedIdentifier ` Get hashed identifier :ref:`ResourceInterface::getIdentifier ` Returns the identifier of this file :ref:`ResourceInterface::getName ` Returns the name of this file :ref:`ResourceInterface::getParentFolder ` ... :ref:`ResourceInterface::getStorage ` Get the storage this file is located in ResourceStorage =============== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\ResourceStorage` ... :ref:`ResourceStorage::__construct ` Constructor for a storage object. :ref:`ResourceStorage::addFile ` Moves a file from the local filesystem to this storage. :ref:`ResourceStorage::addFileAndFolderNameFilter ` ... :ref:`ResourceStorage::addFileMount ` Adds a filemount as a "filter" for users to only work on a subset of a storage object :ref:`ResourceStorage::addUploadedFile ` Adds an uploaded file into the Storage. Previously in ::file\_upload() :ref:`ResourceStorage::assureFileAddPermissions ` Checks if a file has the permission to be uploaded to a Folder/Storage. If not, throws an exception. :ref:`ResourceStorage::assureFileCopyPermissions ` Check if a file has the permission to be copied on a File/Folder/Storage, if not throw an exception :ref:`ResourceStorage::assureFileDeletePermissions ` Assures delete permission for given file. :ref:`ResourceStorage::assureFileMovePermissions ` Checks for permissions to move a file. :ref:`ResourceStorage::assureFileReadPermission ` Assures read permission for given file. :ref:`ResourceStorage::assureFileRenamePermissions ` Checks for permissions to rename a file. :ref:`ResourceStorage::assureFileUploadPermissions ` Checks if a file has the permission to be uploaded to a Folder/Storage. If not, throws an exception. :ref:`ResourceStorage::assureFileWritePermissions ` Assures write permission for given file. :ref:`ResourceStorage::assureFolderCopyPermissions ` Check if a file has the permission to be copied on a File/Folder/Storage, if not throw an exception :ref:`ResourceStorage::assureFolderDeletePermission ` Assures delete permission for given folder. :ref:`ResourceStorage::assureFolderMovePermissions ` Check if a file has the permission to be copied on a File/Folder/Storage, if not throw an exception :ref:`ResourceStorage::assureFolderReadPermission ` Assures read permission for given folder. :ref:`ResourceStorage::checkFileActionPermission ` Checks if a file operation (= action) is allowed on a File/Folder/Storage (= subject). :ref:`ResourceStorage::checkFileExtensionPermission ` If the fileName is given, checks it against the TYPO3\_CONF\_VARS[BE][fileDenyPattern] + and if the file extension is allowed. :ref:`ResourceStorage::checkFolderActionPermission ` ... :ref:`ResourceStorage::checkUserActionPermission ` Checks if the ACL settings allow for a certain action (is a user allowed to read a file or copy a folder). :ref:`ResourceStorage::copyFile ` 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 :ref:`ResourceStorage::copyFolder ` Copies a folder. :ref:`ResourceStorage::copyFolderBetweenStorages ` Copies a folder between storages. :ref:`ResourceStorage::createFile ` Creates a new file previously in ::func\_newfile() :ref:`ResourceStorage::createFolder ` Creates a new folder. previously in ::func\_newfolder() :ref:`ResourceStorage::deleteFile ` Previously in ::deleteFile() :ref:`ResourceStorage::deleteFolder ` Previously in ::folder\_delete() :ref:`ResourceStorage::dumpFileContents ` Outputs file Contents, clears output buffer first and sends headers accordingly. :ref:`ResourceStorage::emitPostFileAddSignal ` Emits the file post-add signal. :ref:`ResourceStorage::emitPostFileCopySignal ` Emits the file post-copy signal. :ref:`ResourceStorage::emitPostFileCreateSignal ` Emits the file post-create signal :ref:`ResourceStorage::emitPostFileDeleteSignal ` Emits the file post-deletion signal :ref:`ResourceStorage::emitPostFileMoveSignal ` Emits the file post-move signal. :ref:`ResourceStorage::emitPostFileRenameSignal ` Emits the file post-rename signal. :ref:`ResourceStorage::emitPostFileReplaceSignal ` Emits the file post-replace signal :ref:`ResourceStorage::emitPostFileSetContentsSignal ` Emits the file post-set-contents signal :ref:`ResourceStorage::emitPostFolderAddSignal ` Emits the folder post-add signal. :ref:`ResourceStorage::emitPostFolderCopySignal ` Emits the folder post-copy signal. :ref:`ResourceStorage::emitPostFolderDeleteSignal ` Emits folder post-deletion signal.. :ref:`ResourceStorage::emitPostFolderMoveSignal ` Emits the folder post-move signal. :ref:`ResourceStorage::emitPostFolderRenameSignal ` Emits the folder post-rename signal. :ref:`ResourceStorage::emitPreFileAddSignal ` Emits file pre-add signal. :ref:`ResourceStorage::emitPreFileCopySignal ` Emits file pre-copy signal. :ref:`ResourceStorage::emitPreFileDeleteSignal ` Emits the file pre-deletion signal. :ref:`ResourceStorage::emitPreFileMoveSignal ` Emits the file pre-move signal. :ref:`ResourceStorage::emitPreFileRenameSignal ` Emits the file pre-rename signal :ref:`ResourceStorage::emitPreFileReplaceSignal ` Emits the file pre-replace signal. :ref:`ResourceStorage::emitPreFolderAddSignal ` Emits the folder pre-add signal. :ref:`ResourceStorage::emitPreFolderCopySignal ` Emits the folder pre-copy signal. :ref:`ResourceStorage::emitPreFolderDeleteSignal ` Emits the folder pre-deletion signal. :ref:`ResourceStorage::emitPreFolderMoveSignal ` Emits the folder pre-move signal. :ref:`ResourceStorage::emitPreFolderRenameSignal ` Emits the folder pre-rename signal. :ref:`ResourceStorage::emitPreGeneratePublicUrlSignal ` Emits file pre-processing signal when generating a public url for a file or folder. :ref:`ResourceStorage::fetchFolderListFromDriver ` ... :ref:`ResourceStorage::getCapabilities ` Returns the capabilities of this storage. :ref:`ResourceStorage::getConfiguration ` Gets the configuration. :ref:`ResourceStorage::getDefaultFolder ` Returns the default folder where new files are stored if no other folder is given. :ref:`ResourceStorage::getDriver ` Returns the driver object belonging to this storage. :ref:`ResourceStorage::getDriverType ` ... :ref:`ResourceStorage::getEvaluatePermissions ` Gets whether the permissions to access or write into this storage should be checked or not. :ref:`ResourceStorage::getFile ` Gets a file by identifier. :ref:`ResourceStorage::getFileAndFolderNameFilters ` Returns the file and folder name filters used by this storage. :ref:`ResourceStorage::getFileByIdentifier ` Deprecated function, don't use it. Will be removed in some later revision. :ref:`ResourceStorage::getFileContents ` Get contents of a file object :ref:`ResourceStorage::getFileFactory ` ... :ref:`ResourceStorage::getFileForLocalProcessing ` Copies a file from the storage for local processing. :ref:`ResourceStorage::getFileIdentifiersInFolder ` ... :ref:`ResourceStorage::getFileIndexRepository ` ... :ref:`ResourceStorage::getFileInfo ` Gets information about a file. :ref:`ResourceStorage::getFileInfoByIdentifier ` Gets information about a file by its identifier. :ref:`ResourceStorage::getFileList ` Returns a list of files in a given path, filtered by some custom filter methods. :ref:`ResourceStorage::getFileMounts ` Returns all file mounts that are registered with this storage. :ref:`ResourceStorage::getFileProcessingService ` ... :ref:`ResourceStorage::getFilesInFolder ` ... :ref:`ResourceStorage::getFolder ` ... :ref:`ResourceStorage::getFolderByIdentifier ` Deprecated function, don't use it. Will be removed in some later revision. :ref:`ResourceStorage::getFolderIdentifierFromFileIdentifier ` ... :ref:`ResourceStorage::getFolderIdentifiersInFolder ` ... :ref:`ResourceStorage::getFolderList ` Returns a list of folders in a given path. :ref:`ResourceStorage::getFoldersInFolder ` ... :ref:`ResourceStorage::getIndexer ` Gets the Indexer. :ref:`ResourceStorage::getName ` Returns the name of this storage. :ref:`ResourceStorage::getObjectManager ` Gets the ObjectManager. :ref:`ResourceStorage::getProcessingFolder ` Getter function to return the folder where the files can be processed. Does not check for access rights here. :ref:`ResourceStorage::getPublicUrl ` 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. :ref:`ResourceStorage::getRole ` Gets the role of a folder. :ref:`ResourceStorage::getRootLevelFolder ` 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. :ref:`ResourceStorage::getSignalSlotDispatcher ` Get the SignalSlot dispatcher. :ref:`ResourceStorage::getStorageRecord ` Gets the storage record. :ref:`ResourceStorage::getUid ` Returns the UID of this storage. :ref:`ResourceStorage::getUniqueName ` 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 :ref:`ResourceStorage::hasCapability ` Returns TRUE if this storage has the given capability. :ref:`ResourceStorage::hasChildren ` Tells whether there are children in this storage. :ref:`ResourceStorage::hasFile ` Returns TRUE if the specified file exists :ref:`ResourceStorage::hasFileInFolder ` Checks if the queried file in the given folder exists :ref:`ResourceStorage::hasFolder ` Returns TRUE if the specified folder exists. :ref:`ResourceStorage::hasFolderInFolder ` Checks if the given file exists in the given folder :ref:`ResourceStorage::hashFile ` Creates a (cryptographic) hash for a file. :ref:`ResourceStorage::hashFileByIdentifier ` Creates a (cryptographic) hash for a fileIdentifier. :ref:`ResourceStorage::isBrowsable ` ... :ref:`ResourceStorage::isDefault ` ... :ref:`ResourceStorage::isOnline ` ... :ref:`ResourceStorage::isProcessingFolder ` Returns TRUE if folder that is in current storage is set as processing folder for one of the existing storages :ref:`ResourceStorage::isPublic ` ... :ref:`ResourceStorage::isWithinFileMountBoundaries ` 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. :ref:`ResourceStorage::isWithinFolder ` Checks if a resource (file or folder) is within the given folder :ref:`ResourceStorage::isWithinProcessingFolder ` Returns TRUE if the specified file is in a folder that is set a processing for a storage :ref:`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. :ref:`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. :ref:`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. :ref:`ResourceStorage::moveFile ` Moves a $file into a $targetFolder the target folder has to be part of this storage previously in ::func\_move() :ref:`ResourceStorage::moveFolder ` 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. :ref:`ResourceStorage::moveFolderBetweenStorages ` Moves the given folder from a different storage to the target folder in this storage. :ref:`ResourceStorage::processFile ` ... :ref:`ResourceStorage::renameFile ` Previously in ::func\_rename() :ref:`ResourceStorage::renameFolder ` Previously in ::folder\_move() :ref:`ResourceStorage::replaceFile ` Replaces a file with a local file (e.g. a freshly uploaded file) :ref:`ResourceStorage::resetFileAndFolderNameFiltersToDefault ` ... :ref:`ResourceStorage::setConfiguration ` Sets the configuration. :ref:`ResourceStorage::setDefault ` ... :ref:`ResourceStorage::setDriver ` Sets the storage that belongs to this storage. :ref:`ResourceStorage::setEvaluatePermissions ` Sets whether the permissions to access or write into this storage should be checked or not. :ref:`ResourceStorage::setFileAndFolderNameFilters ` ... :ref:`ResourceStorage::setFileContents ` Set contents of a file object. :ref:`ResourceStorage::setUserPermissions ` Sets the user permissions of the storage. :ref:`ResourceStorage::unsetFileAndFolderNameFilters ` Unsets the file and folder name filters, thus making this storage return unfiltered file lists. :ref:`ResourceStorage::updateProcessedFile ` Updates a processed file with a new file from the local filesystem. :ref:`ResourceStorage::usesCaseSensitiveIdentifiers ` Returns TRUE if the identifiers used by this storage are case-sensitive. ResourceStorageInterface ======================== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\ResourceStorageInterface` ... FileMetadataPermissionsAspect ============================= :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Security\\FileMetadataPermissionsAspect` ... :ref:`FileMetadataPermissionsAspect::checkFileWriteAccessForFileMetaData ` Checks write access to the file belonging to a metadata entry :ref:`FileMetadataPermissionsAspect::checkModifyAccessList ` ... :ref:`FileMetadataPermissionsAspect::checkRecordUpdateAccess ` This hook is called before any write operation by DataHandler :ref:`FileMetadataPermissionsAspect::isAllowedToShowEditForm ` Deny access to the edit form. This is not mandatory, but better to show this right away that access is denied. StoragePermissionsAspect ======================== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Security\\StoragePermissionsAspect` ... :ref:`StoragePermissionsAspect::__construct ` ... :ref:`StoragePermissionsAspect::addFileMountsToStorage ` Adds file mounts from the user's file mount records :ref:`StoragePermissionsAspect::addUserPermissionsToStorage ` ... FileProcessingService ===================== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Service\\FileProcessingService` ... :ref:`FileProcessingService::emitPostFileProcessSignal ` Emits file post-processing signal. :ref:`FileProcessingService::emitPreFileProcessSignal ` Emits file pre-processing signal. :ref:`FileProcessingService::getSignalSlotDispatcher ` Get the SignalSlot dispatcher FrontendContentAdapterService ============================= :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Service\\FrontendContentAdapterService` ... :ref:`FrontendContentAdapterService::fieldIsInType ` Check if fieldis in type :ref:`FrontendContentAdapterService::getPageRepository ` ... :ref:`FrontendContentAdapterService::registerAdditionalTypeForMigration ` Registers an additional record type for an existing migration configuration. For use in ext\_localconf.php files. :ref:`FrontendContentAdapterService::registerFieldForMigration ` Registers an additional field for migration. For use in ext\_localconf.php files IndexerService ============== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Service\\IndexerService` ... :ref:`IndexerService::__construct ` empty constructor, nothing to do here yet :ref:`IndexerService::emitPostFileIndexSignal ` Signal that is called after a file object was indexed :ref:`IndexerService::emitPostGatherFileInformationSignal ` Signal that is called after a file object was indexed :ref:`IndexerService::emitPostMultipleFilesIndexSignal ` Signal that is called after multiple file objects were indexed :ref:`IndexerService::emitPreFileIndexSignal ` Signal that is called before a file object was indexed :ref:`IndexerService::emitPreGatherFileInformationSignal ` Signal that is called before the file information is fetched helpful if somebody wants to preprocess the record information :ref:`IndexerService::emitPreMultipleFilesIndexSignal ` Signal that is called before a bunch of file objects are indexed :ref:`IndexerService::gatherFileInformation ` Fetches the information for a sys\_file record based on a single file this function shouldn't be used, if someone needs to fetch the file information from a file object, should be done by getProperties etc :ref:`IndexerService::getFactory ` Getter function for the fileFactory :ref:`IndexerService::getFileIndexRepository ` ... :ref:`IndexerService::getMetaDataRepository ` ... :ref:`IndexerService::getObjectManager ` Get the ObjectManager :ref:`IndexerService::getRepository ` Internal function to retrieve the file repository, if it does not exist, an instance will be created :ref:`IndexerService::getSignalSlotDispatcher ` Get the SignalSlot dispatcher :ref:`IndexerService::indexFiles ` Indexes an array of file objects currently this is done in a simple way, however could be changed to be more performant MagicImageService ================= :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Service\\MagicImageService` ... :ref:`MagicImageService::createMagicImage ` Creates a magic image :ref:`MagicImageService::setMagicImageMaximumDimensions ` Set maximum dimensions of magic images based on RTE configuration UserFileInlineLabelService ========================== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Service\\UserFileInlineLabelService` ... :ref:`UserFileInlineLabelService::getInlineLabel ` Get the user function label for the file\_reference table UserFileMountService ==================== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Service\\UserFileMountService` ... :ref:`UserFileMountService::getSubfoldersForOptionList ` Simple function to make a hierarchical subfolder request into a "flat" option list UserStorageCapabilityService ============================ :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Service\\UserStorageCapabilityService` ... :ref:`UserStorageCapabilityService::renderFileInformationContent ` Renders a HTML block containing the checkbox for field "is\_public". :ref:`UserStorageCapabilityService::renderIsPublic ` UserFunc function for rendering field "is\_public". There are some edge cases where "is\_public" can never be marked as true in the BE, for instance for storage located outside the document root or for storages driven by special driver such as Flickr, ... StorageRepository ================= :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\StorageRepository` ... :ref:`StorageRepository::createDomainObject ` Creates an object managed by this repository. :ref:`StorageRepository::findByUid ` ... :ref:`StorageRepository::initializeLocalCache ` Initializes the Storage :ref:`StorageRepository::testCaseSensitivity ` Test if the local filesystem is case sensitive BackendUtility ============== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Utility\\BackendUtility` ... ListUtility =========== :ref:`t3api62:TYPO3\\CMS\\Core\\Resource\\Utility\\ListUtility` ...