# ActionInterface

Chevere\Interfaces\Action\ActionInterface

view source (opens new window)

# Extends

# Description

Describes the component in charge of defining a single action.

# Methods

# __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


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