eZPublish  4.7
eZNotificationEvent Class Reference

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)
 
- Public Member Functions inherited from eZPersistentObject
 attribute ($attr, $noFunction=false)
 Returns the attribute data for $attr, this is either returned from the member variables or a member function depending on whether the definition field or function attributes matched. More...
 
 attributes ()
 Returns the attributes for this object, taken from the definition fields and function attributes. More...
 
 eZPersistentObject ($row)
 Initializes the object with the $row. More...
 
 fill ($row)
 Tries to fill in the data in the object by using the object definition which is returned by the function definition() and the database row data $row. More...
 
 hasAttribute ($attr)
 Checks if $attr is part of the definition fields or function attributes. More...
 
 hasDirtyData ()
 Returns true if the data is considered dirty and needs to be stored. More...
 
 remove ($conditions=null, $extraConditions=null)
 Removes the object from the database, it will use the keys in the object definition to figure out which table row should be removed unless $conditions is defined as an array with fieldnames. More...
 
 setAttribute ($attr, $val)
 Sets the attribute $attr to the value $val. More...
 
 setHasDirtyData ($hasDirtyData)
 Sets whether the object has dirty data or not. More...
 
 store ($fieldFilters=null)
 Stores the object in the database, uses storeObject() to do the actual job and passes $fieldFilters to it. More...
 
 sync ($fieldFilters=null)
 Makes sure data is stored if the data is considered dirty. More...
 

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. More...
 
static fetchUnhandledList ($limit=null)
 Fetches unhandled notification events as objects, and returns them in an array. More...
 
- Static Public Member Functions inherited from eZPersistentObject
static conditionText ($conditions)
 Calls conditionTextByRow with an empty row and $conditions. More...
 
static conditionTextByRow ($conditions, $row)
 Generates an SQL sentence from the conditions $conditions and row data $row. More...
 
static count ($def, $conds=null, $field=null)
 Fetches the number of rows by using the object definition. More...
 
static definition ()
 Returns the definition for the object, the default implementation is to return an empty array. More...
 
static escapeArray ($array)
 Escapes strings in an array with the help of eZDBInterface::escapeString(). More...
 
static fetchObject ($def, $field_filters, $conds, $asObject=true, $grouping=null, $custom_fields=null)
 Fetches and returns an object based on the given parameters and returns is either as an object or as an array. More...
 
static fetchObjectList ($def, $field_filters=null, $conds=null, $sorts=null, $limit=null, $asObject=true, $grouping=false, $custom_fields=null, $custom_tables=null, $custom_conds=null)
 Creates an SQL query out of the different parameters and returns an array with the result. More...
 
static getShortAttributeName ($db, $def, $attrName)
 Returns the short attribute name (alias) if it's defined, given attribute name otherwise. More...
 
static handleRows ($rows, $class_name, $asObject)
 Creates PHP objects out of the database rows $rows. More...
 
static newObjectOrder ($def, $orderField, $conditions)
 Returns an order value which can be used for new items in table, for instance placement. More...
 
static removeObject ($def, $conditions=null, $extraConditions=null)
 Deletes the object from the table defined in $def with conditions $conditions and extra conditions $extraConditions. More...
 
static reorderObject ($def, $orderField, $conditions, $down=true)
 Moves a row in a database table. More...
 
static replaceFieldsWithShortNames ($db, $fieldDefs, &$fields)
 For the given array $fields treats its keys (for associative array) or values (for non-associative array) as table fields names and replaces them with short names (aliases) found in $fieldDefs. More...
 
static storeObject ($obj, $fieldFilters=null)
 Stores the data in $obj to database. More...
 
static swapRow ($table, $keys, $order_id, $rows, $id1, $id2)
 Sets row id $id2 to have the placement of row id $id1. More...
 
static updateObjectList ($parameters)
 Updates rows matching the given parameters. More...
 

Public Attributes

 $Content = null
 
const STATUS_CREATED = 0
 
const STATUS_HANDLED = 1
 
- Public Attributes inherited from eZPersistentObject
 $PersistentDataDirty
 

Detailed Description

The class eZNotificationEvent does.

Member Function Documentation

static eZNotificationEvent::cleanup ( )
static

Removes all notification events.

eZNotificationEvent::content ( )

Returns the content for this event.

static eZNotificationEvent::create (   $type,
  $params = array() 
)
static
static eZNotificationEvent::definition ( )
static
eZNotificationEvent::eventType ( )

Referenced by content(), and initializeEventType().

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

Constructor

Referenced by create().

static eZNotificationEvent::fetch (   $eventID)
static
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$limitAn 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
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$limitAn 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

Referenced by eZNotificationEventFilter\process().

eZNotificationEvent::initializeEventType (   $params = array())
eZNotificationEvent::setContent (   $content)

Sets the content for the current event

Member Data Documentation

eZNotificationEvent::$Content = null

Referenced by content().

const eZNotificationEvent::STATUS_CREATED = 0
const eZNotificationEvent::STATUS_HANDLED = 1

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