The class eZNotificationEvent does. More...

Inheritance diagram for eZNotificationEvent:

Collaboration diagram for eZNotificationEvent:

Public Member Functions
	content ()
	eventType ()
	eZNotificationEvent ($row=array())
	initializeEventType ($params=array())
	setContent ($content)
Static Public Member Functions
static	cleanup ()
static	create ($type, $params=array())
static	definition ()
static	fetch ($eventID)
static	fetchList ($limit=null)
	Fetches notification events as objects, and returns them in an array.
static	fetchUnhandledList ($limit=null)
	Fetches unhandled notification events as objects, and returns them in an array.
Public Attributes
	$Content = null
const	STATUS_CREATED = 0
const	STATUS_HANDLED = 1

Detailed Description

The class eZNotificationEvent does.

Definition at line 39 of file eznotificationevent.php.

Member Function Documentation

static eZNotificationEvent::cleanup ( ) [static]

Removes all notification events.

Definition at line 213 of file eznotificationevent.php.

eZNotificationEvent::content ( )

Returns the content for this event.

Definition at line 146 of file eznotificationevent.php.

static eZNotificationEvent::create	(	$	type,
		$	params = `array()`
	)		`[static]`

Definition at line 107 of file eznotificationevent.php.

Referenced by eventType().

static eZNotificationEvent::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 53 of file eznotificationevent.php.

Referenced by fetch(), fetchList(), and fetchUnhandledList().

eZNotificationEvent::eventType ( )

Definition at line 133 of file eznotificationevent.php.

Referenced by content(), and initializeEventType().

eZNotificationEvent::eZNotificationEvent ( $ row = array() )

Constructor

Definition at line 47 of file eznotificationevent.php.

Referenced by create().

static eZNotificationEvent::fetch ( $ eventID ) [static]

Definition at line 183 of file eznotificationevent.php.

static eZNotificationEvent::fetchList ( $ limit = null ) [static]

Fetches notification events as objects, and returns them in an array.

The optional $limit can be used to set an offset and a limit for the fetch. It is passed to eZPersistentObject::fetchObjectList() and should be used in the same way.

Parameters:

array

$limit

An associative array with limitiations, can contain

offset - Numerical value defining the start offset for the fetch
length - Numerical value defining the max number of items to return

Returns:: array An array of eZNotificationEvent objects

Definition at line 176 of file eznotificationevent.php.

static eZNotificationEvent::fetchUnhandledList ( $ limit = null ) [static]

Fetches unhandled notification events as objects, and returns them in an array.

The optional $limit can be used to set an offset and a limit for the fetch. It is passed to eZPersistentObject::fetchObjectList() and should be used in the same way.

Parameters:

array

$limit

An associative array with limitiations, can contain