FileInfo
Interface FileInfo
Tags
Table of Contents
- BLACKLIST_FILES_REGEX = '\.(part|filepart)$'
- MIMETYPE_FOLDER = 'httpd/unix-directory'
- SPACE_NOT_COMPUTED = -1
- SPACE_UNKNOWN = -2
- SPACE_UNLIMITED = -3
- TYPE_FILE = 'file'
- TYPE_FOLDER = 'dir'
- getChecksum() : string
- Get the stored checksum for this file
- getCreationTime() : int
- Get the creation date as unix timestamp
- getEtag() : string
- Get the Etag of the file or folder
- getExtension() : string
- Get the extension of the file
- getId() : int|null
- Get the file id of the file or folder
- getInternalPath() : string
- Get the path relative to the storage
- getMimePart() : string
- Get the first part of the mimetype of the file or folder i.e. 'image'
- getMimetype() : string
- Get the full mimetype of the file or folder i.e. 'image/png'
- getMountPoint() : IMountPoint
- Get the mountpoint the file belongs to
- getMtime() : int
- Get the last modified date as timestamp for the file or folder
- getName() : string
- Get the name of the file or folder
- getOwner() : IUser
- Get the owner of the file
- getPath() : string
- Get the absolute path
- getPermissions() : int
- Get the permissions of the file or folder as bitmasked combination of the following constants \OCP\Constants::PERMISSION_CREATE \OCP\Constants::PERMISSION_READ \OCP\Constants::PERMISSION_UPDATE \OCP\Constants::PERMISSION_DELETE \OCP\Constants::PERMISSION_SHARE \OCP\Constants::PERMISSION_ALL
- getSize() : int
- Get the size in bytes for the file or folder
- getStorage() : Storage
- Get the storage the file or folder is storage on
- getType() : string
- Check whether this is a file or a folder
- getUploadTime() : int
- Get the upload date as unix timestamp
- isCreatable() : bool
- Check whether new files or folders can be created inside this folder
- isDeletable() : bool
- Check if a file or folder can be deleted
- isEncrypted() : bool
- Check whether the file is encrypted
- isMounted() : bool
- Check if a file or folder is mounted
- isReadable() : bool
- Check if the file or folder is readable
- isShareable() : bool
- Check if a file or folder can be shared
- isShared() : bool
- Check if a file or folder is shared
- isUpdateable() : bool
- Check if a file is writable
Constants
BLACKLIST_FILES_REGEX
public
mixed
BLACKLIST_FILES_REGEX
= '\.(part|filepart)$'
Tags
MIMETYPE_FOLDER
public
mixed
MIMETYPE_FOLDER
= 'httpd/unix-directory'
Tags
SPACE_NOT_COMPUTED
public
mixed
SPACE_NOT_COMPUTED
= -1
Tags
SPACE_UNKNOWN
public
mixed
SPACE_UNKNOWN
= -2
Tags
SPACE_UNLIMITED
public
mixed
SPACE_UNLIMITED
= -3
Tags
TYPE_FILE
public
mixed
TYPE_FILE
= 'file'
Tags
TYPE_FOLDER
public
mixed
TYPE_FOLDER
= 'dir'
Tags
Methods
getChecksum()
Get the stored checksum for this file
public
getChecksum() : string
Tags
Return values
string —getCreationTime()
Get the creation date as unix timestamp
public
getCreationTime() : int
If the creation time is not known, 0 will be returned
creation time is not set automatically by the server and is generally only available for files uploaded by the sync clients
Tags
Return values
int —getEtag()
Get the Etag of the file or folder
public
getEtag() : string
Tags
Return values
string —getExtension()
Get the extension of the file
public
getExtension() : string
Tags
Return values
string —getId()
Get the file id of the file or folder
public
getId() : int|null
Tags
Return values
int|null —getInternalPath()
Get the path relative to the storage
public
getInternalPath() : string
Tags
Return values
string —getMimePart()
Get the first part of the mimetype of the file or folder i.e. 'image'
public
getMimePart() : string
Tags
Return values
string —getMimetype()
Get the full mimetype of the file or folder i.e. 'image/png'
public
getMimetype() : string
Tags
Return values
string —getMountPoint()
Get the mountpoint the file belongs to
public
getMountPoint() : IMountPoint
Tags
Return values
IMountPoint —getMtime()
Get the last modified date as timestamp for the file or folder
public
getMtime() : int
Tags
Return values
int —getName()
Get the name of the file or folder
public
getName() : string
Tags
Return values
string —getOwner()
Get the owner of the file
public
getOwner() : IUser
Tags
Return values
IUser —getPath()
Get the absolute path
public
getPath() : string
Tags
Return values
string —getPermissions()
Get the permissions of the file or folder as bitmasked combination of the following constants \OCP\Constants::PERMISSION_CREATE \OCP\Constants::PERMISSION_READ \OCP\Constants::PERMISSION_UPDATE \OCP\Constants::PERMISSION_DELETE \OCP\Constants::PERMISSION_SHARE \OCP\Constants::PERMISSION_ALL
public
getPermissions() : int
Tags
Return values
int —getSize()
Get the size in bytes for the file or folder
public
getSize([bool $includeMounts = true ]) : int
Parameters
- $includeMounts : bool = true
-
whether or not to include the size of any sub mounts, since 16.0.0
Tags
Return values
int —getStorage()
Get the storage the file or folder is storage on
public
getStorage() : Storage
Tags
Return values
Storage —getType()
Check whether this is a file or a folder
public
getType() : string
Tags
Return values
string —\OCP\Files\FileInfo::TYPE_FILE|\OCP\Files\FileInfo::TYPE_FOLDER
getUploadTime()
Get the upload date as unix timestamp
public
getUploadTime() : int
If the upload time is not known, 0 will be returned
Upload time will be set automatically by the server for files uploaded over DAV files created by Nextcloud apps generally do not have an the upload time set
Tags
Return values
int —isCreatable()
Check whether new files or folders can be created inside this folder
public
isCreatable() : bool
Tags
Return values
bool —isDeletable()
Check if a file or folder can be deleted
public
isDeletable() : bool
Tags
Return values
bool —isEncrypted()
Check whether the file is encrypted
public
isEncrypted() : bool
Tags
Return values
bool —isMounted()
Check if a file or folder is mounted
public
isMounted() : bool
Tags
Return values
bool —isReadable()
Check if the file or folder is readable
public
isReadable() : bool
Tags
Return values
bool —isShareable()
Check if a file or folder can be shared
public
isShareable() : bool
Tags
Return values
bool —isShared()
Check if a file or folder is shared
public
isShared() : bool
Tags
Return values
bool —isUpdateable()
Check if a file is writable
public
isUpdateable() : bool