From 0e55b611693ffa2171844a476573ebfc211b35e8 Mon Sep 17 00:00:00 2001 From: Robin Appelman Date: Sun, 24 Mar 2013 02:06:50 +0100 Subject: Improve phpdoc for the filecache --- lib/files/cache/updater.php | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) (limited to 'lib/files/cache/updater.php') diff --git a/lib/files/cache/updater.php b/lib/files/cache/updater.php index e760ba71bc6..3c26ebeb491 100644 --- a/lib/files/cache/updater.php +++ b/lib/files/cache/updater.php @@ -16,7 +16,7 @@ class Updater { /** * resolve a path to a storage and internal path * - * @param string $path + * @param string $path the relative path * @return array consisting of the storage and the internal path */ static public function resolvePath($path) { @@ -24,6 +24,11 @@ class Updater { return $view->resolvePath($path); } + /** + * preform a write update + * + * @param string $path the relative path of the file + */ static public function writeUpdate($path) { /** * @var \OC\Files\Storage\Storage $storage @@ -39,6 +44,11 @@ class Updater { } } + /** + * preform a delete update + * + * @param string $path the relative path of the file + */ static public function deleteUpdate($path) { /** * @var \OC\Files\Storage\Storage $storage @@ -53,6 +63,12 @@ class Updater { } } + /** + * preform a rename update + * + * @param string $from the relative path of the source file + * @param string $to the relative path of the target file + */ static public function renameUpdate($from, $to) { /** * @var \OC\Files\Storage\Storage $storageFrom -- cgit v1.2.3