Interface RouteInterface

Route Interface

Direct known implementers

Namespace: Slim\Interfaces
Package: Slim
Since: 3.0.0
Located at Interfaces/RouteInterface.php

Methods summary

`public string\|null`	# `getArgument( string $name, string\|null $default = null )` Retrieve a specific route argument Retrieve a specific route argument Parameters `$name` `$default` Returns string\|null
`public string[]`	# `getArguments( )` Get route arguments Get route arguments Returns string[]
`public null\|string`	# `getName( )` Get route name Get route name Returns null\|string
`public string`	# `getPattern( )` Get route pattern Get route pattern Returns string
`public Slim\Interfaces\RouteInterface`	# `setArgument( string $name, string $value )` Set a route argument Set a route argument Parameters `$name` `$value` Returns `Slim\Interfaces\RouteInterface`
`public Slim\Interfaces\RouteInterface`	# `setArguments( array $arguments )` Replace route arguments Replace route arguments Parameters `$arguments` Returns `Slim\Interfaces\RouteInterface`
`public`	# `setOutputBuffering( boolean\|string $mode )` Set output buffering mode Set output buffering mode One of: false, 'prepend' or 'append' Parameters `$mode` Throws InvalidArgumentException If an unknown buffering mode is specified
`public static`	# `setName( string $name )` Set route name Set route name Parameters `$name` Returns static Throws InvalidArgumentException if the route name is not a string
`public Slim\Interfaces\RouteInterface`	# `add( callable\|string $callable )` Add middleware Add middleware This method prepends new middleware to the route's middleware stack. Parameters `$callable` The callback routine Returns `Slim\Interfaces\RouteInterface`
`public`	# `prepare( Psr\Http\Message\ServerRequestInterface $request, array $arguments )` Prepare the route for use Prepare the route for use Parameters `$request` `$arguments`
`public Psr\Http\Message\ResponseInterface`	# `run( Psr\Http\Message\ServerRequestInterface $request, Psr\Http\Message\ResponseInterface $response )` Run route 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. Parameters `$request` `$response` Returns Psr\Http\Message\ResponseInterface
`public Psr\Http\Message\ResponseInterface`	# `__invoke( Psr\Http\Message\ServerRequestInterface $request, Psr\Http\Message\ResponseInterface $response )` Dispatch route callable against current Request and Response objects Dispatch route callable against current Request and Response objects This method invokes the route object's callable. If middleware is registered for the route, each callable middleware is invoked in the order specified. Parameters `$request` The current Request object `$response` The current Response object Returns Psr\Http\Message\ResponseInterface