nextcloud/lib/public/files/fileinfo.php

166 lines
2.9 KiB
PHP
Raw Normal View History

<?php
/**
* Copyright (c) 2014 Robin Appelman <icewind@owncloud.com>
* This file is licensed under the Affero General Public License version 3 or
* later.
* See the COPYING-README file.
*/
namespace OCP\Files;
interface FileInfo {
const TYPE_FILE = 'file';
2014-03-07 17:52:44 +04:00
const TYPE_FOLDER = 'dir';
/*
* @const \OCP\Files\FileInfo::SPACE_NOT_COMPUTED Return value for a not computed space value
*/
2014-08-19 16:05:08 +04:00
const SPACE_NOT_COMPUTED = -1;
/*
* @const \OCP\Files\FileInfo::SPACE_UNKNOWN Return value for unknown space value
*/
2014-08-19 16:05:08 +04:00
const SPACE_UNKNOWN = -2;
/*
* @const \OCP\Files\FileInfo::SPACE_UNKNOWN Return value for unlimited space
*/
2014-08-19 16:05:08 +04:00
const SPACE_UNLIMITED = -3;
/**
2014-01-13 17:42:14 +04:00
* Get the Etag of the file or folder
*
* @return string
*/
public function getEtag();
/**
2014-01-13 17:42:14 +04:00
* Get the size in bytes for the file or folder
*
* @return int
*/
public function getSize();
/**
2014-01-13 17:42:14 +04:00
* Get the last modified date as timestamp for the file or folder
*
* @return int
*/
public function getMtime();
/**
2014-01-13 17:42:14 +04:00
* Get the name of the file or folder
*
* @return string
*/
public function getName();
/**
2014-01-13 17:42:14 +04:00
* Get the path relative to the storage
*
* @return string
*/
public function getInternalPath();
/**
2014-01-13 17:42:14 +04:00
* Get the absolute path
*
* @return string
*/
public function getPath();
/**
2014-01-13 17:42:14 +04:00
* Get the full mimetype of the file or folder i.e. 'image/png'
*
* @return string
*/
public function getMimetype();
/**
2014-01-13 17:42:14 +04:00
* Get the first part of the mimetype of the file or folder i.e. 'image'
*
* @return string
*/
public function getMimePart();
/**
* Get the storage the file or folder is storage on
*
* @return \OCP\Files\Storage
*/
public function getStorage();
/**
2014-01-13 17:42:14 +04:00
* Get the file id of the file or folder
*
* @return int
*/
public function getId();
/**
2014-01-13 17:42:14 +04:00
* Check whether the file is encrypted
*
* @return bool
*/
public function isEncrypted();
/**
2014-01-13 17:42:14 +04:00
* Get the permissions of the file or folder as bitmasked combination of the following constants
* \OCP\PERMISSION_CREATE
* \OCP\PERMISSION_READ
* \OCP\PERMISSION_UPDATE
* \OCP\PERMISSION_DELETE
* \OCP\PERMISSION_SHARE
* \OCP\PERMISSION_ALL
*
* @return int
*/
public function getPermissions();
/**
2014-01-13 17:42:14 +04:00
* Check whether this is a file or a folder
*
2014-05-11 21:28:45 +04:00
* @return \OCP\Files\FileInfo::TYPE_FILE|\OCP\Files\FileInfo::TYPE_FOLDER
*/
public function getType();
/**
* Check if the file or folder is readable
*
* @return bool
*/
public function isReadable();
/**
* Check if a file is writable
*
* @return bool
*/
public function isUpdateable();
/**
* Check if a file or folder can be deleted
*
* @return bool
*/
public function isDeletable();
/**
* Check if a file or folder can be shared
*
* @return bool
*/
public function isShareable();
/**
* Check if a file or folder is shared
*
* @return bool
*/
public function isShared();
/**
* Check if a file or folder is mounted
*
* @return bool
*/
public function isMounted();
}