ICacheEntry¶

interface OCP\Files\Cache\ICacheEntry¶

meta data for a file or folder

Implemented by:	`OC\Files\Cache\CacheEntry`
Source:	lib/public/Files/Cache/ICacheEntry.php#37
Parent:	`ArrayAccess`

Constants¶

DIRECTORY_MIMETYPE = httpd/unix-directory

Source:	lib/public/Files/Cache/ICacheEntry.php#38

Methods¶

public OCP\Files\Cache\ICacheEntry::getId()¶

Get the numeric id of a file

Source:	lib/public/Files/Cache/ICacheEntry.php#46
Returns:	int
Since:	9.0.0

public OCP\Files\Cache\ICacheEntry::getStorageId()¶

Get the numeric id for the storage

Source:	lib/public/Files/Cache/ICacheEntry.php#54
Returns:	int
Since:	9.0.0

public OCP\Files\Cache\ICacheEntry::getPath()¶

Get the path of the file relative to the storage root

Source:	lib/public/Files/Cache/ICacheEntry.php#62
Returns:	string
Since:	9.0.0

public OCP\Files\Cache\ICacheEntry::getName()¶

Get the file name

Source:	lib/public/Files/Cache/ICacheEntry.php#70
Returns:	string
Since:	9.0.0

public OCP\Files\Cache\ICacheEntry::getMimeType()¶

Get the full mimetype

Source:	lib/public/Files/Cache/ICacheEntry.php#78
Returns:	string
Since:	9.0.0

public OCP\Files\Cache\ICacheEntry::getMimePart()¶

Get the first part of the mimetype

Source:	lib/public/Files/Cache/ICacheEntry.php#86
Returns:	string
Since:	9.0.0

public OCP\Files\Cache\ICacheEntry::getSize()¶

Get the file size in bytes

Source:	lib/public/Files/Cache/ICacheEntry.php#94
Returns:	int
Since:	9.0.0

public OCP\Files\Cache\ICacheEntry::getMTime()¶

Get the last modified date as unix timestamp

Source:	lib/public/Files/Cache/ICacheEntry.php#102
Returns:	int
Since:	9.0.0

public OCP\Files\Cache\ICacheEntry::getStorageMTime()¶

Get the last modified date on the storage as unix timestamp

Note that when a file is updated we also update the mtime of all parent folders to make it visible to the user which folder has had updates most recently

This can differ from the mtime on the underlying storage which usually only changes when a direct child is added, removed or renamed

Source:	lib/public/Files/Cache/ICacheEntry.php#113
Returns:	int
Since:	9.0.0

public OCP\Files\Cache\ICacheEntry::getEtag()¶

Get the etag for the file

An etag is used for change detection of files and folders, an etag of a file changes whenever the content of the file changes

Etag for folders change whenever a file in the folder has changed

Source:	lib/public/Files/Cache/ICacheEntry.php#124
Returns:	string
Since:	9.0.0

public OCP\Files\Cache\ICacheEntry::getPermissions()¶

Get the permissions for the file stored as bitwise combination of \OCP\PERMISSION_READ, \OCP\PERMISSION_CREATE

\OCP\PERMISSION_UPDATE, \OCP\PERMISSION_DELETE and \OCP\PERMISSION_SHARE

Source:	lib/public/Files/Cache/ICacheEntry.php#133
Returns:	int
Since:	9.0.0

public OCP\Files\Cache\ICacheEntry::isEncrypted()¶

Check if the file is encrypted

Source:	lib/public/Files/Cache/ICacheEntry.php#141
Returns:	bool
Since:	9.0.0

public OCP\Files\Cache\ICacheEntry::getMetadataEtag()¶

Get the metadata etag for the file

Source:	lib/public/Files/Cache/ICacheEntry.php#149
Returns:	string \| null
Since:	18.0.0

public OCP\Files\Cache\ICacheEntry::getCreationTime()¶

Get the last modified date as unix timestamp

Source:	lib/public/Files/Cache/ICacheEntry.php#157
Returns:	int \| null
Since:	18.0.0

public OCP\Files\Cache\ICacheEntry::getUploadTime()¶

Get the last modified date as unix timestamp

Source:	lib/public/Files/Cache/ICacheEntry.php#165
Returns:	int \| null
Since:	18.0.0