! eZKernel The class eZWorkflowEvent does More...

Inheritance diagram for eZWorkflowEvent:

Collaboration diagram for eZWorkflowEvent:

Public Member Functions
	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.
	attributes ()
	Returns the attributes for this object, taken from the definition fields and function attributes.
	content ()
	customHTTPAction ($http, $action)
	eventType ()
	eZWorkflowEvent ($row)
	hasAttribute ($attr)
	Checks if $attr is part of the definition fields or function attributes.
	move ($down, $params=null)
	setContent ($content)
	store ($fieldFilters=null)
	storeDefined ($fieldFilters=null)
Static Public Member Functions
static	create ($workflowID, $typeString)
	Creates a new workflow event.
static	definition ()
	Returns the definition for the object, the default implementation is to return an empty array.
static	fetch ($id, $asObject=true, $version=0, $field_filters=null)
static	fetchFilteredList ($cond, $asObject=true)
static	fetchList ($asObject=true)
Public Attributes
	$Content
	$DataInt1
	$DataInt2
	$DataInt3
	$DataInt4
	$DataText1
	$DataText2
	$DataText3
	$DataText4
	$Description
	$ID
	$Placement
	$TypeString
	$Version
	$WorkflowID

Detailed Description

! eZKernel The class eZWorkflowEvent does

Definition at line 17 of file ezworkflowevent.php.

Member Function Documentation

eZWorkflowEvent::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.

Parameters:

string	$attr
bool	$noFunction

Returns:: mixed

Reimplemented from eZPersistentObject.

Definition at line 188 of file ezworkflowevent.php.

Referenced by store().

eZWorkflowEvent::attributes ( )

Returns the attributes for this object, taken from the definition fields and function attributes.

See also:: eZPersistentObject::definition()

Returns:: array

Reimplemented from eZPersistentObject.

Definition at line 176 of file ezworkflowevent.php.

eZWorkflowEvent::content ( )

Returns the content for this event.

Definition at line 211 of file ezworkflowevent.php.

static eZWorkflowEvent::create	(	$	workflowID,
		$	typeString
	)		`[static]`

Creates a new workflow event.

Parameters:

int	$workflowID
string	$typeString

Returns:: eZWorkflowEvent

Definition at line 113 of file ezworkflowevent.php.

eZWorkflowEvent::customHTTPAction	(	$	http,
		$	action
	)

Executes the custom HTTP action

Definition at line 234 of file ezworkflowevent.php.

static eZWorkflowEvent::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 25 of file ezworkflowevent.php.

Referenced by create(), fetch(), eZWorkflow\fetchEventCount(), eZWorkflow\fetchEventCountByWorkflowID(), eZWorkflow\fetchEventIndexed(), fetchFilteredList(), fetchList(), move(), eZWorkflow\removeEvents(), eZWorkflow\removeTemporary(), and eZWorkflow\removeThis().

eZWorkflowEvent::eventType ( )

Definition at line 199 of file ezworkflowevent.php.

Referenced by attribute(), attributes(), content(), customHTTPAction(), hasAttribute(), store(), and storeDefined().

eZWorkflowEvent::eZWorkflowEvent ( $ row )

Definition at line 19 of file ezworkflowevent.php.

Referenced by create().

static eZWorkflowEvent::fetch	(	$	id,
		$	asObject = `true`,
		$	version = `0`,
		$	field_filters = `null`
	)		`[static]`

Definition at line 128 of file ezworkflowevent.php.

Referenced by eZMultiplexerType\execute(), and eZWorkflowProcess\removeThis().

static eZWorkflowEvent::fetchFilteredList	(	$	cond,
		$	asObject = `true`
	)		`[static]`

Definition at line 144 of file ezworkflowevent.php.

Referenced by eZWorkflow\fetchEvents(), and eZWorkflow\fetchEventsByWorkflowID().

static eZWorkflowEvent::fetchList ( $ asObject = true ) [static]

Definition at line 137 of file ezworkflowevent.php.

eZWorkflowEvent::hasAttribute ( $ attr )

Checks if $attr is part of the definition fields or function attributes.

Parameters:

string $attr

Returns:: bool

Reimplemented from eZPersistentObject.

Definition at line 181 of file ezworkflowevent.php.

eZWorkflowEvent::move	(	$	down,
		$	params = `null`
	)

Moves the object down if $down is true, otherwise up. If object is at either top or bottom it is wrapped around.

Definition at line 155 of file ezworkflowevent.php.

eZWorkflowEvent::setContent ( $ content )

Sets the content for the current event

Definition at line 225 of file ezworkflowevent.php.

eZWorkflowEvent::store ( $ fieldFilters = null )

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.

Reimplemented from eZPersistentObject.

Definition at line 244 of file ezworkflowevent.php.

Referenced by storeDefined().

eZWorkflowEvent::storeDefined ( $ fieldFilters = null )

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 268 of file ezworkflowevent.php.

Member Data Documentation

eZWorkflowEvent::$Content

Definition at line 304 of file ezworkflowevent.php.

eZWorkflowEvent::$DataInt1

Definition at line 296 of file ezworkflowevent.php.

eZWorkflowEvent::$DataInt2

Definition at line 297 of file ezworkflowevent.php.

eZWorkflowEvent::$DataInt3

Definition at line 298 of file ezworkflowevent.php.

eZWorkflowEvent::$DataInt4

Definition at line 299 of file ezworkflowevent.php.

eZWorkflowEvent::$DataText1

Definition at line 300 of file ezworkflowevent.php.

eZWorkflowEvent::$DataText2

Definition at line 301 of file ezworkflowevent.php.

eZWorkflowEvent::$DataText3

Definition at line 302 of file ezworkflowevent.php.

eZWorkflowEvent::$DataText4

Definition at line 303 of file ezworkflowevent.php.

eZWorkflowEvent::$Description

Definition at line 294 of file ezworkflowevent.php.

eZWorkflowEvent::$ID

Definition at line 290 of file ezworkflowevent.php.

eZWorkflowEvent::$Placement

Definition at line 295 of file ezworkflowevent.php.

eZWorkflowEvent::$TypeString

Definition at line 293 of file ezworkflowevent.php.

eZWorkflowEvent::$Version

Definition at line 291 of file ezworkflowevent.php.

eZWorkflowEvent::$WorkflowID

Definition at line 292 of file ezworkflowevent.php.

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

ezworkflowevent.php

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

Member Data Documentation