add cache entry interface

1 files changed, 118 insertions, 0 deletions

diff --git a/lib/public/files/cache/icachenetry.php b/lib/public/files/cache/icachenetry.php
new file mode 100644
index 00000000000..62b25ebc280
--- /dev/null
+++ b/lib/public/files/cache/icachenetry.php
@@ -0,0 +1,118 @@
+<?php
+/**
+ * @author Robin Appelman <icewind@owncloud.com>>
+ *
+ * @copyright Copyright (c) 2015, ownCloud, Inc.
+ * @license AGPL-3.0
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License, version 3,
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+namespace OCP\Files\Cache;
+
+/**
+ * meta data for a file or folder
+ */
+interface ICacheEntry {
+	/**
+	 * Get the numeric id of a file
+	 *
+	 * @return int
+	 */
+	public function getId();
+
+	/**
+	 * Get the numeric id for the storage
+	 *
+	 * @return int
+	 */
+	public function getStorageId();
+
+	/**
+	 * Get the path of the file relative to the storage root
+	 *
+	 * @return string
+	 */
+	public function getPath();
+
+	/**
+	 * Get the file name
+	 *
+	 * @return string
+	 */
+	public function getName();
+
+	/**
+	 * Get the full mimetype
+	 *
+	 * @return string
+	 */
+	public function getMimeType();
+
+	/**
+	 * Get the first part of the mimetype
+	 *
+	 * @return string
+	 */
+	public function getMimePart();
+
+	/**
+	 * Get the file size in bytes
+	 *
+	 * @return int
+	 */
+	public function getSize();
+
+	/**
+	 * Get the last modified date as unix timestamp
+	 *
+	 * @return int
+	 */
+	public function getMTime();
+
+	/**
+	 * 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
+	 *
+	 * @return int
+	 */
+	public function getStorageMTime();
+
+	/**
+	 * 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
+	 *
+	 * @return string
+	 */
+	public function getEtag();
+
+	/**
+	 * 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
+	 *
+	 * @return int
+	 */
+	public function getPermissions();
+
+	/**
+	 * Check if the file is encrypted
+	 *
+	 * @return bool
+	 */
+	public function isEncrypted();
+}