eZPublish(LegacyStack)  5.1
eZWorkflowType Class Reference

! eZKernel The class eZWorkflowType does More...

+ Inheritance diagram for eZWorkflowType:

Public Member Functions

 attribute ($attr)
 
 attributeDecoder ($event, $attr)
 
 attributes ()
 
 cleanup ($process, $event)
 
 cleanupAfterRemoving ($attr=array())
 
 customWorkflowEventHTTPAction ($http, $action, $workflowEvent)
 
 eventDescription ()
 
 execute ($process, $event)
 
 eZWorkflowType ($group, $type, $groupName, $name)
 
 fetchHTTPInput ($http, $base, $event)
 
 fixupHTTPInput ($http, $base, $event)
 
 hasAttribute ($attr)
 
 initializeEvent ($event)
 
 isAllowed ($moduleName, $functionName, $connectType)
 
 needCleanup ()
 
 setActivationDate ($date)
 
 setAttribute ($attr, $value)
 
 setInformation ($inf)
 
 setTriggerTypes ($allowedTypes)
 
 storeDefinedEventData ($event)
 
 storeEventData ($event, $version)
 
 typeFunctionalAttributes ()
 
 validateHTTPInput ($http, $base, $event, &$validation)
 
 workflowEventContent ($event)
 

Static Public Member Functions

static allowedTypes ()
 
static createType ($typeString)
 
static fetchRegisteredTypes ()
 
static loadAndRegisterAllTypes ()
 
static loadAndRegisterType ($typeString)
 
static registerType ($group, $type, $class_name)
 
static statusName ($status)
 
static statusNameMap ()
 Get status name map. More...
 

Public Attributes

 $ActivationDate
 
 $Group
 
 $GroupName
 
 $Information
 
 $Name
 
 $TriggerTypes = array( '*' => true )
 
 $Type
 
 $TypeString
 
const STATUS_ACCEPTED = 1
 
const STATUS_DEFERRED_TO_CRON = 3
 
const STATUS_DEFERRED_TO_CRON_REPEAT = 4
 
const STATUS_FETCH_TEMPLATE = 7
 
const STATUS_FETCH_TEMPLATE_REPEAT = 8
 
const STATUS_NONE = 0
 
const STATUS_REDIRECT = 10
 
const STATUS_REDIRECT_REPEAT = 11
 
const STATUS_REJECTED = 2
 
const STATUS_RUN_SUB_EVENT = 5
 
const STATUS_WORKFLOW_CANCELLED = 6
 
const STATUS_WORKFLOW_DONE = 9
 
const STATUS_WORKFLOW_RESET = 12
 

Detailed Description

! eZKernel The class eZWorkflowType does

Member Function Documentation

static eZWorkflowType::allowedTypes ( )
static

Referenced by loadAndRegisterAllTypes().

eZWorkflowType::attributeDecoder (   $event,
  $attr 
)
eZWorkflowType::cleanup (   $process,
  $event 
)
eZWorkflowType::cleanupAfterRemoving (   $attr = array())
static eZWorkflowType::createType (   $typeString)
static
eZWorkflowType::customWorkflowEventHTTPAction (   $http,
  $action,
  $workflowEvent 
)
eZWorkflowType::eventDescription ( )

Referenced by attribute().

eZWorkflowType::execute (   $process,
  $event 
)
eZWorkflowType::eZWorkflowType (   $group,
  $type,
  $groupName,
  $name 
)
eZWorkflowType::fetchHTTPInput (   $http,
  $base,
  $event 
)
static eZWorkflowType::fetchRegisteredTypes ( )
static

Referenced by eZContentObject\purge().

eZWorkflowType::fixupHTTPInput (   $http,
  $base,
  $event 
)
eZWorkflowType::hasAttribute (   $attr)
eZWorkflowType::initializeEvent (   $event)
eZWorkflowType::isAllowed (   $moduleName,
  $functionName,
  $connectType 
)

Check if specified trigger is allowed

Parameters
$moduleNamemodule name
$functionNamefunction name
$connectTypeconnection type
Returns
true is allowed, false if not.
static eZWorkflowType::loadAndRegisterAllTypes ( )
static

Referenced by fetchRegisteredTypes().

static eZWorkflowType::loadAndRegisterType (   $typeString)
static
eZWorkflowType::needCleanup ( )
static eZWorkflowType::registerType (   $group,
  $type,
  $class_name 
)
static
eZWorkflowType::setActivationDate (   $date)
eZWorkflowType::setAttribute (   $attr,
  $value 
)
eZWorkflowType::setInformation (   $inf)
eZWorkflowType::setTriggerTypes (   $allowedTypes)

Set trigger types.

Parameters
allowedtrigger types format : array( <module> => array( <function> => array( <event> ) ) ) if all is allowed, array( '*' => true )

Referenced by eZFinishUserRegisterType\__construct(), eZApproveType\eZApproveType(), eZSimpleShippingType\eZSimpleShippingType(), and eZWaitUntilDateType\eZWaitUntilDateType().

static eZWorkflowType::statusName (   $status)
static

Referenced by eZWorkflowProcess\run().

static eZWorkflowType::statusNameMap ( )
static

Get status name map.

Returns
array Status name map

Referenced by eZWorkflowFunctionCollection\fetchWorkflowTypeStatuses().

eZWorkflowType::storeDefinedEventData (   $event)
eZWorkflowType::storeEventData (   $event,
  $version 
)
eZWorkflowType::typeFunctionalAttributes ( )
eZWorkflowType::validateHTTPInput (   $http,
  $base,
  $event,
$validation 
)
eZWorkflowType::workflowEventContent (   $event)

Member Data Documentation

eZWorkflowType::$ActivationDate

Referenced by eZWorkflowType().

eZWorkflowType::$Group

Referenced by eZWorkflowType().

eZWorkflowType::$GroupName

Referenced by eZWorkflowType().

eZWorkflowType::$Information

Referenced by eZWorkflowType().

eZWorkflowType::$Name

Referenced by eZWorkflowType().

eZWorkflowType::$TriggerTypes = array( '*' => true )

Referenced by attribute().

eZWorkflowType::$Type

Referenced by eZWorkflowType().

eZWorkflowType::$TypeString

Referenced by eZWorkflowType().

const eZWorkflowType::STATUS_DEFERRED_TO_CRON = 3

Referenced by eZWorkflowProcess\run().

const eZWorkflowType::STATUS_FETCH_TEMPLATE = 7

Referenced by eZWorkflowProcess\run().

const eZWorkflowType::STATUS_FETCH_TEMPLATE_REPEAT = 8
const eZWorkflowType::STATUS_NONE = 0

Referenced by execute(), and eZWorkflowProcess\run().

const eZWorkflowType::STATUS_REDIRECT = 10

Referenced by eZWorkflowProcess\run().

const eZWorkflowType::STATUS_REDIRECT_REPEAT = 11
const eZWorkflowType::STATUS_RUN_SUB_EVENT = 5

Referenced by eZWorkflowProcess\run().

const eZWorkflowType::STATUS_WORKFLOW_DONE = 9

Referenced by eZWorkflowProcess\run().

const eZWorkflowType::STATUS_WORKFLOW_RESET = 12

Referenced by eZWorkflowProcess\run().


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