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¶

t3api62:TYPO3\CMS\Core\Resource\AbstractFile

…

AbstractFile::copyTo

Copies this file into a target folder

AbstractFile::delete

Deletes this file from its storage. This also means that this object becomes useless.

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.

AbstractFile::getCombinedIdentifier

Returns a combined identifier of this file, i.e. the storage UID and the folder identifier separated by a colon “:”.

AbstractFile::getContents

Get the contents of this file

AbstractFile::getCreationTime

Returns the creation time of the file as Unix timestamp

AbstractFile::getExtension

Get the extension of this file in a lower-case variant

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.

AbstractFile::getHashedIdentifier

Get hashed identifier

AbstractFile::getIdentifier

Returns the identifier of this file

AbstractFile::getMimeType

Get the MIME type of this file

AbstractFile::getModificationTime

Returns the date (as UNIX timestamp) the file was last modified.

AbstractFile::getName

Returns the name of this file

AbstractFile::getNameWithoutExtension

Returns the basename (the name without extension) of this file.

AbstractFile::getParentFolder

Returns the parent folder.

AbstractFile::getProperties

Returns the properties of this object.

AbstractFile::getProperty

Returns a property value

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.

AbstractFile::getSha1

Returns the Sha1 of this file

AbstractFile::getSize

Returns the size of this file

AbstractFile::getStorage

Get the storage this file is located in

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

AbstractFile::getUid

Returns the uid of this file

AbstractFile::hasProperty

Returns true if the given property key exists for this file.

AbstractFile::isDeleted

Returns TRUE if this file has been deleted

AbstractFile::moveTo

Moves the file into the target folder

AbstractFile::rename

Renames this file.

AbstractFile::setContents

Replace the current file contents with the given string

AbstractFile::setDeleted

…

AbstractFile::setIdentifier

Set the identifier of this file

AbstractFile::setStorage

Sets the storage this file is located in. This is only meant for -internal usage; don’t use it to move files.

AbstractFile::updateProperties

Updates properties of this object. This method is used to reconstitute settings from the database into this object after being intantiated.

AbstractRepository¶

t3api62:TYPO3\CMS\Core\Resource\AbstractRepository: …
AbstractRepository::__call: Magic call method for repository methods.
AbstractRepository::__construct: Creates this object.
AbstractRepository::add: Adds an object to this repository.
AbstractRepository::countAll: Returns the total number objects of this repository.
AbstractRepository::createDomainObject: Creates an object managed by this repository.
AbstractRepository::createQuery: Returns a query for objects of this repository
AbstractRepository::findAll: Returns all objects of this repository.
AbstractRepository::findByIdentifier: Finds an object matching the given identifier.
AbstractRepository::findByUid: Finds an object matching the given identifier.
AbstractRepository::getAddedObjects: …
AbstractRepository::getDatabaseConnection: …
AbstractRepository::getEntityClassName: Returns the object type this repository is managing.
AbstractRepository::getEnvironmentMode: Function to return the current TYPO3_MODE. This function can be mocked in unit tests to be able to test frontend behaviour.
AbstractRepository::getRemovedObjects: …
AbstractRepository::getWhereClauseForEnabledFields: get the WHERE clause for the enabled fields of this TCA table depending on the context
AbstractRepository::remove: Removes an object from this repository.
AbstractRepository::removeAll: …
AbstractRepository::replace: Replaces an object by another.
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 )
AbstractRepository::setDefaultQuerySettings: Sets the default query settings to be used in this repository
AbstractRepository::update: Replaces an existing object with the same identifier by the given object

AbstractFileCollection¶

t3api62:TYPO3\CMS\Core\Resource\Collection\AbstractFileCollection: …
AbstractFileCollection::add: Adds a file to this collection.
AbstractFileCollection::fromArray: Similar to method in , but without $this->itemTableName= $array[‘table_name’], but with $this->storageItemsFieldContent = $array[self::$storageItemsField];
AbstractFileCollection::getItemsCriteria: Gets ths items criteria.
AbstractFileCollection::getPersistableDataArray: Returns an array of the persistable properties and contents which are processable by TCEmain.
AbstractFileCollection::removeAll: Removes all elements of the current collection.
AbstractFileCollection::setDescription: Sets the description.
AbstractFileCollection::setItemsCriteria: Sets the items criteria.
AbstractFileCollection::setTitle: Sets the title.

CategoryBasedFileCollection¶

t3api62:TYPO3\CMS\Core\Resource\Collection\CategoryBasedFileCollection: …
CategoryBasedFileCollection::getDatabaseConnection: Gets the database object.
CategoryBasedFileCollection::loadContents: Populates the content-entries of the collection

FileCollectionRegistry¶

t3api62:TYPO3\CMS\Core\Resource\Collection\FileCollectionRegistry: …
FileCollectionRegistry::__construct: Constructor
FileCollectionRegistry::addTypeToTCA: Add the type to the TCA of sys_file_collection
FileCollectionRegistry::fileCollectionTypeExists: Checks if the given FileCollection type exists
FileCollectionRegistry::getFileCollectionClass: Returns a class name for a given type
FileCollectionRegistry::registerFileCollectionClass: Register a (new) FileCollection type

FolderBasedFileCollection¶

t3api62:TYPO3\CMS\Core\Resource\Collection\FolderBasedFileCollection

…

FolderBasedFileCollection::getItemsCriteria

Gets the items criteria.

FolderBasedFileCollection::getPersistableDataArray

Returns an array of the persistable properties and contents which are processable by TCEmain.

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¶

t3api62:TYPO3\CMS\Core\Resource\Collection\StaticFileCollection: …

AbstractDriver¶

t3api62:TYPO3\CMS\Core\Resource\Driver\AbstractDriver: …
AbstractDriver::__construct: Creates this object.
AbstractDriver::canonicalizeAndCheckFileIdentifier: Makes sure the identifier given as parameter is valid
AbstractDriver::canonicalizeAndCheckFilePath: Makes sure the path given as parameter is valid
AbstractDriver::canonicalizeAndCheckFolderIdentifier: Makes sure the identifier given as parameter is valid
AbstractDriver::getCapabilities: Returns the capabilities of this driver.
AbstractDriver::getTemporaryPathForFile: Returns a temporary path for a given file, including the file extension.
AbstractDriver::hasCapability: Returns TRUE if this driver has the given capability.
AbstractDriver::hashIdentifier: Hashes a file identifier, taking the case sensitivity of the file system into account. This helps mitigating problems with case-insensitive databases.
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
AbstractDriver::isValidFilename: Checks a fileName for validity. This could be overidden in concrete drivers if they have different file naming rules.
AbstractDriver::sanitizeFileName: Basic implementation of the method that does directly return the file name as is.
AbstractDriver::setStorageUid: Sets the storage uid the driver belongs to

AbstractHierarchicalFilesystemDriver¶

t3api62:TYPO3\CMS\Core\Resource\Driver\AbstractHierarchicalFilesystemDriver: …
AbstractHierarchicalFilesystemDriver::canonicalizeAndCheckFileIdentifier: Makes sure the Path given as parameter is valid
AbstractHierarchicalFilesystemDriver::canonicalizeAndCheckFilePath: Makes sure the Path given as parameter is valid
AbstractHierarchicalFilesystemDriver::canonicalizeAndCheckFolderIdentifier: Makes sure the Path given as parameter is valid
AbstractHierarchicalFilesystemDriver::getParentFolderIdentifierOfIdentifier: Returns the identifier of the folder the file resides in
AbstractHierarchicalFilesystemDriver::isPathValid: Wrapper for ::validPathStr()

DriverInterface¶

t3api62:TYPO3\CMS\Core\Resource\Driver\DriverInterface

…

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.

DriverInterface::copyFileWithinStorage

…

DriverInterface::copyFolderWithinStorage

…

DriverInterface::createFile

Creates a new (empty) file and returns the identifier.

DriverInterface::createFolder

Creates a folder, within a parent folder. If no parent folder is given, a root level folder will be created

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)!

DriverInterface::deleteFolder

Removes a folder in filesystem.

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.

DriverInterface::fileExists

Checks if a file exists.

DriverInterface::fileExistsInFolder

Checks if a file inside a folder exists

DriverInterface::folderExists

Checks if a folder exists.

DriverInterface::folderExistsInFolder

Checks if a folder inside a folder exists.

DriverInterface::getCapabilities

Returns the capabilities of this driver.

DriverInterface::getDefaultFolder

Returns the identifier of the default folder new files should be put into.

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.

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!

DriverInterface::getFileInfoByIdentifier

Returns information about a file.

DriverInterface::getFilesInFolder

Returns a list of files inside the specified path

DriverInterface::getFolderInfoByIdentifier

Returns information about a file.

DriverInterface::getFoldersInFolder

Returns a list of folders inside the specified path

DriverInterface::getParentFolderIdentifierOfIdentifier

Returns the identifier of the folder the file resides in

DriverInterface::getPermissions

Returns the permissions of a file/folder as an array (keys r, w) of boolean flags

DriverInterface::getPublicUrl

Returns the public URL to a file. Either fully qualified URL or relative to PATH_site (rawurlencoded).

DriverInterface::getRootLevelFolder

Returns the identifier of the root level folder of the storage.

DriverInterface::hasCapability

Returns TRUE if this driver has the given capability.

DriverInterface::hash

Creates a hash for a file.

DriverInterface::hashIdentifier

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

DriverInterface::initialize

Initializes this object. This is called by the storage after the driver has been attached.

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

DriverInterface::isFolderEmpty

Checks if a folder contains files and (if supported) other folders.

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.

DriverInterface::mergeConfigurationCapabilities

Merges the capabilites merged by the user at the storage configuration into the actual capabilities of the driver and returns the result.

DriverInterface::moveFileWithinStorage

…

DriverInterface::moveFolderWithinStorage

…

DriverInterface::processConfiguration

…

DriverInterface::renameFile

Renames a file in this storage.

DriverInterface::renameFolder

Renames a folder in this storage.

DriverInterface::replaceFile

Replaces a file with file in local file system.

DriverInterface::sanitizeFileName

Cleans a fileName from not allowed characters

DriverInterface::setFileContents

Sets the contents of a file to the specified value.

DriverInterface::setStorageUid

Sets the storage uid the driver belongs to

DriverRegistry¶

t3api62:TYPO3\CMS\Core\Resource\Driver\DriverRegistry: …
DriverRegistry::__construct: Creates this object.
DriverRegistry::addDriversToTCA: …
DriverRegistry::driverExists: Checks if the given driver exists
DriverRegistry::getDriverClass: Returns a class name for a given class name or short name.
DriverRegistry::registerDriverClass: Registers a driver class with an optional short name.

LocalDriver¶

t3api62:TYPO3\CMS\Core\Resource\Driver\LocalDriver

…

LocalDriver::__construct

…

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.

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.

LocalDriver::calculateBasePath

Calculates the absolute path to this drivers storage location.

LocalDriver::copyFileToTemporaryPath

Copies a file to a temporary path and returns that path.

LocalDriver::copyFileWithinStorage

…

LocalDriver::createFile

Creates a new (empty) file and returns the identifier.

LocalDriver::createFolder

Creates a folder, within a parent folder. If no parent folder is given, a rootlevel folder will be created

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.

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)!

LocalDriver::deleteFolder

Removes a folder from this storage.

LocalDriver::determineBaseUrl

…

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.

LocalDriver::extractFileInformation

Extracts information about a file from the filesystem.

LocalDriver::fileExists

Checks if a file exists.

LocalDriver::fileExistsInFolder

Checks if a file inside a folder exists

LocalDriver::folderExists

Checks if a folder exists.

LocalDriver::folderExistsInFolder

Checks if a folder inside a folder exists.

LocalDriver::getAbsoluteBasePath

Returns the absolute path of the folder this driver operates on.

LocalDriver::getAbsolutePath

Returns the absolute path of a file or folder.

LocalDriver::getCharsetConversion

Gets the charset conversion object.

LocalDriver::getDefaultFolder

Returns identifier of the default folder new files should be put into.

LocalDriver::getDirectoryItemList

Generic wrapper for extracting a list of items from a path.

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.

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.

LocalDriver::getFileInfoByIdentifier

Returns information about a file.

LocalDriver::getFilesInFolder

Returns a list of files inside the specified path

LocalDriver::getFolderInfoByIdentifier

Returns information about a folder.

LocalDriver::getFolderInFolder

Returns the Identifier for a folder within a given folder.

LocalDriver::getFoldersInFolder

Returns a list of folders inside the specified path

LocalDriver::getMimeTypeOfFile

Get MIME type of file.

LocalDriver::getPermissions

Returns the permissions of a file/folder as an array (keys r, w) of boolean flags

LocalDriver::getPublicUrl

Returns the public URL to a file. For the local driver, this will always return a path relative to PATH_site.

LocalDriver::getRole

Returns the role of an item (currently only folders; can later be extended for files as well)

LocalDriver::getRootLevelFolder

Returns the Identifier of the root level folder of the storage.

LocalDriver::getSpecificFileInformation

Extracts a specific FileInformation from the FileSystems.

LocalDriver::hash

Creates a (cryptographic) hash for a file.

LocalDriver::initialize

Initializes this object. This is called by the storage after the driver has been attached.

LocalDriver::isFolderEmpty

Checks if a folder contains files and (if supported) other folders.

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.

LocalDriver::mergeConfigurationCapabilities

Merges the capabilites merged by the user at the storage configuration into the actual capabilities of the driver and returns the result.

LocalDriver::moveFileWithinStorage

…

LocalDriver::moveFolderWithinStorage

…

LocalDriver::processConfiguration

Processes the configuration for this driver.

LocalDriver::renameFile

Renames a file in this storage.

LocalDriver::renameFolder

Renames a folder in this storage.

LocalDriver::replaceFile

Replaces the contents (and file-specific metadata) of a file object with a local file.

LocalDriver::sanitizeFileName

Returns a string where any character not matching [.a-zA-Z0-9_-] is substituted by ‘_’ Trailing dots are removed

Previously in ::cleanFileName()

LocalDriver::setFileContents

Sets the contents of a file to the specified value.

Exception¶

t3api62:TYPO3\CMS\Core\Resource\Exception: …

AbstractFileOperationException¶

t3api62:TYPO3\CMS\Core\Resource\Exception\AbstractFileOperationException: …

ExistingTargetFileNameException¶

t3api62:TYPO3\CMS\Core\Resource\Exception\ExistingTargetFileNameException: …

ExistingTargetFolderException¶

t3api62:TYPO3\CMS\Core\Resource\Exception\ExistingTargetFolderException: …

FileDoesNotExistException¶

t3api62:TYPO3\CMS\Core\Resource\Exception\FileDoesNotExistException: …

FileOperationErrorException¶

t3api62:TYPO3\CMS\Core\Resource\Exception\FileOperationErrorException: …

FolderDoesNotExistException¶

t3api62:TYPO3\CMS\Core\Resource\Exception\FolderDoesNotExistException: …

IllegalFileExtensionException¶

t3api62:TYPO3\CMS\Core\Resource\Exception\IllegalFileExtensionException: …

InsufficientFileAccessPermissionsException¶

t3api62:TYPO3\CMS\Core\Resource\Exception\InsufficientFileAccessPermissionsException: …

InsufficientFileReadPermissionsException¶

t3api62:TYPO3\CMS\Core\Resource\Exception\InsufficientFileReadPermissionsException: …

InsufficientFileWritePermissionsException¶

t3api62:TYPO3\CMS\Core\Resource\Exception\InsufficientFileWritePermissionsException: …

InsufficientFolderAccessPermissionsException¶

t3api62:TYPO3\CMS\Core\Resource\Exception\InsufficientFolderAccessPermissionsException: …

InsufficientFolderReadPermissionsException¶

t3api62:TYPO3\CMS\Core\Resource\Exception\InsufficientFolderReadPermissionsException: …

InsufficientFolderWritePermissionsException¶

t3api62:TYPO3\CMS\Core\Resource\Exception\InsufficientFolderWritePermissionsException: …

InsufficientUserPermissionsException¶

t3api62:TYPO3\CMS\Core\Resource\Exception\InsufficientUserPermissionsException: …

InvalidConfigurationException¶

t3api62:TYPO3\CMS\Core\Resource\Exception\InvalidConfigurationException: …

InvalidFileException¶

t3api62:TYPO3\CMS\Core\Resource\Exception\InvalidFileException: …

InvalidFileNameException¶

t3api62:TYPO3\CMS\Core\Resource\Exception\InvalidFileNameException: …

InvalidFolderException¶

t3api62:TYPO3\CMS\Core\Resource\Exception\InvalidFolderException: …

InvalidPathException¶

t3api62:TYPO3\CMS\Core\Resource\Exception\InvalidPathException: …

InvalidTargetFolderException¶

t3api62:TYPO3\CMS\Core\Resource\Exception\InvalidTargetFolderException: …

InvalidUidException¶

t3api62:TYPO3\CMS\Core\Resource\Exception\InvalidUidException: …

NotInMountPointException¶

t3api62:TYPO3\CMS\Core\Resource\Exception\NotInMountPointException: …

ResourceDoesNotExistException¶

t3api62:TYPO3\CMS\Core\Resource\Exception\ResourceDoesNotExistException: …

ResourcePermissionsUnavailableException¶

t3api62:TYPO3\CMS\Core\Resource\Exception\ResourcePermissionsUnavailableException: …

UploadException¶

t3api62:TYPO3\CMS\Core\Resource\Exception\UploadException: …

UploadSizeException¶

t3api62:TYPO3\CMS\Core\Resource\Exception\UploadSizeException: …

File¶

t3api62:TYPO3\CMS\Core\Resource\File

…

File::__construct

Constructor for a file object. Should normally not be used directly, use the corresponding factory methods instead.

File::_getMetaData

Returns the MetaData

File::_getPropertyRaw

…

File::_updateMetaDataProperties

Updates MetaData properties

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

File::checkActionPermission

Check if a file operation (= action) is allowed for this file

File::getContents

Get the contents of this file

File::getFileIndexRepository

…

File::getIndexerService

Internal function to retrieve the indexer service, if it does not exist, an instance will be created

File::getMetaDataRepository

…

File::getProperties

Returns the properties of this object.

File::getProperty

Returns a property value

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.

File::getSha1

Gets SHA1 hash.

File::getUpdatedProperties

Returns the names of all properties that have been updated in this record

File::hasProperty

Checks if the file has a (metadata) property which can be retrieved by “getProperty”

File::isIndexed

Returns TRUE if this file is indexed

File::isMissing

…

File::loadMetaData

…

File::process

Returns a modified version of the file.

File::setContents

Replace the current file contents with the given string

File::setIndexingInProgess

…

File::setMissing

…

File::toArray

Returns an array representation of the file. (This is used by the generic listing module vidi when displaying file records.)

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¶

t3api62:TYPO3\CMS\Core\Resource\FileCollectionRepository: …
FileCollectionRepository::createDomainObject: Creates a record collection domain object.
FileCollectionRepository::findByUid: Finds a record collection by uid.
FileCollectionRepository::getFileFactory: Gets the file factory.

FileInterface¶

t3api62:TYPO3\CMS\Core\Resource\FileInterface

…

FileInterface::delete

Deletes this file from its storage. This also means that this object becomes useless.

FileInterface::getContents

Get the contents of this file

FileInterface::getCreationTime

Returns the creation time of the file as Unix timestamp

FileInterface::getExtension

Get the file extension

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.

FileInterface::getMimeType

Get the MIME type of this file

FileInterface::getModificationTime

Returns the modification time of the file as Unix timestamp

FileInterface::getNameWithoutExtension

Returns the basename (the name without extension) of this file.

FileInterface::getProperty

Get the value of the $key property.

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.

FileInterface::getSha1

Returns the Sha1 of this file

FileInterface::getSize

Returns the size of this file

FileInterface::hasProperty

Returns true if the given key exists for this file.

FileInterface::isIndexed

Returns TRUE if this file is indexed

FileInterface::rename

Renames this file.

FileInterface::setContents

Replace the current file contents with the given string.

FileInterface::toArray

Returns an array representation of the file. (This is used by the generic listing module vidi when displaying file records.)

FileReference¶

t3api62:TYPO3\CMS\Core\Resource\FileReference

…

FileReference::delete

…

FileReference::getAlternative

Returns the alternative text to this image

TODO: Possibly move this to the image domain object instead

FileReference::getCombinedIdentifier

Returns a combined identifier of the underlying original file

FileReference::getContents

Get the contents of this file

FileReference::getCreationTime

Returns the creation time of the file as Unix timestamp

FileReference::getDescription

Returns the description text to this file

TODO: Possibly move this to the image domain object instead

FileReference::getExtension

Get the file extension of this file

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.

FileReference::getHashedIdentifier

Get hashed identifier

FileReference::getIdentifier

Returns the identifier of the underlying original file

FileReference::getLink

Returns the link that should be active when clicking on this image

TODO: Move this to the image domain object instead

FileReference::getMimeType

Get the MIME type of this file

FileReference::getModificationTime

Returns the modification time of the file as Unix timestamp

FileReference::getName

Returns the name of this file

FileReference::getNameWithoutExtension

Returns the basename (the name without extension) of this file.

FileReference::getOriginalFile

Gets the original file being referenced.

FileReference::getParentFolder

Returns the parent folder.

FileReference::getProperties

Gets all properties, falling back to values of the parent.

FileReference::getProperty

Gets a property, falling back to values of the parent.

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.

FileReference::getReferenceProperties

Gets all properties of the file reference.

FileReference::getReferenceProperty

Gets a property of the file reference.

FileReference::getSha1

Returns the Sha1 of this file

FileReference::getSize

Returns the size of this file

FileReference::getStorage

Get the storage the original file is located in

FileReference::getTitle

Returns the title text to this image

TODO: Possibly move this to the image domain object instead

FileReference::getType

Returns the fileType of this file

FileReference::getUid

…

FileReference::hasProperty

Returns true if the given key exists for this file.

FileReference::isIndexed

…

FileReference::isMissing

Check if file is marked as missing by indexer

FileReference::rename

Renames the fileName in this particular usage.

FileReference::restoreNonNullValuesCallback

Callback to handle the NULL value feature

FileReference::setContents

Replace the current file contents with the given string

FileReference::toArray

Returns an array representation of the file. (This is used by the generic listing module vidi when displaying file records.)

FileRepository¶

t3api62:TYPO3\CMS\Core\Resource\FileRepository: …
FileRepository::addToIndex: …
FileRepository::createDomainObject: Creates an object managed by this repository.
FileRepository::createFileReferenceObject: …
FileRepository::findBySha1Hash: Returns all files with the corresponding SHA-1 hash. This is queried against the database, so only indexed files will be found
FileRepository::findByUid: …
FileRepository::findFileReferenceByUid: …
FileRepository::getFileIndexRecord: Returns an index record of a file, or FALSE if the file is not indexed.
FileRepository::getFileIndexRecordsForFolder: Returns the index-data of all files within that folder
FileRepository::getFileIndexRepository: Return a file index repository
FileRepository::getFileIndexStatus: Checks the index status of a file and returns FALSE if the file is not indexed, the uid otherwise.
FileRepository::getIndexerService: Internal function to retrieve the indexer service, if it does not exist, an instance will be created
FileRepository::update: Updates an existing file object in the database

FileExtensionFilter¶

t3api62:TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter

…

FileExtensionFilter::convertToLowercaseArray

Converts mixed (string or array) input arguments into an array, NULL if empty.

All array values will be converted to lower case.

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.

FileExtensionFilter::filterInlineChildren

Entry method for use as TCEMain “inline” field filter

FileExtensionFilter::isAllowed

Checks whether a file is allowed according to the criteria defined in the class variables ($this->allowedFileExtensions etc.)

FileExtensionFilter::setAllowedFileExtensions

Set allowed file extensions

FileExtensionFilter::setDisallowedFileExtensions

Set disallowed file extensions

FileNameFilter¶

t3api62:TYPO3\CMS\Core\Resource\Filter\FileNameFilter: …
FileNameFilter::filterHiddenFilesAndFolders: …
FileNameFilter::getShowHiddenFilesAndFolders: Gets the info whether the hidden files are also displayed currently
FileNameFilter::setShowHiddenFilesAndFolders: set the flag to show (or hide) the hidden files

Folder¶

t3api62:TYPO3\CMS\Core\Resource\Folder

…

Folder::__construct

Initialization of the folder

Folder::addFile

Adds a file from the local server disk. If the file already exists and overwriting is disabled,

Folder::addUploadedFile

Adds an uploaded file into the Storage.

Folder::checkActionPermission

Check if a file operation (= action) is allowed on this folder

Folder::copyTo

Copies folder to a target folder

Folder::createFile

Creates a new blank file

Folder::createFolder

Creates a new folder

Folder::delete

Deletes this folder from its storage. This also means that this object becomes useless.

Folder::getCombinedIdentifier

Returns a combined identifier of this folder, i.e. the storage UID and the folder identifier separated by a colon “:”.

Folder::getFileCount

Returns amount of all files within this folder, optionally filtered by the given pattern

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

Folder::getHashedIdentifier

Get hashed identifier

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.

Folder::getName

Returns the name of this folder.

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.

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.

Folder::getReadablePath

Returns the full path of this folder, from the root.

Folder::getRole

Returns the role of this folder (if any). See FolderInterface::ROLE_* constants for possible values.

Folder::getStorage

Returns the storage this folder belongs to.

Folder::getSubfolders

Returns a list of subfolders

Folder::hasFile

Checks if a file exists in this folder

Folder::hasFolder

Checks if a folder exists in this folder.

Folder::moveTo

Moves folder to a target folder

Folder::prepareFiltersInStorage

Prepares the filters in this folder’s storage according to a set filter mode.

Folder::rename

Renames this folder.

Folder::restoreBackedUpFiltersInStorage

Restores the filters of a storage.

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

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

Folder::updateProperties

Updates the properties of this folder, e.g. after re-indexing or moving it.

FolderInterface¶

t3api62:TYPO3\CMS\Core\Resource\FolderInterface: …
FolderInterface::delete: Deletes this folder from its storage. This also means that this object becomes useless.
FolderInterface::getSubfolder: Returns the object for a subfolder of the current folder, if it exists.
FolderInterface::getSubfolders: Returns a list of all subfolders
FolderInterface::hasFile: Checks if a file exists in this folder
FolderInterface::hasFolder: Checks if a folder exists in this folder.
FolderInterface::rename: Renames this folder.

FileDumpEIDHookInterface¶

t3api62:TYPO3\CMS\Core\Resource\Hook\FileDumpEIDHookInterface: …
FileDumpEIDHookInterface::checkFileAccess: Perform custom security/access when accessing file Method should issue 403 if access is rejected or 401 if authentication is required

FileInfoHook¶

t3api62:TYPO3\CMS\Core\Resource\Hook\FileInfoHook: …
FileInfoHook::renderFileInfo: User function for sys_file (element)
FileInfoHook::renderFileInformationContent: Renders a HTML Block with file information
FileInfoHook::renderFileMetadataInfo: User function for sys_file_meta (element)

InaccessibleFolder¶

t3api62:TYPO3\CMS\Core\Resource\InaccessibleFolder

…

InaccessibleFolder::addFile

Adds a file from the local server disk. If the file already exists and overwriting is disabled,

InaccessibleFolder::addUploadedFile

Adds an uploaded file into the Storage.

InaccessibleFolder::copyTo

Copies folder to a target folder

InaccessibleFolder::createFile

Creates a new blank file

InaccessibleFolder::createFolder

Creates a new folder

InaccessibleFolder::delete

Deletes this folder from its storage. This also means that this object becomes useless.

InaccessibleFolder::getFileCount

Returns amount of all files within this folder, optionally filtered by the given pattern

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

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.

InaccessibleFolder::getSubfolder

Returns the object for a subfolder of the current folder, if it exists.

InaccessibleFolder::getSubfolders

Returns a list of subfolders

InaccessibleFolder::hasFile

Checks if a file exists in this folder

InaccessibleFolder::hasFolder

Checks if a folder exists in this folder.

InaccessibleFolder::moveTo

Moves folder to a target folder

InaccessibleFolder::rename

Renames this folder.

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

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

InaccessibleFolder::throwInaccessibleException

…

InaccessibleFolder::updateProperties

Updates the properties of this folder, e.g. after re-indexing or moving it.

ExtractorInterface¶

t3api62:TYPO3\CMS\Core\Resource\Index\ExtractorInterface

…

ExtractorInterface::canProcess

Checks if the given file can be processed by this Extractor

ExtractorInterface::extractMetaData

The actual processing TASK

Should return an array with database properties for sys_file_metadata to write

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

ExtractorInterface::getExecutionPriority

…

ExtractorInterface::getFileTypeRestrictions

Returns an array of supported file types; An empty array indicates all filetypes

ExtractorInterface::getPriority

…

ExtractorRegistry¶

t3api62:TYPO3\CMS\Core\Resource\Index\ExtractorRegistry: …
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.
ExtractorRegistry::createExtractorInstance: Create an instance of a Metadata Extractor
ExtractorRegistry::getExtractorsWithDriverSupport: Get Extractors which work for a special driver
ExtractorRegistry::getInstance: Returns an instance of this class
ExtractorRegistry::registerExtractionService: …

FileIndexRepository¶

t3api62:TYPO3\CMS\Core\Resource\Index\FileIndexRepository: …
FileIndexRepository::add: Adds a file to the index
FileIndexRepository::addRaw: Add data from record (at indexing time)
FileIndexRepository::emitRecordCreatedSignal: Signal that is called after an IndexRecord is created
FileIndexRepository::emitRecordDeletedSignal: Signal that is called after an IndexRecord is deleted
FileIndexRepository::emitRecordUpdatedSignal: Signal that is called after an IndexRecord is updated
FileIndexRepository::findByContentHash: Returns all indexed files which match the content hash Used by the indexer to detect already present files
FileIndexRepository::findByFolder: …
FileIndexRepository::findInStorageAndNotInUidList: …
FileIndexRepository::findInStorageWithIndexOutstanding: Finds the files needed for second indexer step
FileIndexRepository::findOneByCombinedIdentifier: …
FileIndexRepository::findOneByFileObject: …
FileIndexRepository::findOneByStorageUidAndIdentifier: …
FileIndexRepository::findOneByStorageUidAndIdentifierHash: …
FileIndexRepository::findOneByUid: …
FileIndexRepository::getDatabaseConnection: Gets database instance
FileIndexRepository::getInstance: Returns an Instance of the Repository
FileIndexRepository::getObjectManager: Get the ObjectManager
FileIndexRepository::getResourceFactory: …
FileIndexRepository::getSignalSlotDispatcher: …
FileIndexRepository::getWhereClauseForFile: Returns a where clause to find a file in database
FileIndexRepository::hasIndexRecord: Checks if a file is indexed
FileIndexRepository::insertRecord: Helper to reduce code duplication
FileIndexRepository::markFileAsMissing: Marks given file as missing in sys_file
FileIndexRepository::remove: Remove a sys_file record from the database
FileIndexRepository::update: Updates the index record in the database
FileIndexRepository::updateIndexingTime: Updates the timestamp when the file indexer extracted metadata

Indexer¶

t3api62:TYPO3\CMS\Core\Resource\Index\Indexer: …
Indexer::__construct: …
Indexer::createIndexEntry: Create index entry
Indexer::detectChangedFilesInStorage: Adds updated files to the processing queue
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
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
Indexer::gatherFileInformationArray: Collects the information to be cached in sys_file
Indexer::getExtractorRegistry: …
Indexer::getFileIndexRepository: …
Indexer::getFileType: Maps the mimetype to a sys_file table type
Indexer::getMetaDataRepository: …
Indexer::getResourceFactory: …
Indexer::processChangedAndNewFiles: Processes the Files which have been detected as “changed or new” in the storage
Indexer::processChangesInStorages: …
Indexer::runMetaDataExtraction: …
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.
Indexer::updateIndexEntry: Update index entry

MetaDataRepository¶

t3api62:TYPO3\CMS\Core\Resource\Index\MetaDataRepository: …
MetaDataRepository::createMetaDataRecord: Create empty
MetaDataRepository::emitRecordCreatedSignal: Signal that is called after an IndexRecord is created
MetaDataRepository::emitRecordDeletedSignal: Signal that is called after an IndexRecord is deleted
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
MetaDataRepository::emitRecordUpdatedSignal: Signal that is called after an IndexRecord is updated
MetaDataRepository::findByFile: Returns array of meta-data properties
MetaDataRepository::findByFileUid: Retrieves metadata for file
MetaDataRepository::getDatabaseConnection: Wrapper method for getting DatabaseConnection
MetaDataRepository::getGeneralWhereClause: General Where-Clause which is needed to fetch only language 0 and live record.
MetaDataRepository::getInstance: …
MetaDataRepository::getObjectManager: Get the ObjectManager
MetaDataRepository::getSignalSlotDispatcher: Get the SignalSlot dispatcher
MetaDataRepository::removeByFileUid: Remove all metadata records for a certain file from the database
MetaDataRepository::update: Updates the metadata record in the database

ProcessedFile¶

t3api62:TYPO3\CMS\Core\Resource\ProcessedFile

…

ProcessedFile::__construct

Constructor for a processed file object. Should normally not be used directly, use the corresponding factory methods instead.

ProcessedFile::calculateChecksum

Returns a unique checksum for this file’s processing configuration and original file.

ProcessedFile::delete

Delete processed file

ProcessedFile::generateProcessedFileNameWithoutExtension

…

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

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

ProcessedFile::getOriginalFile

…

ProcessedFile::getProcessingConfiguration

Returns the processing information

ProcessedFile::getProperty

Getter for file-properties

ProcessedFile::getPublicUrl

Returns a publicly accessible URL for this file

ProcessedFile::getTask

Returns the task object associated with this processed file.

ProcessedFile::getTaskIdentifier

Getter for the task identifier.

ProcessedFile::getUid

Returns the uid of this file

ProcessedFile::isIndexed

Returns TRUE if this file is indexed

ProcessedFile::isNew

…

ProcessedFile::isOutdated

Returns TRUE if the original file of this file changed and the file should be processed again.

ProcessedFile::isPersisted

…

ProcessedFile::isProcessed

Returns TRUE if this file is already processed.

ProcessedFile::isUnchanged

Returns TRUE if this file has not been changed during processing (i.e., we just deliver the original file)

ProcessedFile::isUpdated

Checks whether the object since last reconstitution, and therefore needs persistence again

ProcessedFile::needsReprocessing

…

ProcessedFile::reconstituteFromDatabaseRecord

…

ProcessedFile::setContents

Replace the current file contents with the given string

ProcessedFile::setName

Sets a new file name

ProcessedFile::setUsesOriginalFile

…

ProcessedFile::toArray

Basic array function for the DB update

ProcessedFile::updateProperties

…

ProcessedFile::updateWithLocalFile

Injects a local file, which is a processing result into the object.

ProcessedFile::usesOriginalFile

…

ProcessedFileRepository¶

t3api62:TYPO3\CMS\Core\Resource\ProcessedFileRepository: …
ProcessedFileRepository::__construct: Creates this object.
ProcessedFileRepository::add: Adds a processedfile object in the database
ProcessedFileRepository::cleanUnavailableColumns: Removes all array keys which cannot be persisted
ProcessedFileRepository::createDomainObject: …
ProcessedFileRepository::createNewProcessedFileObject: …
ProcessedFileRepository::findAllByOriginalFile: …
ProcessedFileRepository::findByStorageAndIdentifier: …
ProcessedFileRepository::findOneByOriginalFileAndTaskTypeAndConfiguration: …
ProcessedFileRepository::getLogger: …
ProcessedFileRepository::removeAll: Removes all processed files and also deletes the associated physical files
ProcessedFileRepository::update: Updates an existing file object in the database

AbstractGraphicalTask¶

t3api62:TYPO3\CMS\Core\Resource\Processing\AbstractGraphicalTask: …
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.
AbstractGraphicalTask::getTargetFileExtension: Determines the file extension the processed file should have in the filesystem.
AbstractGraphicalTask::getTargetFilename: Returns the name the processed file should have in the filesystem.

AbstractTask¶

t3api62:TYPO3\CMS\Core\Resource\Processing\AbstractTask: …
AbstractTask::__construct: …
AbstractTask::getChecksumData: …
AbstractTask::getConfiguration: …
AbstractTask::getConfigurationChecksum: Returns the checksum for this task’s configuration, also taking the file and task type into account.
AbstractTask::getName: Returns the name of this task
AbstractTask::getSourceFile: …
AbstractTask::getTargetFile: …
AbstractTask::getTargetFileExtension: Gets the file extension the processed file should have in the filesystem.
AbstractTask::getTargetFilename: Returns the filename
AbstractTask::getType: Returns the type of this task
AbstractTask::isExecuted: Returns TRUE if this task has been executed, no matter if the execution was successful.
AbstractTask::isSuccessful: …
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.
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.
AbstractTask::setSourceFile: …
AbstractTask::setTargetFile: …

FileDeletionAspect¶

t3api62:TYPO3\CMS\Core\Resource\Processing\FileDeletionAspect: …
FileDeletionAspect::cleanupCategoryReferences: Remove all category references of the deleted file.
FileDeletionAspect::cleanupProcessedFilesPostFileAdd: Remove all processed files on SIGNAL_PostFileAdd
FileDeletionAspect::cleanupProcessedFilesPostFileReplace: Remove all processed files on SIGNAL_PostFileReplace
FileDeletionAspect::getDatabaseConnection: Wrapper method for getting DatabaseConnection
FileDeletionAspect::getFileIndexRepository: Return a file index repository
FileDeletionAspect::getMetaDataRepository: Return a metadata repository
FileDeletionAspect::getProcessedFileRepository: Return a processed file repository
FileDeletionAspect::removeFromRepository: Cleanup database record for a deleted file

ImageCropScaleMaskTask¶

t3api62:TYPO3\CMS\Core\Resource\Processing\ImageCropScaleMaskTask: …
ImageCropScaleMaskTask::fileNeedsProcessing: Returns TRUE if the file has to be processed at all, such as e.g. the original file does.
ImageCropScaleMaskTask::getTargetFileName: …
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¶

t3api62:TYPO3\CMS\Core\Resource\Processing\ImagePreviewTask: …
ImagePreviewTask::fileNeedsProcessing: Returns TRUE if the file has to be processed at all, such as e.g. the original file does.
ImagePreviewTask::getTargetFileName: Returns the target filename for this task.
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¶

t3api62:TYPO3\CMS\Core\Resource\Processing\LocalCropScaleMaskHelper: …
LocalCropScaleMaskHelper::__construct: …
LocalCropScaleMaskHelper::getConfigurationForImageCropScaleMask: …
LocalCropScaleMaskHelper::getFilenameForImageCropScaleMask: Returns the filename for a cropped/scaled/masked file.
LocalCropScaleMaskHelper::modifyImageMagickStripProfileParameters: Modifies the parameters for ImageMagick for stripping of profile information.

LocalImageProcessor¶

t3api62:TYPO3\CMS\Core\Resource\Processing\LocalImageProcessor: …
LocalImageProcessor::canProcessTask: Returns TRUE if this processor can process the given task.
LocalImageProcessor::getGraphicalFunctionsObject: …
LocalImageProcessor::getHelperByTaskName: …
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!
LocalImageProcessor::processTask: Processes the given task.
LocalImageProcessor::wrapFileName: Escapes a file name so it can safely be used on the command line.

LocalPreviewHelper¶

t3api62:TYPO3\CMS\Core\Resource\Processing\LocalPreviewHelper

…

LocalPreviewHelper::__construct

…

LocalPreviewHelper::generatePreviewFromFile

Generates a preview for a file

LocalPreviewHelper::getTemporaryFilePath

Returns the path to a temporary file for processing

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¶

t3api62:TYPO3\CMS\Core\Resource\Processing\ProcessorInterface: …
ProcessorInterface::canProcessTask: Returns TRUE if this processor can process the given task.
ProcessorInterface::processTask: Processes the given task and sets the processing result in the task object.

TaskInterface¶

t3api62:TYPO3\CMS\Core\Resource\Processing\TaskInterface: …
TaskInterface::__construct: …
TaskInterface::fileNeedsProcessing: Returns TRUE if the file has to be processed at all, such as e.g. the original file does.
TaskInterface::getConfiguration: Returns the configuration for this task.
TaskInterface::getConfigurationChecksum: Returns the configuration checksum of this task.
TaskInterface::getName: Returns the name of this task.
TaskInterface::getSourceFile: Returns the original file this task is based on.
TaskInterface::getTargetFile: Returns the processed file this task is executed on.
TaskInterface::getTargetFileExtension: Gets the file extension the processed file should have in the filesystem.
TaskInterface::getTargetFileName: Returns the name the processed file should have in the filesystem.
TaskInterface::getType: Returns the type of this task.
TaskInterface::isExecuted: Returns TRUE if this task has been executed, no matter if the execution was successful.
TaskInterface::isSuccessful: Returns TRUE if this task has been successfully executed. Only call this method if the task has been processed at all.
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¶

t3api62:TYPO3\CMS\Core\Resource\Processing\TaskTypeRegistry: …
TaskTypeRegistry::__construct: Register task types from configuration
TaskTypeRegistry::getClassForTaskType: Returns the class that implements the given task type.
TaskTypeRegistry::getTaskForType: …

ResourceCompressor¶

t3api62:TYPO3\CMS\Core\Resource\ResourceCompressor

…

ResourceCompressor::__construct

Constructor

ResourceCompressor::checkBaseDirectory

Decides whether a file comes from one of the baseDirectories

ResourceCompressor::compressCssFile

Compresses a CSS file

Options: baseDirectories If set, only include files below one of the base directories

ResourceCompressor::compressCssFiles

Compress multiple css files

ResourceCompressor::compressCssPregCallback

Callback function for preg_replace

ResourceCompressor::compressJsFile

Compresses a javascript file

ResourceCompressor::compressJsFiles

Compress multiple javascript files

ResourceCompressor::concatenateCssFiles

Concatenates the Stylesheet files

Options: baseDirectories If set, only include files below one of the base directories

ResourceCompressor::concatenateJsFiles

Concatenates the JavaScript files

ResourceCompressor::createMergedCssFile

Creates a merged CSS file

ResourceCompressor::createMergedFile

Creates a merged file with given file type

ResourceCompressor::createMergedJsFile

Creates a merged JS file

ResourceCompressor::cssFixRelativeUrlPaths

Fixes the relative paths inside of url() references in CSS files

ResourceCompressor::cssFixStatements

…

ResourceCompressor::findAndReplaceUrlPathsByRegex

Finds and replaces all URLs by using a given regex

ResourceCompressor::getFilenameFromMainDir

Finds the relative path to a file, relative to the root path.

ResourceCompressor::retrieveExternalFile

Retrieves an external file and stores it locally.

ResourceCompressor::returnFileReference

Decides whether a client can deal with gzipped content or not and returns the according file name, based on HTTP_ACCEPT_ENCODING

ResourceCompressor::setBackPath

Sets relative back path

ResourceCompressor::setInitialBackPath

Sets relative back path

ResourceCompressor::setInitialPaths

Sets initial values for paths.

ResourceCompressor::setInitialRelativePath

Sets relative path to PATH_site

ResourceCompressor::setInitialRootPath

Sets absolute path to working directory

ResourceCompressor::setRelativePath

Sets relative path to PATH_site

ResourceCompressor::setRootPath

Sets absolute path to working directory

ResourceCompressor::writeFileAndCompressed

Writes $contents into file $filename together with a gzipped version into $filename.gz

ResourceFactory¶

t3api62:TYPO3\CMS\Core\Resource\ResourceFactory

…

ResourceFactory::__construct

Inject signal slot dispatcher

ResourceFactory::convertFlexFormDataToConfigurationArray

Converts a flexform data string to a flat array with key value pairs

ResourceFactory::createFolderObject

Creates a folder to directly access (a part of) a storage.

ResourceFactory::createStorageObject

Creates a storage object from a storage database row.

ResourceFactory::emitPostProcessStorageSignal

Emits a signal after a resource storage was initialized

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.

ResourceFactory::getFileIndexRepository

Returns an instance of the FileIndexRepository

ResourceFactory::getFileObject

Creates an instance of the file given UID. The $fileData can be supplied to increase performance.

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

ResourceFactory::getFileObjectFromCombinedIdentifier

Gets an file object from an identifier [storage]:[fileId]

ResourceFactory::getFileReferenceObject

…

ResourceFactory::getFolderObjectFromCombinedIdentifier

Gets a folder object from an identifier [storage]:[fileId]

ResourceFactory::getIndexer

Returns an instance of the Indexer

ResourceFactory::getInstance

Gets a singleton instance of this class.

ResourceFactory::getObjectFromCombinedIdentifier

Gets a file or folder object.

ResourceFactory::getProcessedFileRepository

…

ResourceFactory::getStorageObjectFromCombinedIdentifier

Gets a storage object from a combined identifier

ResourceFactory::retrieveFileOrFolderObject

Bulk function, can be used for anything to get a file or folder

ResourceFactoryInterface¶

t3api62:TYPO3\CMS\Core\Resource\ResourceFactoryInterface: …

ResourceInterface¶

t3api62:TYPO3\CMS\Core\Resource\ResourceInterface: …
ResourceInterface::getHashedIdentifier: Get hashed identifier
ResourceInterface::getIdentifier: Returns the identifier of this file
ResourceInterface::getName: Returns the name of this file
ResourceInterface::getParentFolder: …
ResourceInterface::getStorage: Get the storage this file is located in

ResourceStorage¶

t3api62:TYPO3\CMS\Core\Resource\ResourceStorage

…

ResourceStorage::__construct

Constructor for a storage object.

ResourceStorage::addFile

Moves a file from the local filesystem to this storage.

ResourceStorage::addFileAndFolderNameFilter

…

ResourceStorage::addFileMount

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

ResourceStorage::addUploadedFile

Adds an uploaded file into the Storage. Previously in ::file_upload()

ResourceStorage::assureFileAddPermissions

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

ResourceStorage::assureFileCopyPermissions

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

ResourceStorage::assureFileDeletePermissions

Assures delete permission for given file.

ResourceStorage::assureFileMovePermissions

Checks for permissions to move a file.

ResourceStorage::assureFileReadPermission

Assures read permission for given file.

ResourceStorage::assureFileRenamePermissions

Checks for permissions to rename a file.

ResourceStorage::assureFileUploadPermissions

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

ResourceStorage::assureFileWritePermissions

Assures write permission for given file.

ResourceStorage::assureFolderCopyPermissions

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

ResourceStorage::assureFolderDeletePermission

Assures delete permission for given folder.

ResourceStorage::assureFolderMovePermissions

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

ResourceStorage::assureFolderReadPermission

Assures read permission for given folder.

ResourceStorage::checkFileActionPermission

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

ResourceStorage::checkFileExtensionPermission

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

ResourceStorage::checkFolderActionPermission

…

ResourceStorage::checkUserActionPermission

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

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

ResourceStorage::copyFolder

Copies a folder.

ResourceStorage::copyFolderBetweenStorages

Copies a folder between storages.

ResourceStorage::createFile

Creates a new file

previously in ::func_newfile()

ResourceStorage::createFolder

Creates a new folder.

previously in ::func_newfolder()

ResourceStorage::deleteFile

Previously in ::deleteFile()

ResourceStorage::deleteFolder

Previously in ::folder_delete()

ResourceStorage::dumpFileContents

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

ResourceStorage::emitPostFileAddSignal

Emits the file post-add signal.

ResourceStorage::emitPostFileCopySignal

Emits the file post-copy signal.

ResourceStorage::emitPostFileCreateSignal

Emits the file post-create signal

ResourceStorage::emitPostFileDeleteSignal

Emits the file post-deletion signal

ResourceStorage::emitPostFileMoveSignal

Emits the file post-move signal.

ResourceStorage::emitPostFileRenameSignal

Emits the file post-rename signal.

ResourceStorage::emitPostFileReplaceSignal

Emits the file post-replace signal

ResourceStorage::emitPostFileSetContentsSignal

Emits the file post-set-contents signal

ResourceStorage::emitPostFolderAddSignal

Emits the folder post-add signal.

ResourceStorage::emitPostFolderCopySignal

Emits the folder post-copy signal.

ResourceStorage::emitPostFolderDeleteSignal

Emits folder post-deletion signal..

ResourceStorage::emitPostFolderMoveSignal

Emits the folder post-move signal.

ResourceStorage::emitPostFolderRenameSignal

Emits the folder post-rename signal.

ResourceStorage::emitPreFileAddSignal

Emits file pre-add signal.

ResourceStorage::emitPreFileCopySignal

Emits file pre-copy signal.

ResourceStorage::emitPreFileDeleteSignal

Emits the file pre-deletion signal.

ResourceStorage::emitPreFileMoveSignal

Emits the file pre-move signal.

ResourceStorage::emitPreFileRenameSignal

Emits the file pre-rename signal

ResourceStorage::emitPreFileReplaceSignal

Emits the file pre-replace signal.

ResourceStorage::emitPreFolderAddSignal

Emits the folder pre-add signal.

ResourceStorage::emitPreFolderCopySignal

Emits the folder pre-copy signal.

ResourceStorage::emitPreFolderDeleteSignal

Emits the folder pre-deletion signal.

ResourceStorage::emitPreFolderMoveSignal

Emits the folder pre-move signal.

ResourceStorage::emitPreFolderRenameSignal

Emits the folder pre-rename signal.

ResourceStorage::emitPreGeneratePublicUrlSignal

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

ResourceStorage::fetchFolderListFromDriver

…

ResourceStorage::getCapabilities

Returns the capabilities of this storage.

ResourceStorage::getConfiguration

Gets the configuration.

ResourceStorage::getDefaultFolder

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

ResourceStorage::getDriver

Returns the driver object belonging to this storage.

ResourceStorage::getDriverType

…

ResourceStorage::getEvaluatePermissions

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

ResourceStorage::getFile

Gets a file by identifier.

ResourceStorage::getFileAndFolderNameFilters

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

ResourceStorage::getFileByIdentifier

Deprecated function, don’t use it. Will be removed in some later revision.

ResourceStorage::getFileContents

Get contents of a file object

ResourceStorage::getFileFactory

…

ResourceStorage::getFileForLocalProcessing

Copies a file from the storage for local processing.

ResourceStorage::getFileIdentifiersInFolder

…

ResourceStorage::getFileIndexRepository

…

ResourceStorage::getFileInfo

Gets information about a file.

ResourceStorage::getFileInfoByIdentifier

Gets information about a file by its identifier.

ResourceStorage::getFileList

Returns a list of files in a given path, filtered by some custom filter methods.

ResourceStorage::getFileMounts

Returns all file mounts that are registered with this storage.

ResourceStorage::getFileProcessingService

…

ResourceStorage::getFilesInFolder

…

ResourceStorage::getFolder

…

ResourceStorage::getFolderByIdentifier

Deprecated function, don’t use it. Will be removed in some later revision.

ResourceStorage::getFolderIdentifierFromFileIdentifier

…

ResourceStorage::getFolderIdentifiersInFolder

…

ResourceStorage::getFolderList

Returns a list of folders in a given path.

ResourceStorage::getFoldersInFolder

…

ResourceStorage::getIndexer

Gets the Indexer.

ResourceStorage::getName

Returns the name of this storage.

ResourceStorage::getObjectManager

Gets the ObjectManager.

ResourceStorage::getProcessingFolder

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

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.

ResourceStorage::getRole

Gets the role of a folder.

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.

ResourceStorage::getSignalSlotDispatcher

Get the SignalSlot dispatcher.

ResourceStorage::getStorageRecord

Gets the storage record.

ResourceStorage::getUid

Returns the UID of this storage.

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

ResourceStorage::hasCapability

Returns TRUE if this storage has the given capability.

ResourceStorage::hasChildren

Tells whether there are children in this storage.

ResourceStorage::hasFile

Returns TRUE if the specified file exists

ResourceStorage::hasFileInFolder

Checks if the queried file in the given folder exists

ResourceStorage::hasFolder

Returns TRUE if the specified folder exists.

ResourceStorage::hasFolderInFolder

Checks if the given file exists in the given folder

ResourceStorage::hashFile

Creates a (cryptographic) hash for a file.

ResourceStorage::hashFileByIdentifier

Creates a (cryptographic) hash for a fileIdentifier.

ResourceStorage::isBrowsable

…

ResourceStorage::isDefault

…

ResourceStorage::isOnline

…

ResourceStorage::isProcessingFolder

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

ResourceStorage::isPublic

…

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.

ResourceStorage::isWithinFolder

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

ResourceStorage::isWithinProcessingFolder

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

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.

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.

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.

ResourceStorage::moveFile

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

previously in ::func_move()

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.

ResourceStorage::moveFolderBetweenStorages

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

ResourceStorage::processFile

…

ResourceStorage::renameFile

Previously in ::func_rename()

ResourceStorage::renameFolder

Previously in ::folder_move()

ResourceStorage::replaceFile

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

ResourceStorage::resetFileAndFolderNameFiltersToDefault

…

ResourceStorage::setConfiguration

Sets the configuration.

ResourceStorage::setDefault

…

ResourceStorage::setDriver

Sets the storage that belongs to this storage.

ResourceStorage::setEvaluatePermissions

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

ResourceStorage::setFileAndFolderNameFilters

…

ResourceStorage::setFileContents

Set contents of a file object.

ResourceStorage::setUserPermissions

Sets the user permissions of the storage.

ResourceStorage::unsetFileAndFolderNameFilters

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

ResourceStorage::updateProcessedFile

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

ResourceStorage::usesCaseSensitiveIdentifiers

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

ResourceStorageInterface¶

t3api62:TYPO3\CMS\Core\Resource\ResourceStorageInterface: …

FileMetadataPermissionsAspect¶

t3api62:TYPO3\CMS\Core\Resource\Security\FileMetadataPermissionsAspect: …
FileMetadataPermissionsAspect::checkFileWriteAccessForFileMetaData: Checks write access to the file belonging to a metadata entry
FileMetadataPermissionsAspect::checkModifyAccessList: …
FileMetadataPermissionsAspect::checkRecordUpdateAccess: This hook is called before any write operation by DataHandler
FileMetadataPermissionsAspect::isAllowedToShowEditForm: Deny access to the edit form. This is not mandatory, but better to show this right away that access is denied.

StoragePermissionsAspect¶

t3api62:TYPO3\CMS\Core\Resource\Security\StoragePermissionsAspect: …
StoragePermissionsAspect::__construct: …
StoragePermissionsAspect::addFileMountsToStorage: Adds file mounts from the user’s file mount records
StoragePermissionsAspect::addUserPermissionsToStorage: …

FileProcessingService¶

t3api62:TYPO3\CMS\Core\Resource\Service\FileProcessingService: …
FileProcessingService::emitPostFileProcessSignal: Emits file post-processing signal.
FileProcessingService::emitPreFileProcessSignal: Emits file pre-processing signal.
FileProcessingService::getSignalSlotDispatcher: Get the SignalSlot dispatcher

FrontendContentAdapterService¶

t3api62:TYPO3\CMS\Core\Resource\Service\FrontendContentAdapterService

…

FrontendContentAdapterService::fieldIsInType

Check if fieldis in type

FrontendContentAdapterService::getPageRepository

…

FrontendContentAdapterService::registerAdditionalTypeForMigration

Registers an additional record type for an existing migration configuration.

For use in ext_localconf.php files.

FrontendContentAdapterService::registerFieldForMigration

Registers an additional field for migration.

For use in ext_localconf.php files

IndexerService¶

t3api62:TYPO3\CMS\Core\Resource\Service\IndexerService: …
IndexerService::__construct: empty constructor, nothing to do here yet
IndexerService::emitPostFileIndexSignal: Signal that is called after a file object was indexed
IndexerService::emitPostGatherFileInformationSignal: Signal that is called after a file object was indexed
IndexerService::emitPostMultipleFilesIndexSignal: Signal that is called after multiple file objects were indexed
IndexerService::emitPreFileIndexSignal: Signal that is called before a file object was indexed
IndexerService::emitPreGatherFileInformationSignal: Signal that is called before the file information is fetched helpful if somebody wants to preprocess the record information
IndexerService::emitPreMultipleFilesIndexSignal: Signal that is called before a bunch of file objects are indexed
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
IndexerService::getFactory: Getter function for the fileFactory
IndexerService::getFileIndexRepository: …
IndexerService::getMetaDataRepository: …
IndexerService::getObjectManager: Get the ObjectManager
IndexerService::getRepository: Internal function to retrieve the file repository, if it does not exist, an instance will be created
IndexerService::getSignalSlotDispatcher: Get the SignalSlot dispatcher
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¶

t3api62:TYPO3\CMS\Core\Resource\Service\MagicImageService: …
MagicImageService::createMagicImage: Creates a magic image
MagicImageService::setMagicImageMaximumDimensions: Set maximum dimensions of magic images based on RTE configuration

UserFileInlineLabelService¶

t3api62:TYPO3\CMS\Core\Resource\Service\UserFileInlineLabelService: …
UserFileInlineLabelService::getInlineLabel: Get the user function label for the file_reference table

UserFileMountService¶

t3api62:TYPO3\CMS\Core\Resource\Service\UserFileMountService: …
UserFileMountService::getSubfoldersForOptionList: Simple function to make a hierarchical subfolder request into a “flat” option list

UserStorageCapabilityService¶

t3api62:TYPO3\CMS\Core\Resource\Service\UserStorageCapabilityService: …
UserStorageCapabilityService::renderFileInformationContent: Renders a HTML block containing the checkbox for field “is_public”.
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¶

t3api62:TYPO3\CMS\Core\Resource\StorageRepository: …
StorageRepository::createDomainObject: Creates an object managed by this repository.
StorageRepository::findByUid: …
StorageRepository::initializeLocalCache: Initializes the Storage
StorageRepository::testCaseSensitivity: Test if the local filesystem is case sensitive

BackendUtility¶

t3api62:TYPO3\CMS\Core\Resource\Utility\BackendUtility: …

ListUtility¶

t3api62:TYPO3\CMS\Core\Resource\Utility\ListUtility: …