# WorkflowInterface

Chevere\Interfaces\Workflow\WorkflowInterface

view source

# 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

  1. string $name

# name()

Provides access to the instance name.

RETURN

string


# withAdded()

Return an instance with the specified $step.

# Parameters

  1. StepInterface ...$step

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

  1. string $before
  2. StepInterface ...$step

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

  1. string $after
  2. StepInterface ...$step

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

  1. string $step

RETURN

bool


# get()

# Parameters

  1. string $step

# parameters()


# order()

RETURN

array


# hasVar()

# Parameters

  1. string $var

RETURN

bool


# getVar()

Provides access to the $var mapping for job variables.

# Parameters

  1. string $var

RETURN

array

Case ${foo} (workflow parameters):

return ['foo'];

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

return ['step', 'var'];

# getExpected()

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

# Parameters

  1. string $step

RETURN

array


# getGenerator()

RETURN

Generator


Last Updated: 1/16/2021, 9:23:54 PM