eZ Publish  [trunk]
eZNotificationCollectionItem Class Reference

The class eZNotificationCollectionItem does. More...

+ Inheritance diagram for eZNotificationCollectionItem:
+ Collaboration diagram for eZNotificationCollectionItem:

List of all members.

Public Member Functions

 eZNotificationCollectionItem ($row=array())

Static Public Member Functions

static cleanup ()
static create ($collectionID, $eventID, $address, $sendDate=0)
static definition ()
 Returns the definition for the object, the default implementation is to return an empty array.
static fetchByDate ($date)
static fetchCountForEvent ($eventID)

Detailed Description

The class eZNotificationCollectionItem does.

Definition at line 17 of file eznotificationcollectionitem.php.


Member Function Documentation

Removes all notification collection items.

Definition at line 96 of file eznotificationcollectionitem.php.

static eZNotificationCollectionItem::create ( collectionID,
eventID,
address,
sendDate = 0 
) [static]

Definition at line 62 of file eznotificationcollectionitem.php.

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 27 of file eznotificationcollectionitem.php.

Referenced by fetchByDate(), fetchCountForEvent(), eZGeneralDigestHandler\fetchUsersForDigest(), eZGeneralDigestHandler\handle(), eZNotificationCollection\itemCount(), eZNotificationCollection\items(), and eZNotificationCollection\itemsToSend().

Constructor

Definition at line 22 of file eznotificationcollectionitem.php.

Referenced by create().

static eZNotificationCollectionItem::fetchByDate ( date) [static]

Definition at line 70 of file eznotificationcollectionitem.php.

static eZNotificationCollectionItem::fetchCountForEvent ( eventID) [static]

Definition at line 78 of file eznotificationcollectionitem.php.

Referenced by eZNotificationEventFilter\process().


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