![]() |
TYPO3
7.6
|
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 () | |
![]() | |
getIdentifier () | |
getName () | |
getStorage () | |
getHashedIdentifier () | |
getParentFolder () | |
File Interface
Definition at line 20 of file FileInterface.php.
delete | ( | ) |
Deletes this file from its storage. This also means that this object becomes useless.
Implemented in AbstractFile, and FileReference.
getContents | ( | ) |
Get the contents of this file
Implemented in FileReference, AbstractFile, and File.
getCreationTime | ( | ) |
Returns the creation time of the file as Unix timestamp
Implemented in FileReference, and AbstractFile.
getExtension | ( | ) |
Get the file extension
Implemented in FileReference, and AbstractFile.
Referenced by ResourceStorage\assureFileDeletePermissions(), ResourceStorage\assureFileWritePermissions(), VimeoRenderer\canRender(), YouTubeRenderer\canRender(), and SelectImage\fileIsSelectableInFileList().
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.
bool | $writable | Set this to FALSE if you only want to do read operations on the file. |
Implemented in AbstractFile, and FileReference.
Referenced by PlainTextExtractor\extractText().
getMimeType | ( | ) |
Get the MIME type of this file
Implemented in FileReference, and AbstractFile.
Referenced by PlainTextExtractor\canExtractText(), VideoTagRenderer\canRender(), AudioTagRenderer\canRender(), VimeoRenderer\canRender(), YouTubeRenderer\canRender(), ResourceStorage\dumpFileContents(), VideoTagRenderer\render(), and AudioTagRenderer\render().
getModificationTime | ( | ) |
Returns the modification time of the file as Unix timestamp
Implemented in FileReference, and AbstractFile.
getNameWithoutExtension | ( | ) |
Returns the basename (the name without extension) of this file.
Implemented in FileReference, and AbstractFile.
getProperty | ( | $key | ) |
Get the value of the $key property.
string | $key |
Implemented in ProcessedFile, FileReference, AbstractFile, and File.
Referenced by GalleryProcessor\getCroppedDimensionalProperty(), VideoTagRenderer\render(), AudioTagRenderer\render(), VimeoRenderer\render(), YouTubeRenderer\render(), MediaViewHelper\renderImage(), and FileCollector\sort().
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.
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) |
Implemented in ProcessedFile, AbstractFile, FileReference, and File.
Referenced by ImageService\getImageUri(), VideoTagRenderer\render(), and AudioTagRenderer\render().
getSha1 | ( | ) |
getSize | ( | ) |
Returns the size of this file
Implemented in FileReference, and AbstractFile.
Referenced by ResourceStorage\dumpFileContents().
hasProperty | ( | $key | ) |
Returns true if the given key exists for this file.
string | $key |
Implemented in FileReference, AbstractFile, and File.
Referenced by GalleryProcessor\getCroppedDimensionalProperty(), and FileCollector\sort().
isIndexed | ( | ) |
Returns TRUE if this file is indexed
Implemented in FileReference, ProcessedFile, and File.
rename | ( | $newName | ) |
Renames this file.
string | $newName | The new file name |
Implemented in AbstractFile, and FileReference.
setContents | ( | $contents | ) |
Replace the current file contents with the given string.
: Consider to remove this function from the interface, as its : At the same time, it could be considered whether to make the whole
string | $contents | The contents to write to the file. |
Implemented in FileReference, AbstractFile, ProcessedFile, and File.
toArray | ( | ) |
Returns an array representation of the file. (This is used by the generic listing module vidi when displaying file records.)
Implemented in FileReference, ProcessedFile, and File.