eZ Publish  [4.2]
eZTrigger Class Reference

The class eZTrigger does. More...

+ Inheritance diagram for eZTrigger:
+ Collaboration diagram for eZTrigger:

List of all members.

Public Member Functions

 eZTrigger ($row)
 fetchAllowedWorkflows ()

Static Public Member Functions

static createNew ($moduleName, $functionName, $connectType, $workflowID, $name=false)
static definition ()
static fetch ($triggerID)
static fetchList ($parameters=array(), $asObject=true)
static removeTriggerForWorkflow ($workFlowID)
static runTrigger ($name, $moduleName, $function, $parameters, $keys=null)
static runWorkflow ($workflowProcess)

Public Attributes

const FETCH_TEMPLATE = 4
const FETCH_TEMPLATE_REPEAT = 7
const NO_CONNECTED_WORKFLOWS = 3
const REDIRECT = 5
const STATUS_CRON_JOB = 0
const WORKFLOW_CANCELLED = 2
const WORKFLOW_DONE = 1
const WORKFLOW_RESET = 6

Detailed Description

The class eZTrigger does.

Definition at line 39 of file eztrigger.php.


Member Function Documentation

static eZTrigger::createNew ( moduleName,
functionName,
connectType,
workflowID,
name = false 
) [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 363 of file eztrigger.php.

static eZTrigger::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 58 of file eztrigger.php.

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

eZTrigger::eZTrigger ( row)

Constructor

Definition at line 53 of file eztrigger.php.

Referenced by createNew().

static eZTrigger::fetch ( triggerID) [static]

Definition at line 116 of file eztrigger.php.

Referenced by runTrigger(), and runWorkflow().

eZTrigger::fetchAllowedWorkflows ( )

Get array containing allowed workflows for this trigger.

Returns:
array containing allowed workflows

Definition at line 99 of file eztrigger.php.

static eZTrigger::fetchList ( parameters = array(),
asObject = true 
) [static]

Definition at line 124 of file eztrigger.php.

static eZTrigger::removeTriggerForWorkflow ( workFlowID) [static]

Removes triggers which uses the given workflowID.

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 391 of file eztrigger.php.

static eZTrigger::runTrigger ( name,
moduleName,
function,
parameters,
keys = null 
) [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 156 of file eztrigger.php.

Referenced by eZModuleOperationInfo\executeTrigger().

static eZTrigger::runWorkflow ( workflowProcess) [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 259 of file eztrigger.php.

Referenced by runTrigger().


Member Data Documentation

Definition at line 45 of file eztrigger.php.

Referenced by eZModuleOperationInfo\executeTrigger(), and runWorkflow().

Definition at line 46 of file eztrigger.php.

Referenced by eZModuleOperationInfo\executeTrigger(), and runWorkflow().

Definition at line 41 of file eztrigger.php.

Referenced by eZModuleOperationInfo\executeTrigger(), and runWorkflow().

Definition at line 47 of file eztrigger.php.

Referenced by eZModuleOperationInfo\executeTrigger(), and runWorkflow().


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