CSWorkflow
in package
Tags
Table of Contents
- getAction() : Action
- Returns the Action with the specified id.
- getActionForExternalKey() : object
- returns the action with the specified id
- getActionsForState() : array<string|int, Action>
- returns an array of all Actions for a given WorkflowID
- getActionsForWorkflow() : array<string|int, mixed>
- returns an array of all Actions for a given WorkflowID
- getFormattedWorkflowsArray() : array<string|int, mixed>
- Returns all defined Workflows in a formatted way
- getState() : State
- returns the State with the specified id
- getStateForExternalKey() : object
- returns the State with the specified external key
- getStateName() : string
- Returns the translated name of a given State.
- getStatesForWorkflow() : States
- Returns all states for a given WorkflowID
- getToppingImageForColor() : string
- returns the topping image for the specified color
- getWorkflow() : Workflow
- returns the Workflow with the specified id
- getWorkflowForExternalKey() : object
- returns the Workflow with the specified external key
- getWorkflowIds() : array<string|int, mixed>
- Returns all workflow ids with the specified type
- getWorkflowLabel() : mixed|string
- Returns the (translated) Label of a Workflow Name.
- getWorkflows() : array<string|int, mixed>
- Returns all Workflows with the specified type
Methods
getAction()
Returns the Action with the specified id.
public
static getAction(int $actionID) : Action
Parameters
- $actionID : int
-
The id of the action
Tags
Return values
Action —the action object
getActionForExternalKey()
returns the action with the specified id
public
static getActionForExternalKey(mixed $externalKey) : object
Parameters
- $externalKey : mixed
Tags
Return values
object —the action object
getActionsForState()
returns an array of all Actions for a given WorkflowID
public
static getActionsForState(mixed $stateID) : array<string|int, Action>
Parameters
- $stateID : mixed
Tags
Return values
array<string|int, Action> —array of action objects
getActionsForWorkflow()
returns an array of all Actions for a given WorkflowID
public
static getActionsForWorkflow(int $worklowID) : array<string|int, mixed>
Parameters
- $worklowID : int
-
the id of the Workflow
Tags
Return values
array<string|int, mixed> —of action objects
getFormattedWorkflowsArray()
Returns all defined Workflows in a formatted way
public
static getFormattedWorkflowsArray([mixed $mType = NULL ][, array<string|int, mixed> $aParams = array() ]) : array<string|int, mixed>
Parameters
- $mType : mixed = NULL
-
Possible Types see Workflow::getWorkflowTypes
- $aParams : array<string|int, mixed> = array()
-
Possible params to define how the value should be formatted, e.g. 'types' if TRUE then show the WorkflowType in the label
Tags
Return values
array<string|int, mixed> —An array with formatted WorkflowNames with key as WorkflowId and value WorkflowName
getState()
returns the State with the specified id
public
static getState(int $stateID) : State
Parameters
- $stateID : int
-
the id of the state
Tags
Return values
State —the state object
getStateForExternalKey()
returns the State with the specified external key
public
static getStateForExternalKey(string $externalKey) : object
Parameters
- $externalKey : string
-
the external key of the workflow
Tags
Return values
object —the state object
getStateName()
Returns the translated name of a given State.
public
static getStateName(int $stateID) : string
Parameters
- $stateID : int
-
the ID of the requested State
Tags
Return values
string —the translated name of the State
getStatesForWorkflow()
Returns all states for a given WorkflowID
public
static getStatesForWorkflow(int $iWorkflowID) : States
Parameters
- $iWorkflowID : int
-
the WorkflowID of the workflow of which the states should be returned
Tags
Return values
States —all states of a workflow
getToppingImageForColor()
returns the topping image for the specified color
public
getToppingImageForColor(string $color) : string
Parameters
- $color : string
-
the color for which the topping image should be returned
Tags
Return values
string —the path to the topping image
getWorkflow()
returns the Workflow with the specified id
public
static getWorkflow(int $workflowID) : Workflow
Parameters
- $workflowID : int
-
the id of the workflow
Tags
Return values
Workflow —the workflow object
getWorkflowForExternalKey()
returns the Workflow with the specified external key
public
static getWorkflowForExternalKey(string $externalKey) : object
Parameters
- $externalKey : string
-
the external key of the workflow
Tags
Return values
object —the workflow object
getWorkflowIds()
Returns all workflow ids with the specified type
public
static getWorkflowIds([string $sWorkflowType = '' ]) : array<string|int, mixed>
Parameters
- $sWorkflowType : string = ''
Tags
Return values
array<string|int, mixed> —getWorkflowLabel()
Returns the (translated) Label of a Workflow Name.
public
static getWorkflowLabel(int $iWorkflowId) : mixed|string
Parameters
- $iWorkflowId : int
-
The ID of the Workflow.
Tags
Return values
mixed|string —getWorkflows()
Returns all Workflows with the specified type
public
static getWorkflows([string $workflowType = null ]) : array<string|int, mixed>
Parameters
- $workflowType : string = null
-
the type of the workflow
Tags
Return values
array<string|int, mixed> —an array with all workflows with the specified type