yii2-workflow Class Reference
  • Namespace
  • Class

Namespaces

  • raoul2000
    • workflow
      • actions
      • base
      • events
      • helpers
      • source
        • file
      • validation

Classes

  • SimpleWorkflowBehavior
  • Status
  • StatusIdConverter
  • Transition
  • Workflow
  • WorkflowBaseObject
  • WorkflowException
  • WorkflowValidationException

Interfaces

  • IStatusAccessor
  • IStatusIdConverter
  • StatusInterface
  • TransitionInterface
  • WorkflowInterface

Class Status

A Status object is a component of a workflow.

yii\base\Object
Extended by raoul2000\workflow\base\WorkflowBaseObject
Extended by raoul2000\workflow\base\Status implements raoul2000\workflow\base\StatusInterface
Namespace: raoul2000\workflow\base
Author: Raoul
Located at base/Status.php

Methods summary

public
# __construct( array $config = [] )

Status constructor.

Status constructor.

To create a Status you must provide following values in the $config array passed as argument:

  • id : the id for this status.
  • **workflowId ** : the id of the workflow this status belongs to.

Following values are optional :

  • label : human readable name for this status.

Parameters

$config

Throws

yii\base\InvalidConfigException

Overrides

raoul2000\workflow\base\WorkflowBaseObject::__construct
public string
# getId( )

Returns the id of this status.

Returns the id of this status.

Note that the status id returned must be unique inside the workflow it belongs to, but it doesn't have to be unique among all workflows.

Returns

string
the id for this status

Implementation of

raoul2000\workflow\base\StatusInterface::getId()
public string
# getLabel( )

Returns the label for this status.

Returns the label for this status.

Returns

string
the label for this status. .

Implementation of

raoul2000\workflow\base\StatusInterface::getLabel()
public string
# getWorkflowId( )

Returns

string
the id of the workflow this status belongs to.

Implementation of

raoul2000\workflow\base\StatusInterface::getWorkflowId()
public raoul2000\workflow\base\Transition[]
# getTransitions( )

Returns

raoul2000\workflow\base\Transition[]
the list of out-going transitions for this status.

See

raoul2000\workflow\base\StatusInterface::getTransitions()

Implementation of

raoul2000\workflow\base\StatusInterface::getTransitions()
public raoul2000\workflow\base\Workflow
# getWorkflow( )

Returns

raoul2000\workflow\base\Workflow
the workflow instance

See

raoul2000\workflow\base\StatusInterface::getWorkflow()

Implementation of

raoul2000\workflow\base\StatusInterface::getWorkflow()
public boolean
# isInitialStatus( )

Returns

boolean
TRUE if this status is the initial status of its parent workflow, FALSE otherwise

See

raoul2000\workflow\base\StatusInterface::isInitialStatus()

Implementation of

raoul2000\workflow\base\StatusInterface::isInitialStatus()

Methods inherited from raoul2000\workflow\base\WorkflowBaseObject

__get(), getMetadata(), getSource(), hasMetadata()

yii2-workflow Class Reference API documentation generated by ApiGen