summaryrefslogtreecommitdiff
path: root/modules/gallery/helpers/item_rest.php
diff options
context:
space:
mode:
authorBharat Mediratta <bharat@menalto.com>2010-11-27 20:42:53 -0800
committerBharat Mediratta <bharat@menalto.com>2010-11-27 20:42:53 -0800
commit76b6daefaa4009fdd8de72b8f25259200a66d477 (patch)
treea156ea5756861d71f7e9964dc79d8b7216293c76 /modules/gallery/helpers/item_rest.php
parentf91819441c0f899f34c02264f9cbfdc6281980b9 (diff)
Clean up phpDoc on get() a little more
Diffstat (limited to 'modules/gallery/helpers/item_rest.php')
-rw-r--r--modules/gallery/helpers/item_rest.php11
1 files changed, 6 insertions, 5 deletions
diff --git a/modules/gallery/helpers/item_rest.php b/modules/gallery/helpers/item_rest.php
index 10f9e16a..a8bc36ad 100644
--- a/modules/gallery/helpers/item_rest.php
+++ b/modules/gallery/helpers/item_rest.php
@@ -23,18 +23,19 @@ class item_rest_Core {
* query the collection. You can specify them in any combination.
*
* scope=direct
- * only return items that are immediately under this one
+ * Only return items that are immediately under this one
* scope=all
- * return items anywhere under this one
+ * Return items anywhere under this one
*
* name=<substring>
- * only return items where the name contains this substring
+ * Only return items where the name contains this substring
*
* random=true
- * return a single random item
+ * Return a single random item
*
* type=<comma separate list of photo, movie or album>
- * limit the type to types in this list. eg, "type=photo,movie"
+ * Limit the type to types in this list, eg: "type=photo,movie".
+ * Also limits the types returned in the member collections (same behaviour as item_rest).
*/
static function get($request) {
$item = rest::resolve($request->url);