# WorkflowInterface

Chevere\Interfaces\Workflow\WorkflowInterface

view source (opens new window)

# Extends

# Description

Describes the component in charge of defining a collection of chained tasks.

# Constants

# REGEX_PARAMETER_REFERENCE

Type string

'/^\\${([\\w-]*)}$/'

# REGEX_STEP_REFERENCE

Type string

'/^\\${([\\w-]*)\\:([\\w-]*)}$/'

# Methods

# __construct

Parameters


# withAdded

Return an instance with the specified $step.

Parameters

Return

self

This method MUST retain the state of the current instance, and return an instance that contains the specified $step.


# withAddedBefore

Return an instance with the specified $step added before $before.

Parameters

Return

self

This method MUST retain the state of the current instance, and return an instance that contains the specified $step added before $before.


# withAddedAfter

Return an instance with the specified $step added after $after.

Parameters

Return

self

This method MUST retain the state of the current instance, and return an instance that contains the specified $step added after $after.


# has

Parameters

  • step: string

Return

bool


# get

Parameters

  • step: string

# dependencies


# parameters


# order

Return

array


# hasVar

Parameters

  • var: string

Return

bool


# getVar

Provides access to the $var mapping for job variables.

Parameters

  • var: string

Return

array

Case ${foo} (workflow parameters):

return ['foo'];

Case ${step:var} (named step responses):

return ['step', 'var'];

# getProvided

Provides access to the expected return arguments for the given $step.

Parameters

  • step: string

# getGenerator


Last Updated: 5/1/2021, 2:31:10 PM