The class eZNotificationCollection does. More...
Inheritance diagram for eZNotificationCollection:
Collaboration diagram for eZNotificationCollection:
Public Member Functions | |
| addItem ($address, $sendDate=0) | |
| eZNotificationCollection ($row=array()) | |
| itemCount () | |
| items () | |
| itemsToSend () | |
Static Public Member Functions | |
| static | cleanup () |
| static | create ($eventID, $handler, $transport) |
| static | definition () |
| Returns the definition for the object, the default implementation is to return an empty array. | |
| static | fetchForHandler ($handler, $eventID, $transport) |
| static | fetchListForHandler ($handler, $eventID, $transport) |
| static | removeEmpty () |
Detailed Description
The class eZNotificationCollection does.
Definition at line 16 of file eznotificationcollection.php.
Member Function Documentation
| eZNotificationCollection::addItem | ( | $ | address, |
| $ | sendDate = 0 |
||
| ) |
Definition at line 73 of file eznotificationcollection.php.
| static eZNotificationCollection::cleanup | ( | ) | [static] |
Removes all notification collections.
- 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 157 of file eznotificationcollection.php.
| static eZNotificationCollection::create | ( | $ | eventID, |
| $ | handler, | ||
| $ | transport | ||
| ) | [static] |
Definition at line 66 of file eznotificationcollection.php.
Referenced by addItem(), eZCollaborationItemHandler\handleCollaborationEvent(), and eZSubTreeHandler\handlePublishEvent().
| static eZNotificationCollection::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: 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 eznotificationcollection.php.
Referenced by fetchForHandler(), fetchListForHandler(), and removeEmpty().
| eZNotificationCollection::eZNotificationCollection | ( | $ | row = array() | ) |
| static eZNotificationCollection::fetchForHandler | ( | $ | handler, |
| $ | eventID, | ||
| $ | transport | ||
| ) | [static] |
Definition at line 109 of file eznotificationcollection.php.
Referenced by eZSubTreeHandler\sendMessage().
| static eZNotificationCollection::fetchListForHandler | ( | $ | handler, |
| $ | eventID, | ||
| $ | transport | ||
| ) | [static] |
Definition at line 117 of file eznotificationcollection.php.
Referenced by eZCollaborationNotificationHandler\sendMessage().
Definition at line 87 of file eznotificationcollection.php.
Definition at line 80 of file eznotificationcollection.php.
Definition at line 101 of file eznotificationcollection.php.
| static eZNotificationCollection::removeEmpty | ( | ) | [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.
Definition at line 129 of file eznotificationcollection.php.
Referenced by eZNotificationEventFilter\process().
The documentation for this class was generated from the following file:
