eZPublish  3.8
eZContentBrowseBookmark Class Reference

Handles bookmarking nodes for users. More...

+ Inheritance diagram for eZContentBrowseBookmark:
+ Collaboration diagram for eZContentBrowseBookmark:

Public Member Functions

contentObjectID ()
 
 definition ()
 
 eZContentBrowseBookmark ($row)
 
fetchNode ()
 
- Public Member Functions inherited from eZPersistentObject
attribute ($attr, $noFunction=false)
 
 attributes ()
 
 conditionText (&$conditions)
 
conditionTextByRow (&$conditions, &$row)
 
 definition ()
 
escapeArray (&$array)
 
 eZPersistentObject ($row)
 
 fetchObject (&$def, $field_filters, $conds, $asObject=true, $grouping=null, $custom_fields=null)
 
 fetchObjectList (&$def, $field_filters=null, $conds=null, $sorts=null, $limit=null, $asObject=true, $grouping=false, $custom_fields=null)
 
 fill (&$row)
 
 getShortAttributeName (&$db, &$def, $attrName)
 
 handleRows (&$rows, $class_name, $asObject)
 
 hasAttribute ($attr)
 
 hasDirtyData ()
 
 newObjectOrder (&$def, $orderField, $conditions)
 
 remove ($conditions=null, $extraConditions=null)
 
 removeObject (&$def, $conditions=null, $extraConditions=null)
 
 reorderObject (&$def, $orderField, $conditions, $down=true)
 
 setAttribute ($attr, $val)
 
 setHasDirtyData ($hasDirtyData)
 
 store ($fieldFilters=null)
 
 swapRow ($table, &$keys, &$order_id, &$rows, $id1, $id2)
 
 sync ($fieldFilters=null)
 
 updateObjectList ($parameters)
 

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

Fetching the list is done with

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.
& eZContentBrowseBookmark::contentObjectID ( )
Returns
the content object ID of the tree node which this item refers to.
& 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.
eZContentBrowseBookmark::definition ( )

Referenced by fetch(), and fetchListForUser().

eZContentBrowseBookmark::eZContentBrowseBookmark (   $row)

Referenced by createNew().

eZContentBrowseBookmark::fetch (   $bookmarkID)
static
Returns
the bookmark item $bookmarkID.
eZContentBrowseBookmark::fetchListForUser (   $userID,
  $offset = false,
  $limit = false 
)
static
Returns
the bookmark list for user $userID.

Referenced by eZContentFunctionCollection\fetchBookmarks().

& eZContentBrowseBookmark::fetchNode ( )
Returns
the tree node which this item refers to.

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.

Referenced by eZContentObjectTreeNode\remove().


The documentation for this class was generated from the following file: