eZContentBrowseBookmark Class Reference

Handles bookmarking nodes for users. More...

Inheritance diagram for eZContentBrowseBookmark:

Collaboration diagram for eZContentBrowseBookmark:

List of all members.

Public Member Functions
	contentObjectID ()
	eZContentBrowseBookmark ($row)
	fetchNode ()
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)

---

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 57 of file ezcontentbrowsebookmark.php.

---

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.

Definition at line 174 of file ezcontentbrowsebookmark.php.

eZContentBrowseBookmark::contentObjectID

(

)

Returns:

the content object ID of the tree node which this item refers to.

Definition at line 157 of file ezcontentbrowsebookmark.php.

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.

Definition at line 130 of file ezcontentbrowsebookmark.php.

static eZContentBrowseBookmark::definition

(

)

[static]

Returns:

the definition for the object, the default implementation is to return an empty array. It's upto each inheriting class to return a proper definition array.

The definition array is an associative array consists of these keys:

• fields - an associative array of fields which defines which database field (the key) is to fetched and how they map to object member variables (the value).
• keys - an array of fields which is used for uniquely identifying the object in the table.
• function_attributes - an associative array of attributes which maps to member functions, used for fetching data with functions.
• set_functions - an associative array of attributes which maps to member functions, used for setting data with functions.
• increment_key - the field which is incremented on table inserts.
• class_name - the classname which is used for instantiating new objecs when fetching from the database.
• sort - an associative array which defines the default sorting of lists, the key is the table field while the value is the sorting method which is either asc or desc.
• name - the name of the database table

Example:

static function definition()
{
    return array( "fields" => array( "id" => "ID",
                                     "version" => "Version",
                                     "name" => "Name" ),
                  "keys" => array( "id", "version" ),
                  "function_attributes" => array( "current" => "currentVersion",
                                                  "class_name" => "className" ),
                  "increment_key" => "id",
                  "class_name" => "eZContentClass",
                  "sort" => array( "id" => "asc" ),
                  "name" => "ezcontentclass" );
}

Reimplemented from eZPersistentObject.

Definition at line 64 of file ezcontentbrowsebookmark.php.

Referenced by fetch(), and fetchListForUser().

eZContentBrowseBookmark::eZContentBrowseBookmark

(

$

row

)

Definition at line 59 of file ezcontentbrowsebookmark.php.

Referenced by createNew().

static eZContentBrowseBookmark::fetch

(

$

bookmarkID

)

[static]

Returns:

the bookmark item $bookmarkID.

Definition at line 102 of file ezcontentbrowsebookmark.php.

Referenced by fetchNode().

static eZContentBrowseBookmark::fetchListForUser	(	$	userID,
		$	offset = false,
		$	limit = false
	)		[static]

Returns:

the bookmark list for user $userID.

Definition at line 112 of file ezcontentbrowsebookmark.php.

eZContentBrowseBookmark::fetchNode

(

)

Returns:

the tree node which this item refers to.

Definition at line 149 of file ezcontentbrowsebookmark.php.

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.

Definition at line 186 of file ezcontentbrowsebookmark.php.

Referenced by eZContentObjectTreeNode\removeThis().

---

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

• ezcontentbrowsebookmark.php