eZ Publish  [trunk]
eZCollaborationNotificationRule Class Reference

The class eZCollaborationNotificationRule does. More...

+ Inheritance diagram for eZCollaborationNotificationRule:
+ Collaboration diagram for eZCollaborationNotificationRule:

List of all members.

Public Member Functions

 eZCollaborationNotificationRule ($row)
 user ()

Static Public Member Functions

static cleanup ()
static create ($collaborationIdentifier, $userID=false)
static definition ()
 Returns the definition for the object, the default implementation is to return an empty array.
static fetchItemTypeList ($collaborationIdentifier, $userIDList, $asObject=true)
static fetchList ($userID=false, $asObject=true)
static removeByIdentifier ($collaborationIdentifier, $userID=false)
static removeByUserID ($userID)

Detailed Description

The class eZCollaborationNotificationRule does.

Definition at line 16 of file ezcollaborationnotificationrule.php.


Member Function Documentation

Removes all notification rules for all collaboration items for all users.

Definition at line 108 of file ezcollaborationnotificationrule.php.

static eZCollaborationNotificationRule::create ( collaborationIdentifier,
userID = false 
) [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: public 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" ); }

Returns:
array

Reimplemented from eZPersistentObject.

Definition at line 26 of file ezcollaborationnotificationrule.php.

Referenced by fetchItemTypeList(), fetchList(), removeByIdentifier(), and removeByUserID().

static eZCollaborationNotificationRule::fetchItemTypeList ( collaborationIdentifier,
userIDList,
asObject = true 
) [static]
static eZCollaborationNotificationRule::removeByIdentifier ( collaborationIdentifier,
userID = false 
) [static]
static eZCollaborationNotificationRule::removeByUserID ( userID) [static]

Remove notifications by user id

Parameters:
userID

Definition at line 99 of file ezcollaborationnotificationrule.php.

Referenced by eZUser\removeUser().


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