eZPublish  3.9
eZContentBrowseRecent Class Reference

Handles recent nodes for users. More...

+ Inheritance diagram for eZContentBrowseRecent:
+ Collaboration diagram for eZContentBrowseRecent:

Public Member Functions

contentObjectID ()
 
 definition ()
 
 eZContentBrowseRecent ($row)
 
fetchNode ()
 
 removeRecentByNodeID ($nodeID)
 
 updateNodeID ($oldNodeID, $newNodeID)
 
- 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, $custom_tables=null, $custom_conds=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 ($recentID)
 
 fetchListForUser ($userID)
 
 maximumRecentItems ($userID)
 

Detailed Description

Handles recent nodes for users.

Allows the creation and fetching of recent lists for users. The recent list is used in the browse page to allow quick navigation and selection.

Creating a new recent item is done with

Fetching the list is done with

Member Function Documentation

eZContentBrowseRecent::cleanup ( )
static

Removes all recent 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.
& eZContentBrowseRecent::contentObjectID ( )
Returns
the content object ID of the tree node which this item refers to.
& eZContentBrowseRecent::createNew (   $userID,
  $nodeID,
  $nodeName 
)
static

Tries to create a new recent item and returns it. If the node ID $nodeID already exists as a recent item nothing is done and the old item is returned.

It will also remove items when the maximum number of items for the user $userID is exceeded.

See Also
maximumRecentItems
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 eZContentOperationCollection\publishNode().

eZContentBrowseRecent::definition ( )

Referenced by createNew(), fetch(), and fetchListForUser().

eZContentBrowseRecent::eZContentBrowseRecent (   $row)

Referenced by createNew().

eZContentBrowseRecent::fetch (   $recentID)
static
Returns
the recent item $recentID
eZContentBrowseRecent::fetchListForUser (   $userID)
static
Returns
the recent list for the user identifier by $userID.

Referenced by eZContentFunctionCollection\fetchRecent().

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

Referenced by contentObjectID().

eZContentBrowseRecent::maximumRecentItems (   $userID)
static
Returns
the maximum number of recent items for user $userID. The default value is read from MaximumRecentItems from group BrowseSettings in browse.ini.
Note
Currently all users get the same default maximum amount

Referenced by createNew().

eZContentBrowseRecent::removeRecentByNodeID (   $nodeID)
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().

eZContentBrowseRecent::updateNodeID (   $oldNodeID,
  $newNodeID 
)
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 eZContentOperationCollection\publishNode().


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