eZContentBrowseBookmark Class Reference
Handles bookmarking nodes for users. More...
Public Member Functions | |
| & | contentObjectID () |
| definition () | |
| eZContentBrowseBookmark ($row) | |
| & | fetchNode () |
Static Public Member Functions | |
| cleanup () | |
| & | createNew ($userID, $nodeID, $nodeName) |
| fetch ($bookmarkID) | |
| fetchListForUser ($userID, $offset=false, $limit=false) | |
| removeByNodeID ($nodeID) | |
Detailed Description
Handles bookmarking nodes for users.
Allows the creation and fetching of bookmark lists for users. The bookmark list is used in the browse page to allow quick navigation and selection.
Creating a new bookmark item is done with
$userID = eZUser::currentUserID(); $nodeID = 2; $nodeName = 'Node'; eZContentBrowseBookmark::createNew( $userID, $nodeID, $nodeName )
Fetching the list is done with
$userID = eZUser::currentUserID(); eZContentBrowseBookmark::fetchListForUser( $userID )
Definition at line 59 of file ezcontentbrowsebookmark.php.
Member Function Documentation
| eZContentBrowseBookmark::cleanup | ( | ) | [static] |
Removes all bookmark entries for all users.
- Note:
- Transaction unsafe. If you call several transaction unsafe methods you must enclose the calls within a db transaction; thus within db->begin and db->commit.
Definition at line 182 of file ezcontentbrowsebookmark.php.
| & eZContentBrowseBookmark::contentObjectID | ( | ) |
- Returns:
- the content object ID of the tree node which this item refers to.
Definition at line 166 of file ezcontentbrowsebookmark.php.
| & eZContentBrowseBookmark::createNew | ( | $ | userID, | |
| $ | nodeID, | |||
| $ | nodeName | |||
| ) | [static] |
Creates a new bookmark item for user $userID with node id $nodeID and name $nodeName. The new item is returned.
- Note:
- Transaction unsafe. If you call several transaction unsafe methods you must enclose the calls within a db transaction; thus within db->begin and db->commit.
Definition at line 138 of file ezcontentbrowsebookmark.php.
| eZContentBrowseBookmark::definition | ( | ) |
Reimplemented from eZPersistentObject.
Definition at line 72 of file ezcontentbrowsebookmark.php.
Referenced by fetch(), and fetchListForUser().
| eZContentBrowseBookmark::eZContentBrowseBookmark | ( | $ | row | ) |
Definition at line 64 of file ezcontentbrowsebookmark.php.
Referenced by createNew().
| eZContentBrowseBookmark::fetch | ( | $ | bookmarkID | ) | [static] |
- Returns:
- the bookmark item $bookmarkID.
Definition at line 110 of file ezcontentbrowsebookmark.php.
Referenced by fetchNode().
| eZContentBrowseBookmark::fetchListForUser | ( | $ | userID, | |
| $ | offset = false, |
|||
| $ | limit = false | |||
| ) | [static] |
- Returns:
- the bookmark list for user $userID.
Definition at line 120 of file ezcontentbrowsebookmark.php.
| & eZContentBrowseBookmark::fetchNode | ( | ) |
- Returns:
- the tree node which this item refers to.
Definition at line 157 of file ezcontentbrowsebookmark.php.
Referenced by contentObjectID().
| eZContentBrowseBookmark::removeByNodeID | ( | $ | nodeID | ) | [static] |
Removes all bookmark entries for node.
- Note:
- Transaction unsafe. If you call several transaction unsafe methods you must enclose the calls within a db transaction; thus within db->begin and db->commit.
Definition at line 194 of file ezcontentbrowsebookmark.php.
Referenced by eZContentObjectTreeNode::remove().
The documentation for this class was generated from the following file:
