# ControllerWorkflowInterface

Chevere\Interfaces\Controller\ControllerWorkflowInterface

view source (opens new window)

# Extends

# Description

Describes the component in charge of defining a Controller with Workflow.

# Constants

# PARAMETER_TYPE

Type string

'string'

# Methods

# withSetup

Return an instance with setup (after plugins and dependency injection).

Return

static

This method MUST retain the state of the current instance, and return an instance that contains setup (after plugins and dependency injection).


# __construct


# getParameters

Defines action parameters.


# getResponseParameters

Defines expected response data parameters when executing run method.


# run

Method called when running the action.

Parameters


# parameters

Provides access to the parameters.


# responseParameters

Provides access to the expected response data parameters.


# getArguments

Parameters

  • ...namedArguments: mixed

# getResponse

Retrieves a new success response with type-hinted data.

Parameters

  • ...namedData: mixed

# description

Provides access to the description.

Return

string


# getDescription

Defines the description.

Return

string


# getWorkflow

Defines the Workflow.


# withWorkflow

Return an instance with the specified Workflow.

Parameters

Return

static

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


# workflow

Provides access to the Workflow instance.


# assertWorkflow

Return

void


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