summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorBernhard Posselt <nukeawhale@gmail.com>2013-03-20 17:55:03 +0100
committerBernhard Posselt <nukeawhale@gmail.com>2013-03-20 17:55:03 +0100
commit97855d5d6aa19bb1b02934b8415fb56651e63304 (patch)
treeb65955fd82f4019b532948cc9c06d73a3583a811 /doc
parentf2e5c7060f55dd9e6949630caf029a963c57bea0 (diff)
updated docs
Diffstat (limited to 'doc')
-rw-r--r--doc/mapper spec.md49
1 files changed, 37 insertions, 12 deletions
diff --git a/doc/mapper spec.md b/doc/mapper spec.md
index 0b82354e2..f9b28fe94 100644
--- a/doc/mapper spec.md
+++ b/doc/mapper spec.md
@@ -1,24 +1,49 @@
+itemmapper
-update($item)
-delete($item)
-findAllFromUser($userId)
find(int $feedId, $userId)
-create($item)
-findAllFromFeedWithStatus($status, $feedId, $userId);
+
+
+
+findAll()
+
+request: get just starred items of a user
+ SELECT * FROM items
+ WHERE user_id = ? AND status = ?
+ (AND id < ? LIMIT ?)
+ (AND items.lastmodified >= ?)
+
+request: get all items of a user (unread and read)
+ SELECT * FROM items
+ WHERE user_id = ? AND status = ?
+ (AND id < ? LIMIT ?)
+ (AND items.lastmodified >= ?)
+
+request: get all items of a folder of a user (unread and read)
+ SELECT * FROM items
+ JOIN feeds
+ ON feed.id = feed_id
+ WHERE user_id = ? AND status = ? AND feed.folder_id = ?
+ (AND id < ? LIMIT ?)
+ (AND items.lastmodified >= ?)
+
+
+request: get all items of a feed of a user (unread and read)
+ SELECT * FROM items
+ WHERE user_id = ? AND status = ? AND feed_id = ?
+ (AND id < ? LIMIT ?)
+ (AND items.lastmodified >= ?)
+
+
+all requests: can be specified using an (offset (id), limit) or (updatedSince (timestamp))
foldermapper
find($feedId, $userId)
-update($folder)
-delete($folder)
-create($folder)
+findAllFromUser($userId)
feedmapper
find($feedId, $userId)
-update($folder)
-delete($folder)
-create($folder)
findAll()
findAllFromUser($userId)
-
+getStarredCount($userId)