Inheritance diagram for AbstractFile:

Public Member Functions
	hasProperty ($key)

	getProperty ($key)

	getProperties ()

	getIdentifier ()

	getHashedIdentifier ()

	getName ()

	getNameWithoutExtension ()

	getSize ()

	getUid ()

	getSha1 ()

	getCreationTime ()

	getModificationTime ()

	getExtension ()

	getMimeType ()

	getType ()

	getContents ()

	setContents ($contents)

	getStorage ()

	exists ()

	setStorage (ResourceStorage $storage)

	setIdentifier ($identifier)

	getCombinedIdentifier ()

	delete ()

	setDeleted ()

	isDeleted ()

	rename ($newName)

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

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

	getPublicUrl ($relativeToCurrentScript=false)

	getForLocalProcessing ($writable=true)

	updateProperties (array $properties)

	getParentFolder ()

Public Member Functions inherited from FileInterface
	isIndexed ()

	toArray ()

Public Attributes
const	FILETYPE_UNKNOWN = 0

const	FILETYPE_TEXT = 1

const	FILETYPE_IMAGE = 2

const	FILETYPE_AUDIO = 3

const	FILETYPE_VIDEO = 4

const	FILETYPE_APPLICATION = 5

Protected Attributes
	$properties

	$storage = null

	$identifier

	$name

	$deleted = false

Detailed Description

Abstract file representation in the file abstraction layer.

Definition at line 22 of file AbstractFile.php.

Member Function Documentation

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

Copies this file into a target folder

Parameters

Folder	$targetFolder	Folder to copy file into.
string	$targetFileName	an optional destination fileName
string	$conflictMode	a value of the enumeration

Exceptions

\RuntimeException

Returns: File The new (copied) file.

Definition at line 486 of file AbstractFile.php.

References Folder\getStorage().

delete ( )

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

Returns: bool TRUE if deletion succeeded

Implements FileInterface.

Definition at line 433 of file AbstractFile.php.

References AbstractFile\getStorage().

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.

Returns: bool TRUE if this file physically exists

Definition at line 376 of file AbstractFile.php.

References AbstractFile\getIdentifier().

Referenced by ProcessedFile\needsReprocessing(), ProcessedFile\setName(), and ProcessedFile\updateProperties().

getCombinedIdentifier ( )

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

Returns: string Combined storage and file identifier, e.g. StorageUID:path/and/fileName.png

Definition at line 418 of file AbstractFile.php.

References MathUtility\canBeInterpretedAsInteger(), AbstractFile\getIdentifier(), and AbstractFile\getStorage().

Referenced by File\calculateChecksum(), and File\toArray().

getContents ( )

Get the contents of this file

Exceptions

\RuntimeException

Returns: string File contents

Implements FileInterface.

Definition at line 326 of file AbstractFile.php.

References AbstractFile\getStorage().

getCreationTime ( )

Returns the creation time of the file as Unix timestamp

Exceptions

\RuntimeException

Returns: int

Implements FileInterface.

Definition at line 225 of file AbstractFile.php.

References AbstractFile\getProperty().

getExtension ( )

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

Returns: string The file extension

Implements FileInterface.

Definition at line 252 of file AbstractFile.php.

References AbstractFile\getName(), and PathUtility\pathinfo().

Referenced by ImageService\getCompatibilityImageResourceValues(), OnlineMediaHelperRegistry\getOnlineMediaHelper(), and File\toArray().

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.

Exceptions

\RuntimeException

Returns: string

Implements FileInterface.

Definition at line 543 of file AbstractFile.php.

References AbstractFile\getStorage().

Referenced by Indexer\extractRequiredMetaData(), MetaDataRepository\findByFile(), and SelectImage\insertPlainImage().

getHashedIdentifier ( )

Get hashed identifier

Returns: string

Implements ResourceInterface.

Definition at line 154 of file AbstractFile.php.

getIdentifier ( )

Returns the identifier of this file

Returns: string

Implements ResourceInterface.

Definition at line 144 of file AbstractFile.php.

References AbstractFile\$identifier.

Referenced by AbstractFile\exists(), AbstractFile\getCombinedIdentifier(), AbstractFile\getMimeType(), AbstractFile\getParentFolder(), AbstractFile\getSize(), ResourceStorage\setFileContents(), and Indexer\updateIndexEntry().

getMimeType ( )

Get the MIME type of this file

Returns: string mime type

Implements FileInterface.

Definition at line 266 of file AbstractFile.php.

References AbstractFile\getIdentifier(), and AbstractFile\getStorage().

Referenced by File\calculateChecksum(), AbstractFile\getType(), and File\toArray().

getModificationTime ( )

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

Exceptions

\RuntimeException

Returns: int

Implements FileInterface.

Definition at line 239 of file AbstractFile.php.

References AbstractFile\getProperty().

getName ( )

Returns the name of this file

Returns: string

Implements ResourceInterface.

Definition at line 164 of file AbstractFile.php.

References AbstractFile\$name.

Referenced by AbstractFile\getExtension(), AbstractFile\getNameWithoutExtension(), and File\toArray().

getNameWithoutExtension ( )

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

Returns: string

Implements FileInterface.

Definition at line 176 of file AbstractFile.php.

References AbstractFile\getName(), and PathUtility\pathinfo().

getParentFolder ( )

Returns the parent folder.

Returns: FolderInterface

Implements ResourceInterface.

Definition at line 568 of file AbstractFile.php.

References AbstractFile\getIdentifier(), and AbstractFile\getStorage().

getProperties ( )

Returns the properties of this object.

Returns: array

Definition at line 134 of file AbstractFile.php.

References AbstractFile\$properties.

getProperty ( $key )

Returns a property value

Parameters

string $key

Returns: mixed Property value

Implements FileInterface.

Definition at line 120 of file AbstractFile.php.

References AbstractFile\hasProperty().

Referenced by AbstractFile\getCreationTime(), AbstractFile\getModificationTime(), and AbstractFile\getUid().

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)

Returns: NULL|string NULL if file is deleted, the generated URL otherwise

Implements FileInterface.

Definition at line 524 of file AbstractFile.php.

References AbstractFile\getStorage().

getSha1 ( )

Returns the Sha1 of this file

Exceptions

\RuntimeException

Returns: string

Implements FileInterface.

Definition at line 211 of file AbstractFile.php.

References AbstractFile\getStorage().

getSize ( )

Returns the size of this file

Exceptions

\RuntimeException

Returns: int

Implements FileInterface.

Definition at line 187 of file AbstractFile.php.

References AbstractFile\getIdentifier(), and AbstractFile\getStorage().

Referenced by File\toArray().

getStorage ( )

Get the storage this file is located in

Returns: ResourceStorage

Exceptions

\RuntimeException

Implements ResourceInterface.

Definition at line 361 of file AbstractFile.php.

References AbstractFile\$storage.

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