eZPublish  4.5
eZContentBrowseBookmark Class Reference

Handles bookmarking nodes for users. More...

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

Public Member Functions

 contentObjectID ()
 
 eZContentBrowseBookmark ($row)
 
 fetchNode ()
 
- Public Member Functions inherited from eZPersistentObject
 attribute ($attr, $noFunction=false)
 
 attributes ()
 
 eZPersistentObject ($row)
 
 fill ($row)
 
 hasAttribute ($attr)
 
 hasDirtyData ()
 
 remove ($conditions=null, $extraConditions=null)
 
 setAttribute ($attr, $val)
 
 setHasDirtyData ($hasDirtyData)
 
 store ($fieldFilters=null)
 
 sync ($fieldFilters=null)
 

Static Public Member Functions

static cleanup ()
 
static createNew ($userID, $nodeID, $nodeName)
 
static definition ()
 
static fetch ($bookmarkID)
 
static fetchListForUser ($userID, $offset=false, $limit=false)
 
static removeByNodeID ($nodeID)
 
- Static Public Member Functions inherited from eZPersistentObject
static conditionText ($conditions)
 
static conditionTextByRow ($conditions, $row)
 
static count ($def, $conds=null, $field=null)
 
static definition ()
 
static escapeArray ($array)
 
static fetchObject ($def, $field_filters, $conds, $asObject=true, $grouping=null, $custom_fields=null)
 
static fetchObjectList ($def, $field_filters=null, $conds=null, $sorts=null, $limit=null, $asObject=true, $grouping=false, $custom_fields=null, $custom_tables=null, $custom_conds=null)
 
static getShortAttributeName ($db, $def, $attrName)
 
static handleRows ($rows, $class_name, $asObject)
 
static newObjectOrder ($def, $orderField, $conditions)
 
static removeObject ($def, $conditions=null, $extraConditions=null)
 
static reorderObject ($def, $orderField, $conditions, $down=true)
 
static swapRow ($table, $keys, $order_id, $rows, $id1, $id2)
 
static updateObjectList ($parameters)
 

Additional Inherited Members

- Public Attributes inherited from eZPersistentObject
 $PersistentDataDirty
 Whether the data is dirty, ie needs to be stored, or not. More...
 

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

static 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.
static 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.
static eZContentBrowseBookmark::definition ( )
static

Referenced by fetch(), and fetchListForUser().

eZContentBrowseBookmark::eZContentBrowseBookmark (   $row)

Referenced by createNew().

static eZContentBrowseBookmark::fetch (   $bookmarkID)
static
Returns
the bookmark item $bookmarkID.
static 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().

static 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\removeThis().


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