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

Public Member Functions
	hasProperty ($key)

	getProperty ($key)

	getSize ()

	getSha1 ()

	getNameWithoutExtension ()

	getExtension ()

	getMimeType ()

	getModificationTime ()

	getCreationTime ()

	getContents ()

	setContents ($contents)

	delete ()

	rename ($newName)

	getPublicUrl ($relativeToCurrentScript=FALSE)

	isIndexed ()

	getForLocalProcessing ($writable=TRUE)

	toArray ()

Public Member Functions inherited from TYPO3\CMS\Core\Resource\ResourceInterface
	getIdentifier ()

	getName ()

	getStorage ()

	getHashedIdentifier ()

	getParentFolder ()

Detailed Description

This file is part of the TYPO3 CMS project.

It is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, either version 2 of the License, or any later version.

For the full copyright and license information, please read the LICENSE.txt file that was distributed with this source code.

The TYPO3 project - inspiring people to share! File Interface

Author: Ingmar Schlecht ingma.nosp@m.r@ty.nosp@m.po3.o.nosp@m.rg

Definition at line 21 of file FileInterface.php.

Member Function Documentation

◆ delete()

TYPO3\CMS\Core\Resource\FileInterface::delete ( )

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

Returns: boolean TRUE if deletion succeeded

Implemented in TYPO3\CMS\Core\Resource\AbstractFile, and TYPO3\CMS\Core\Resource\FileReference.

◆ getContents()

TYPO3\CMS\Core\Resource\FileInterface::getContents ( )

Get the contents of this file

Returns: string File contents

Implemented in TYPO3\CMS\Core\Resource\FileReference, TYPO3\CMS\Core\Resource\AbstractFile, and TYPO3\CMS\Core\Resource\File.

◆ getCreationTime()

TYPO3\CMS\Core\Resource\FileInterface::getCreationTime ( )

Returns the creation time of the file as Unix timestamp

Returns: integer

Implemented in TYPO3\CMS\Core\Resource\FileReference, and TYPO3\CMS\Core\Resource\AbstractFile.

◆ getExtension()

TYPO3\CMS\Core\Resource\FileInterface::getExtension ( )

Get the file extension

Returns: string The file extension

Implemented in TYPO3\CMS\Core\Resource\FileReference, and TYPO3\CMS\Core\Resource\AbstractFile.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\assureFileDeletePermissions(), and TYPO3\CMS\Core\Resource\ResourceStorage\assureFileWritePermissions().

◆ getForLocalProcessing()

TYPO3\CMS\Core\Resource\FileInterface::getForLocalProcessing ( $writable = TRUE )

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.

Parameters

bool $writable Set this to FALSE if you only want to do read operations on the file.

Returns: string

Implemented in TYPO3\CMS\Core\Resource\AbstractFile, and TYPO3\CMS\Core\Resource\FileReference.

◆ getMimeType()

TYPO3\CMS\Core\Resource\FileInterface::getMimeType ( )

Get the MIME type of this file

Returns: array file information

Implemented in TYPO3\CMS\Core\Resource\FileReference, and TYPO3\CMS\Core\Resource\AbstractFile.

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

◆ getModificationTime()

TYPO3\CMS\Core\Resource\FileInterface::getModificationTime ( )

Returns the modification time of the file as Unix timestamp

Returns: integer

Implemented in TYPO3\CMS\Core\Resource\FileReference, and TYPO3\CMS\Core\Resource\AbstractFile.

◆ getNameWithoutExtension()

TYPO3\CMS\Core\Resource\FileInterface::getNameWithoutExtension ( )

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

Returns: string

Implemented in TYPO3\CMS\Core\Resource\FileReference, and TYPO3\CMS\Core\Resource\AbstractFile.

◆ getProperty()

TYPO3\CMS\Core\Resource\FileInterface::getProperty ( $key )

Get the value of the $key property.

Parameters

string $key

Returns: string

Implemented in TYPO3\CMS\Core\Resource\ProcessedFile, TYPO3\CMS\Core\Resource\AbstractFile, TYPO3\CMS\Core\Resource\FileReference, and TYPO3\CMS\Core\Resource\File.

◆ getPublicUrl()

TYPO3\CMS\Core\Resource\FileInterface::getPublicUrl ( $relativeToCurrentScript = FALSE )

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.

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)