aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorcweiske <cweiske@b3834d28-1941-0410-a4f8-b48e95affb8f>2009-10-24 09:06:33 +0000
committercweiske <cweiske@b3834d28-1941-0410-a4f8-b48e95affb8f>2009-10-24 09:06:33 +0000
commit55b86f75e78dce1259139af9a6e22c1c83b67a11 (patch)
tree15b7f313c0832215464ee2452e6c16978e4709da /src
parent1cf13746273dc0070813e79c90f49d3e6997319f (diff)
downloadsemanticscuttle-55b86f75e78dce1259139af9a6e22c1c83b67a11.tar.gz
semanticscuttle-55b86f75e78dce1259139af9a6e22c1c83b67a11.tar.bz2
document getBookmarks()
git-svn-id: https://semanticscuttle.svn.sourceforge.net/svnroot/semanticscuttle/trunk@404 b3834d28-1941-0410-a4f8-b48e95affb8f
Diffstat (limited to 'src')
-rw-r--r--src/SemanticScuttle/Service/Bookmark.php56
1 files changed, 44 insertions, 12 deletions
diff --git a/src/SemanticScuttle/Service/Bookmark.php b/src/SemanticScuttle/Service/Bookmark.php
index 98259d7..3acdc73 100644
--- a/src/SemanticScuttle/Service/Bookmark.php
+++ b/src/SemanticScuttle/Service/Bookmark.php
@@ -390,20 +390,52 @@ class SemanticScuttle_Service_Bookmark extends SemanticScuttle_DbService
+ /**
+ * Only get the bookmarks that are visible to the current user.
+ * Our rules:
+ * - if the $user is NULL, that means get bookmarks from ALL users,
+ * so we need to make sure to check the logged-in user's
+ * watchlist and get the contacts-only bookmarks from
+ * those users.
+ * If the user isn't logged-in, just get the public bookmarks.
+ *
+ * - if the $user is set and isn't the logged-in user, then get
+ * that user's bookmarks, and if that user is on the logged-in
+ * user's watchlist, get the public AND contacts-only
+ * bookmarks; otherwise, just get the public bookmarks.
+ *
+ * - if the $user is set and IS the logged-in user, then
+ * get all bookmarks.
+ *
+ * @param integer $start Page number
+ * @param integer $perpage Number of bookmarks per page
+ * @param integer $user User ID
+ * @param mixed $tags Array of tags or tags separated
+ * by "+" signs
+ * @param string $terms Search terms separated by spaces
+ * @param string $sortOrder One of the following values:
+ * "date_asc", "date_desc",
+ * "title_desc", "title_asc",
+ * "url_desc", "url_asc"
+ * @param boolean $watched True if only watched bookmarks
+ * shall be returned (FIXME)
+ * @param integer $startdate Filter for creation date.
+ * SQL-DateTime value
+ * "YYYY-MM-DD hh:ii:ss'
+ * @param integer $enddate Filter for creation date.
+ * SQL-DateTime value
+ * "YYYY-MM-DD hh:ii:ss'
+ * @param string $hash Filter by URL hash
+ *
+ * @return array Array with two keys: 'bookmarks' and 'total'.
+ * First contains an array of bookmarks, 'total'
+ * the total number of bookmarks (without paging).
+ */
public function getBookmarks(
- $start = 0, $perpage = NULL, $user = NULL, $tags = NULL,
- $terms = NULL, $sortOrder = NULL, $watched = NULL,
- $startdate = NULL, $enddate = NULL, $hash = NULL
+ $start = 0, $perpage = null, $user = null, $tags = null,
+ $terms = null, $sortOrder = null, $watched = null,
+ $startdate = null, $enddate = null, $hash = null
) {
- // Only get the bookmarks that are visible to the current user. Our rules:
- // - if the $user is NULL, that means get bookmarks from ALL users, so we need to make
- // sure to check the logged-in user's watchlist and get the contacts-only bookmarks from
- // those users. If the user isn't logged-in, just get the public bookmarks.
- // - if the $user is set and isn't the logged-in user, then get that user's bookmarks, and
- // if that user is on the logged-in user's watchlist, get the public AND contacts-only
- // bookmarks; otherwise, just get the public bookmarks.
- // - if the $user is set and IS the logged-in user, then get all bookmarks.
-
$userservice =SemanticScuttle_Service_Factory::get('User');
$b2tservice =SemanticScuttle_Service_Factory::get('Bookmark2Tag');
$tag2tagservice =SemanticScuttle_Service_Factory::get('Tag2Tag');