# ControllerInterface

Chevere\Interfaces\Action\ControllerInterface

view source

# Extends

# Description

Describes the component in charge of defining a controller, which is an action intended to be exposed closest to an application entry-point HTTP/CLI mapping.

Key point of a controller is that it only takes string arguments and it provides an additional layer for context parameters.

# Constants

# PARAMETER_TYPE

Type string

'string'

# Methods

# getContextParameters()

Defines context parameters.


# withContextArguments()

# Parameters

  1. mixed ...$namedArguments

RETURN

self


# contextArguments()


# hasContextArguments()

RETURN

bool


# contextParameters()

Provides access to context parameters.


# __construct()


# getParameters()

Defines parameters.


# getResponseDataParameters()

Defines expected response data parameters when executing run method.


# run()

Method called when running the action.

# Parameters

  1. ArgumentsInterface $arguments

# parameters()

Provides access to the parameters.


# responseDataParameters()

Provides access to the expected response data parameters.


# getArguments()

# Parameters

  1. mixed ...$namedArguments

# getResponse()

Retrieves a new success response with type-hinted data.

# Parameters

  1. mixed ...$namedData

# description()

Provides access to the description.

RETURN

string


# getDescription()

Defines the description.

RETURN

string


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