Inheritance diagram for TYPO3\CMS\Core\Resource\File:

Public Member Functions
	__construct (array $fileData, ResourceStorage $storage, array $metaData=[])

mixed	getProperty ($key)

bool	hasProperty ($key)

array	getProperties ()

array	_getMetaData ()

string	getContents ()

string	getSha1 ()

File	setContents ($contents)

bool null	isIndexed ()

	updateProperties (array $properties)

array	getUpdatedProperties ()

bool	checkActionPermission ($action)

string	calculateChecksum ()

ProcessedFile	process ($taskType, array $configuration)

array	toArray ()

bool	isMissing ()

	setMissing ($missing)

string null	getPublicUrl ($relativeToCurrentScript=false)

mixed	_getPropertyRaw ($key)

MetaDataAspect	getMetaData ()

‪Public Member Functions inherited from ‪TYPO3\CMS\Core\Resource\AbstractFile
string	getIdentifier ()

string	getHashedIdentifier ()

string	getName ()

string	getNameWithoutExtension ()

int null	getSize ()

int	getUid ()

int	getCreationTime ()

int	getModificationTime ()

string	getExtension ()

string	getMimeType ()

int	getType ()

bool	isImage ()

bool	isMediaFile ()

bool	isTextFile ()

ResourceStorage	getStorage ()

bool	exists ()

File	setStorage (ResourceStorage $storage)

File	setIdentifier ($identifier)

string	getCombinedIdentifier ()

bool	delete ()

	setDeleted ()

bool	isDeleted ()

FileInterface	rename ($newName, $conflictMode=DuplicationBehavior::RENAME)

File	copyTo (Folder $targetFolder, $targetFileName=null, $conflictMode=DuplicationBehavior::RENAME)

File	moveTo (Folder $targetFolder, $targetFileName=null, $conflictMode=DuplicationBehavior::RENAME)

string	getForLocalProcessing ($writable=true)

FolderInterface	getParentFolder ()

Protected Attributes
array	$updatedProperties = array( )

‪Protected Attributes inherited from ‪TYPO3\CMS\Core\Resource\AbstractFile
array	$properties

ResourceStorage	$storage

string	$identifier

string	$name

bool	$deleted = false

Private Attributes
MetaDataAspect	$metaDataAspect

Additional Inherited Members
‪Public Attributes inherited from ‪TYPO3\CMS\Core\Resource\AbstractFile
const	FILETYPE_UNKNOWN = 0

const	FILETYPE_TEXT = 1

const	FILETYPE_IMAGE = 2

const	FILETYPE_AUDIO = 3

const	FILETYPE_VIDEO = 4

const	FILETYPE_APPLICATION = 5

Detailed Description

File representation in the file abstraction layer.

Definition at line 23 of file File.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Core\Resource\File::__construct	(	array	$fileData,
		ResourceStorage	$storage,
		array	$metaData = `[]`
	)

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

Parameters

array	$fileData
ResourceStorage	$storage
array	$metaData

Definition at line 44 of file File.php.

References TYPO3\CMS\Core\Resource\AbstractFile\$storage, TYPO3\CMS\Core\Resource\MetaDataAspect\add(), and TYPO3\CMS\Core\Resource\File\getMetaData().

Member Function Documentation

◆ _getMetaData()

array TYPO3\CMS\Core\Resource\File::_getMetaData ( )

Returns the MetaData

Returns: ‪array

Deprecated:

Definition at line 111 of file File.php.

References TYPO3\CMS\Core\Resource\MetaDataAspect\get(), and TYPO3\CMS\Core\Resource\File\getMetaData().

◆ _getPropertyRaw()

mixed TYPO3\CMS\Core\Resource\File::_getPropertyRaw ( $key )

Parameters

string $key

Only for use in Repositories and indexer

Returns: ‪mixed

Definition at line 346 of file File.php.

Referenced by TYPO3\CMS\Core\Resource\Index\FileIndexRepository\add(), TYPO3\CMS\Core\Resource\Index\FileIndexRepository\hasIndexRecord(), and TYPO3\CMS\Core\Resource\Index\FileIndexRepository\update().

◆ calculateChecksum()

string TYPO3\CMS\Core\Resource\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

Returns: ‪string the MD5 hash

Definition at line 250 of file File.php.

References $GLOBALS, TYPO3\CMS\Core\Resource\AbstractFile\getCombinedIdentifier(), and TYPO3\CMS\Core\Resource\AbstractFile\getMimeType().

Referenced by TYPO3\CMS\Core\Resource\File\toArray().

◆ checkActionPermission()

bool TYPO3\CMS\Core\Resource\File::checkActionPermission ( $action )

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

Parameters

string $action ‪can be read, write, delete

Returns: ‪bool

Definition at line 235 of file File.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\checkFileActionPermission(), and TYPO3\CMS\Core\Resource\AbstractFile\getStorage().

Referenced by TYPO3\CMS\Impexp\Export\export_addSysFile(), TYPO3\CMS\Filelist\FileList\linkWrapFile(), TYPO3\CMS\Filelist\FileList\makeEdit(), and TYPO3\CMS\Core\Resource\File\toArray().

◆ getContents()

string TYPO3\CMS\Core\Resource\File::getContents ( )

Get the contents of this file

Returns: ‪string File contents

Reimplemented from TYPO3\CMS\Core\Resource\AbstractFile.

Definition at line 128 of file File.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\getFileContents(), and TYPO3\CMS\Core\Resource\AbstractFile\getStorage().

Referenced by TYPO3\CMS\Impexp\Export\export_addSysFile(), TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\getFormDefinition(), TYPO3\CMS\Frontend\Middleware\StaticRouteResolver\getFromFile(), TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\AbstractOnlineMediaHelper\getOnlineMediaId(), and TYPO3\CMS\Form\Mvc\Configuration\YamlSource\loadFromFile().

◆ getMetaData()

MetaDataAspect TYPO3\CMS\Core\Resource\File::getMetaData ( )

Loads the metadata of a file in an encapsulated aspect

Returns: ‪MetaDataAspect

Definition at line 356 of file File.php.

References TYPO3\CMS\Core\Resource\File\$metaDataAspect.

Referenced by TYPO3\CMS\Core\Resource\File\__construct(), TYPO3\CMS\Core\Resource\File\_getMetaData(), TYPO3\CMS\Core\Resource\Processing\FileDeletionAspect\cleanupCategoryReferences(), TYPO3\CMS\Core\Resource\Index\Indexer\extractMetaData(), TYPO3\CMS\Core\Resource\File\getProperties(), TYPO3\CMS\Core\Resource\File\getProperty(), TYPO3\CMS\Core\Resource\File\hasProperty(), TYPO3\CMS\Filelist\FileList\linkWrapFile(), and TYPO3\CMS\Core\Resource\Index\Indexer\updateIndexEntry().

◆ getProperties()

array TYPO3\CMS\Core\Resource\File::getProperties ( )

Returns the properties of this object.

Returns: ‪array

Reimplemented from TYPO3\CMS\Core\Resource\AbstractFile.

Definition at line 93 of file File.php.

References TYPO3\CMS\Core\Resource\File\getMetaData().

Referenced by TYPO3\CMS\Core\Resource\Index\FileIndexRepository\add(), and TYPO3\CMS\Core\Resource\Index\FileIndexRepository\update().

◆ getProperty()

mixed TYPO3\CMS\Core\Resource\File::getProperty ( $key )

Returns a property value

Parameters

string $key

Returns: ‪mixed Property value

Reimplemented from TYPO3\CMS\Core\Resource\AbstractFile.

Definition at line 65 of file File.php.

References TYPO3\CMS\Core\Resource\File\getMetaData().

Referenced by TYPO3\CMS\Backend\Resource\Processing\DeferredBackendImageProcessor\canProcessTask(), TYPO3\CMS\Impexp\Export\export_addSysFile(), TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\AbstractOEmbedHelper\getMetaData(), TYPO3\CMS\Core\Resource\File\isMissing(), TYPO3\CMS\Backend\Form\Element\ImageManipulationElement\processConfiguration(), and TYPO3\CMS\Core\Resource\Index\FileIndexRepository\update().

◆ getPublicUrl()

string null TYPO3\CMS\Core\Resource\File::getPublicUrl ( $relativeToCurrentScript = false )

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.

Parameters

bool $relativeToCurrentScript ‪Determines whether the URL returned should be relative to the current script, in case it is relative at all (only for the LocalDriver)

Returns: ‪string|null NULL if file is missing or deleted, the generated url otherwise

Reimplemented from TYPO3\CMS\Core\Resource\AbstractFile.

Definition at line 333 of file File.php.

References TYPO3\CMS\Core\Resource\ResourceStorage\getPublicUrl(), TYPO3\CMS\Core\Resource\AbstractFile\getStorage(), and TYPO3\CMS\Core\Resource\File\isMissing().

Referenced by TYPO3\CMS\Core\Resource\ProcessedFile\getPublicUrl(), and TYPO3\CMS\Core\Resource\File\toArray().

◆ getSha1()

string TYPO3\CMS\Core\Resource\File::getSha1 ( )

Gets SHA1 hash.

Returns: ‪string

Reimplemented from TYPO3\CMS\Core\Resource\AbstractFile.

Definition at line 138 of file File.php.

Referenced by TYPO3\CMS\Core\Resource\ProcessedFile\__construct().

◆ getUpdatedProperties()

array TYPO3\CMS\Core\Resource\File::getUpdatedProperties ( )

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

Returns: ‪array

Definition at line 221 of file File.php.

References TYPO3\CMS\Core\Resource\File\$updatedProperties.

Referenced by TYPO3\CMS\Core\Resource\Index\FileIndexRepository\update().

◆ hasProperty()

bool TYPO3\CMS\Core\Resource\File::hasProperty ( $key )

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

Parameters

string $key

Returns: ‪bool

Reimplemented from TYPO3\CMS\Core\Resource\AbstractFile.

Definition at line 80 of file File.php.

References TYPO3\CMS\Core\Resource\File\getMetaData().

◆ isIndexed()

bool null TYPO3\CMS\Core\Resource\File::isIndexed ( )

Returns TRUE if this file is indexed

Returns: ‪bool|null

Implements TYPO3\CMS\Core\Resource\FileInterface.

Definition at line 166 of file File.php.

Referenced by TYPO3\CMS\Filelist\FileList\linkWrapFile().

◆ isMissing()

bool TYPO3\CMS\Core\Resource\File::isMissing ( )

Returns: ‪bool

Definition at line 309 of file File.php.

References TYPO3\CMS\Core\Resource\File\getProperty().

Referenced by TYPO3\CMS\Core\Resource\File\getPublicUrl().

◆ process()

ProcessedFile TYPO3\CMS\Core\Resource\File::process	(		$taskType,
		array	$configuration
	)

Returns a modified version of the file.

Parameters

string	$taskType	‪The task type of this processing
array	$configuration	‪the processing configuration, see manual for that

Returns: ‪ProcessedFile The processed file

Definition at line 266 of file File.php.

References TYPO3\CMS\Core\Resource\AbstractFile\getStorage(), and TYPO3\CMS\Core\Resource\ResourceStorage\processFile().

Referenced by TYPO3\CMS\Extbase\Service\ImageService\applyProcessingInstructions(), and TYPO3\CMS\Core\Resource\Service\MagicImageService\createMagicImage().

◆ setContents()

File TYPO3\CMS\Core\Resource\File::setContents ( $contents )

Replace the current file contents with the given string

Parameters

string $contents ‪The contents to write to the file.

Returns: ‪File The file object (allows chaining).

Reimplemented from TYPO3\CMS\Core\Resource\AbstractFile.

Definition at line 152 of file File.php.

References TYPO3\CMS\Core\Resource\AbstractFile\getStorage(), and TYPO3\CMS\Core\Resource\ResourceStorage\setFileContents().

Referenced by TYPO3\CMS\Core\Resource\FileReference\setContents().

◆ setMissing()

TYPO3\CMS\Core\Resource\File::setMissing ( $missing )

Parameters

bool $missing

Definition at line 317 of file File.php.

References TYPO3\CMS\Core\Resource\File\updateProperties().

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\getFile().

◆ toArray()

array TYPO3\CMS\Core\Resource\File::toArray ( )

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

Returns: ‪array Array of main data of the file. Don't rely on all data to be present here, it's just a selection of the most relevant information.

Implements TYPO3\CMS\Core\Resource\FileInterface.

Definition at line 277 of file File.php.

◆ updateProperties()

TYPO3\CMS\Core\Resource\File::updateProperties ( array $properties )

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.

NOTE: This method should not be called from outside the File Abstraction Layer (FAL)!

Parameters

array $properties

Reimplemented from TYPO3\CMS\Core\Resource\AbstractFile.

Definition at line 182 of file File.php.

References TYPO3\CMS\Core\Resource\AbstractFile\$properties, and TYPO3\CMS\Core\Resource\AbstractFile\getType().

Referenced by TYPO3\CMS\Core\Resource\Index\FileIndexRepository\add(), TYPO3\CMS\Core\Resource\Index\Indexer\processChangedAndNewFiles(), TYPO3\CMS\Core\Resource\File\setMissing(), and TYPO3\CMS\Core\Resource\Index\Indexer\updateIndexEntry().

Member Data Documentation

◆ $metaDataAspect

MetaDataAspect TYPO3\CMS\Core\Resource\File::$metaDataAspect

private

Definition at line 34 of file File.php.

Referenced by TYPO3\CMS\Core\Resource\File\getMetaData().

◆ $updatedProperties

array TYPO3\CMS\Core\Resource\File::$updatedProperties = array( )

protected

Contains the names of all properties that have been update since the instantiation of this object

Definition at line 30 of file File.php.

Referenced by TYPO3\CMS\Core\Resource\File\getUpdatedProperties().

Public Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getMetaData()

◆ _getPropertyRaw()

◆ calculateChecksum()

◆ checkActionPermission()

◆ getContents()

◆ getMetaData()

◆ getProperties()

◆ getProperty()

◆ getPublicUrl()

◆ getSha1()

◆ getUpdatedProperties()

◆ hasProperty()

◆ isIndexed()

◆ isMissing()

◆ process()

◆ setContents()

◆ setMissing()

◆ toArray()

◆ updateProperties()

Member Data Documentation

◆ $metaDataAspect

◆ $updatedProperties