eZPublish(LegacyStack)  5.1
eZContentBrowseRecent Class Reference

Handles recent nodes for users. More...

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

Public Member Functions

 contentObjectID ()
 
 eZContentBrowseRecent ($row)
 
 fetchNode ()
 
- Public Member Functions inherited from eZPersistentObject
 attribute ($attr, $noFunction=false)
 Returns the attribute data for $attr, this is either returned from the member variables or a member function depending on whether the definition field or function attributes matched. More...
 
 attributes ()
 Returns the attributes for this object, taken from the definition fields and function attributes. More...
 
 eZPersistentObject ($row)
 Initializes the object with the $row. More...
 
 fill ($row)
 Tries to fill in the data in the object by using the object definition which is returned by the function definition() and the database row data $row. More...
 
 hasAttribute ($attr)
 Checks if $attr is part of the definition fields or function attributes. More...
 
 hasDirtyData ()
 Returns true if the data is considered dirty and needs to be stored. More...
 
 remove ($conditions=null, $extraConditions=null)
 Removes the object from the database, it will use the keys in the object definition to figure out which table row should be removed unless $conditions is defined as an array with fieldnames. More...
 
 setAttribute ($attr, $val)
 Sets the attribute $attr to the value $val. More...
 
 setHasDirtyData ($hasDirtyData)
 Sets whether the object has dirty data or not. More...
 
 store ($fieldFilters=null)
 Stores the object in the database, uses storeObject() to do the actual job and passes $fieldFilters to it. More...
 
 sync ($fieldFilters=null)
 Makes sure data is stored if the data is considered dirty. More...
 

Static Public Member Functions

static cleanup ()
 
static createNew ($userID, $nodeID, $nodeName)
 
static definition ()
 
static fetch ($recentID)
 
static fetchListForUser ($userID)
 
static maximumRecentItems ($userID)
 
static removeRecentByNodeID ($nodeID)
 
static updateNodeID ($oldNodeID, $newNodeID)
 
- Static Public Member Functions inherited from eZPersistentObject
static conditionText ($conditions)
 Calls conditionTextByRow with an empty row and $conditions. More...
 
static conditionTextByRow ($conditions, $row)
 Generates an SQL sentence from the conditions $conditions and row data $row. More...
 
static count ($def, $conds=null, $field=null)
 Fetches the number of rows by using the object definition. More...
 
static definition ()
 Returns the definition for the object, the default implementation is to return an empty array. More...
 
static escapeArray ($array)
 Escapes strings in an array with the help of eZDBInterface::escapeString(). More...
 
static fetchObject ($def, $field_filters, $conds, $asObject=true, $grouping=null, $custom_fields=null)
 Fetches and returns an object based on the given parameters and returns is either as an object or as an array. More...
 
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)
 Creates an SQL query out of the different parameters and returns an array with the result. More...
 
static getShortAttributeName ($db, $def, $attrName)
 Returns the short attribute name (alias) if it's defined, given attribute name otherwise. More...
 
static handleRows ($rows, $class_name, $asObject)
 Creates PHP objects out of the database rows $rows. More...
 
static newObjectOrder ($def, $orderField, $conditions)
 Returns an order value which can be used for new items in table, for instance placement. More...
 
static removeObject ($def, $conditions=null, $extraConditions=null)
 Deletes the object from the table defined in $def with conditions $conditions and extra conditions $extraConditions. More...
 
static reorderObject ($def, $orderField, $conditions, $down=true)
 Moves a row in a database table. More...
 
static replaceFieldsWithShortNames ($db, $fieldDefs, &$fields)
 For the given array $fields treats its keys (for associative array) or values (for non-associative array) as table fields names and replaces them with short names (aliases) found in $fieldDefs. More...
 
static storeObject ($obj, $fieldFilters=null)
 Stores the data in $obj to database. More...
 
static swapRow ($table, $keys, $order_id, $rows, $id1, $id2)
 Sets row id $id2 to have the placement of row id $id1. More...
 
static updateObjectList ($parameters)
 Updates rows matching the given parameters. More...
 

Additional Inherited Members

- Public Attributes inherited from eZPersistentObject
 $PersistentDataDirty
 

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

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

static eZContentBrowseRecent::definition ( )
static

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

eZContentBrowseRecent::eZContentBrowseRecent (   $row)

Referenced by createNew().

static eZContentBrowseRecent::fetch (   $recentID)
static
Returns
the recent item $recentID
static 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().

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

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

static eZContentBrowseRecent::updateNodeID (   $oldNodeID,
  $newNodeID 
)
static
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: