Slim\Interfaces\RouteInterface Interface Reference

Inheritance diagram for Slim\Interfaces\RouteInterface:

Public Member Functions
	add ($middleware)
	addMiddleware (MiddlewareInterface $middleware)
	getArgument (string $name, ?string $default=null)
	Retrieve a specific route argument.
	getArguments ()
	Get route arguments.
	getCallable ()
	Get route callable.
	getIdentifier ()
	Get the route's unique identifier.
	getInvocationStrategy ()
	Get route invocation strategy.
	getMethods ()
	Get route methods.
	getName ()
	Get route name.
	getPattern ()
	Get route pattern.
	prepare (array $arguments)
	Prepare the route for use.
	run (ServerRequestInterface $request)
	Run route.
	setArgument (string $name, string $value)
	Set a route argument.
	setArguments (array $arguments)
	Replace route arguments.
	setCallable ($callable)
	Set route callable.
	setInvocationStrategy (InvocationStrategyInterface $invocationStrategy)
	Set route invocation strategy.
	setName (string $name)
	Set route name.
	setPattern (string $pattern)
	Set route pattern.

Member Function Documentation

add()

Slim\Interfaces\RouteInterface::add

(

$middleware

)

Parameters

MiddlewareInterface | string | callable

$middleware

Implemented in Slim\Routing\Route.

addMiddleware()

Slim\Interfaces\RouteInterface::addMiddleware

(

MiddlewareInterface

$middleware

)

Implemented in Slim\Routing\Route.

getArgument()

Slim\Interfaces\RouteInterface::getArgument	(	string	$name,
		?string	$default = null )

Retrieve a specific route argument.

Implemented in Slim\Routing\Route.

getArguments()

Slim\Interfaces\RouteInterface::getArguments

(

)

Get route arguments.

Return values

array<string,string>

Implemented in Slim\Routing\Route.

getCallable()

Slim\Interfaces\RouteInterface::getCallable

(

)

Get route callable.

Return values

callable|string

Implemented in Slim\Routing\Route.

getIdentifier()

Slim\Interfaces\RouteInterface::getIdentifier

(

)

Get the route's unique identifier.

Implemented in Slim\Routing\Route.

getInvocationStrategy()

Slim\Interfaces\RouteInterface::getInvocationStrategy

(

)

Get route invocation strategy.

Implemented in Slim\Routing\Route.

getMethods()

Slim\Interfaces\RouteInterface::getMethods

(

)

Get route methods.

Return values

string[]

Implemented in Slim\Routing\Route.

getName()

Slim\Interfaces\RouteInterface::getName

(

)

Get route name.

Implemented in Slim\Routing\Route.

getPattern()

Slim\Interfaces\RouteInterface::getPattern

(

)

Get route pattern.

Implemented in Slim\Routing\Route.

prepare()

Slim\Interfaces\RouteInterface::prepare

(

array

$arguments

)

Prepare the route for use.

Parameters

array<string,string>

$arguments

Implemented in Slim\Routing\Route.

run()

Slim\Interfaces\RouteInterface::run

(

ServerRequestInterface

$request

)

Run route.

This method traverses the middleware stack, including the route's callable and captures the resultant HTTP response object. It then sends the response back to the Application.

Implemented in Slim\Routing\Route.

setArguments()

Slim\Interfaces\RouteInterface::setArguments

(

array

$arguments

)

Replace route arguments.

Parameters

array<string,string>

$arguments

setCallable()

Slim\Interfaces\RouteInterface::setCallable

(

$callable

)

Set route callable.

Parameters

callable | string

$callable

Implemented in Slim\Routing\Route.

setInvocationStrategy()

Slim\Interfaces\RouteInterface::setInvocationStrategy

(

InvocationStrategyInterface

$invocationStrategy

)

Set route invocation strategy.

Implemented in Slim\Routing\Route.

setName()

Slim\Interfaces\RouteInterface::setName

(

string

$name

)

Set route name.

Return values

static

Implemented in Slim\Routing\Route.

setPattern()

Slim\Interfaces\RouteInterface::setPattern

(

string

$pattern

)

Set route pattern.

Implemented in Slim\Routing\Route.

---

The documentation for this interface was generated from the following file:

• lib/slim/slim/Slim/Interfaces/RouteInterface.php