diff options
author | Robin Appelman <icewind@owncloud.com> | 2013-09-10 20:02:15 +0200 |
---|---|---|
committer | Robin Appelman <icewind@owncloud.com> | 2013-09-10 20:10:25 +0200 |
commit | 9ad7891b4e7ddf1c4420f485c5d3cf4477835087 (patch) | |
tree | fed35c32adcbbe71c54ddfe7325f6ccd638a26bc /lib/public/files/node.php | |
parent | e271a55783dafd605791d02ca718b463fa19d58d (diff) | |
download | nextcloud-server-9ad7891b4e7ddf1c4420f485c5d3cf4477835087.tar.gz nextcloud-server-9ad7891b4e7ddf1c4420f485c5d3cf4477835087.zip |
improve phpdoc for the public files interface
Diffstat (limited to 'lib/public/files/node.php')
-rw-r--r-- | lib/public/files/node.php | 65 |
1 files changed, 58 insertions, 7 deletions
diff --git a/lib/public/files/node.php b/lib/public/files/node.php index d3b71803f50..42dd910871d 100644 --- a/lib/public/files/node.php +++ b/lib/public/files/node.php @@ -10,98 +10,149 @@ namespace OCP\Files; interface Node { /** - * @param string $targetPath - * @throws \OC\Files\NotPermittedException + * Move the file or folder to a new location + * + * @param string $targetPath the absolute target path + * @throws \OCP\Files\NotPermittedException * @return \OCP\Files\Node */ public function move($targetPath); + /** + * Delete the file or folder + */ public function delete(); /** - * @param string $targetPath + * Cope the file or folder to a new location + * + * @param string $targetPath the absolute target path * @return \OCP\Files\Node */ public function copy($targetPath); /** - * @param int $mtime - * @throws \OC\Files\NotPermittedException + * Change the modified date of the file or folder + * If $mtime is omitted the current time will be used + * + * @param int $mtime (optional) modified date as unix timestamp + * @throws \OCP\Files\NotPermittedException */ public function touch($mtime = null); /** + * Get the storage backend the file or folder is stored on + * * @return \OC\Files\Storage\Storage - * @throws \OC\Files\NotFoundException + * @throws \OCP\Files\NotFoundException */ public function getStorage(); /** + * Get the full path of the file or folder + * * @return string */ public function getPath(); /** + * Get the path of the file or folder relative to the mountpoint of it's storage + * * @return string */ public function getInternalPath(); /** + * Get the internal file id for the file or folder + * * @return int */ public function getId(); /** + * Get metadata of the file or folder + * The returned array contains the following values: + * - mtime + * - size + * * @return array */ public function stat(); /** + * Get the modified date of the file or folder as unix timestamp + * * @return int */ public function getMTime(); /** + * Get the size of the file or folder in bytes + * * @return int */ public function getSize(); /** + * Get the Etag of the file or folder + * The Etag is an string id used to detect changes to a file or folder, + * every time the file or folder is changed the Etag will change to + * * @return string */ public function getEtag(); + /** + * Get the permissions of the file or folder as a combination of one or more of the following constants: + * - \OCP\PERMISSION_READ + * - \OCP\PERMISSION_UPDATE + * - \OCP\PERMISSION_CREATE + * - \OCP\PERMISSION_DELETE + * - \OCP\PERMISSION_SHARE + * * @return int */ public function getPermissions(); /** + * Check if the file or folder is readable + * * @return bool */ public function isReadable(); /** + * Check if the file or folder is writable + * * @return bool */ public function isUpdateable(); /** + * Check if the file or folder is deletable + * * @return bool */ public function isDeletable(); /** + * Check if the file or folder is shareable + * * @return bool */ public function isShareable(); /** - * @return Node + * Get the parent folder of the file or folder + * + * @return Folder */ public function getParent(); /** + * Get the filename of the file or folder + * * @return string */ public function getName(); |