eZPublish(LegacyStack)  5.1
eZWorkflow Class Reference

! eZKernel The class eZWorkflow does More...

+ Inheritance diagram for eZWorkflow:
+ Collaboration diagram for eZWorkflow:

Public Member Functions

 cleanupWorkFlowProcess ()
 
 creator ()
 
 eZWorkflow ($row)
 
 fetchEventCount ($version=false)
 
 fetchEventIndexed ($index)
 
 fetchEvents ($asObject=true, $version=false)
 
 groupList ()
 
 ingroupIDList ()
 
 ingroupList ()
 
 isAllowed ($moduleName, $functionName, $connectType)
 
 modifier ()
 
 removeThis ($remove_childs=false)
 
 setVersion ($version, $set_childs=false)
 
 store ($store_childs=false)
 
 storeDefined ($store_childs=false)
 
 workflowType ()
 
- 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 adjustEventPlacements ($events)
 
static create ($user_id)
 
static definition ()
 
static fetch ($id, $asObject=true, $version=0)
 
static fetchEventCountByWorkflowID ($id, $version=0)
 
static fetchEventsByWorkflowID ($id, $asObject=true, $version=0)
 
static fetchLimited ($moduleName, $functionName, $connectType)
 
static fetchList ($version=0, $enabled=1, $asObject=true)
 
static fetchListCount ($version=0, $enabled=1)
 
static removeEvents ($events=false, $id=false, $version=false)
 
static removeTemporary ()
 
static removeWorkflow ($id, $version)
 
static setIsEnabled ($enabled, $id, $version=0)
 
static statusName ($status)
 
static statusNameMap ()
 Get status name map. 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

 $AllGroups
 
 $Created
 
 $CreatorID
 
 $ID
 
 $InGroupIDs
 
 $InGroups
 
 $IsEnabled
 
 $Modified
 
 $ModifierID
 
 $Name
 
 $Version
 
 $WorkflowTypeString
 
const STATUS_BUSY = 1
 
const STATUS_CANCELLED = 5
 
const STATUS_DEFERRED_TO_CRON = 4
 
const STATUS_DONE = 2
 
const STATUS_FAILED = 3
 
const STATUS_FETCH_TEMPLATE = 6
 
const STATUS_FETCH_TEMPLATE_REPEAT = 10
 
const STATUS_NONE = 0
 
const STATUS_REDIRECT = 7
 
const STATUS_RESET = 8
 
const STATUS_WAITING_PARENT = 9
 
- Public Attributes inherited from eZPersistentObject
 $PersistentDataDirty
 

Detailed Description

! eZKernel The class eZWorkflow does

Member Function Documentation

static eZWorkflow::adjustEventPlacements (   $events)
static
eZWorkflow::cleanupWorkFlowProcess ( )
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.
static eZWorkflow::create (   $user_id)
static
eZWorkflow::creator ( )
static eZWorkflow::definition ( )
static
eZWorkflow::eZWorkflow (   $row)

Referenced by create().

static eZWorkflow::fetch (   $id,
  $asObject = true,
  $version = 0 
)
static
eZWorkflow::fetchEventCount (   $version = false)
static eZWorkflow::fetchEventCountByWorkflowID (   $id,
  $version = 0 
)
static
eZWorkflow::fetchEventIndexed (   $index)
eZWorkflow::fetchEvents (   $asObject = true,
  $version = false 
)
static eZWorkflow::fetchEventsByWorkflowID (   $id,
  $asObject = true,
  $version = 0 
)
static
static eZWorkflow::fetchLimited (   $moduleName,
  $functionName,
  $connectType 
)
static

Fetch workflows based on module, function and connection type

Parameters
$moduleNamemodule name
$functionNamefunction name
$connectTypeconnection type
Returns
array of allowed workflows limited by trigger

Referenced by eZTrigger\fetchAllowedWorkflows().

static eZWorkflow::fetchList (   $version = 0,
  $enabled = 1,
  $asObject = true 
)
static
static eZWorkflow::fetchListCount (   $version = 0,
  $enabled = 1 
)
static
eZWorkflow::groupList ( )
eZWorkflow::ingroupIDList ( )
eZWorkflow::ingroupList ( )
eZWorkflow::isAllowed (   $moduleName,
  $functionName,
  $connectType 
)

Check if a trigger specified trigger is allowed to use with this workflow

Parameters
$moduleNamemodule name
$functionNamefunction name
$connectTypeconnection type
Returns
true if allowed, false if not.

Referenced by fetchLimited().

eZWorkflow::modifier ( )
static eZWorkflow::removeEvents (   $events = false,
  $id = false,
  $version = 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.
static eZWorkflow::removeTemporary ( )
static

Removes all temporary versions.

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.
eZWorkflow::removeThis (   $remove_childs = false)
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.
static eZWorkflow::removeWorkflow (   $id,
  $version 
)
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.
static eZWorkflow::setIsEnabled (   $enabled,
  $id,
  $version = 0 
)
static
eZWorkflow::setVersion (   $version,
  $set_childs = false 
)
static eZWorkflow::statusName (   $status)
static
static eZWorkflow::statusNameMap ( )
static

Get status name map.

Returns
array Status name map.

Referenced by eZWorkflowFunctionCollection\fetchWorkflowStatuses().

eZWorkflow::store (   $store_childs = false)
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.
eZWorkflow::storeDefined (   $store_childs = false)
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.
eZWorkflow::workflowType ( )

Member Data Documentation

eZWorkflow::$AllGroups

Referenced by groupList().

eZWorkflow::$Created
eZWorkflow::$CreatorID
eZWorkflow::$ID

Referenced by fetchEventIndexed().

eZWorkflow::$InGroupIDs

Referenced by ingroupIDList().

eZWorkflow::$InGroups

Referenced by ingroupList().

eZWorkflow::$IsEnabled
eZWorkflow::$Modified
eZWorkflow::$ModifierID
eZWorkflow::$Name
eZWorkflow::$Version

Referenced by fetchEventCount(), and fetchEvents().

eZWorkflow::$WorkflowTypeString
const eZWorkflow::STATUS_BUSY = 1
const eZWorkflow::STATUS_FETCH_TEMPLATE_REPEAT = 10
const eZWorkflow::STATUS_NONE = 0
const eZWorkflow::STATUS_RESET = 8
const eZWorkflow::STATUS_WAITING_PARENT = 9

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