Documentation

RouterResult
in package

The router result object is returned when a route matches (or not) a request.

Table of Contents

$handler  : RequestHandlerInterface|null
__construct()  : mixed
getHandler()  : RequestHandlerInterface
Returns a requesthandler that the router suggested for handlign the request.
success()  : bool
Allows the result object to report whether the router was able to find a route that matches the request that it received.

Properties

Methods

__construct()

public __construct([RequestHandlerInterface $handler = null ]) : mixed
Parameters
$handler : RequestHandlerInterface = null
Return values
mixed —

getHandler()

Returns a requesthandler that the router suggested for handlign the request.

public getHandler() : RequestHandlerInterface

If the router did not match anything, this method will throw an exception to report that the requesthandler cannot be used.

Tags
throws
ApplicationException
Return values
RequestHandlerInterface —

success()

Allows the result object to report whether the router was able to find a route that matches the request that it received.

public success() : bool
Return values
bool —

Search results