Index Documentation

HttpRouter
in package
implements IRouter Uses RouterTrait

Table of Contents

Interfaces

IRouter

Methods

__construct()  : mixed
add()  : void
Adds a new route.
delete()  : void
dispatch()  : void
get()  : void
getCharSet()  : string
getErrorHandler()  : IErrorHandler
options()  : void
output()  : void
patch()  : void
post()  : void
put()  : void
register()  : void
registerContentHandler()  : void
registerDefaultContentHandlers()  : void
resolve()  : ResolvedRouteInfo
Resolves a route
scopeTo()  : IRouter
Creates a scoped version of this router.
setErrorHandler()  : void
setHTMLErrorHandler()  : void
setPlainErrorHandler()  : void
use()  : void
Apply middleware functions to a path.
writeErrorPage()  : void

Methods

__construct()

public __construct([string $charSet = '' ][, IErrorHandler|string $errorHandler = 'html' ][, bool $registerDefaultContentHandlers = true ]) : mixed
Parameters
$charSet : string = ''
$errorHandler : IErrorHandler|string = 'html'
$registerDefaultContentHandlers : bool = true

add()

Adds a new route.

public add(string $method, string $path, callable $handler) : void
Parameters
$method : string

Request method.

$path : string

Request path.

$handler : callable

Request handler.

delete()

public delete(string $path, callable $handler) : void
Parameters
$path : string
$handler : callable

dispatch()

public dispatch([HttpRequest|null $request = null ][, array<string|int, mixed> $args = [] ]) : void
Parameters
$request : HttpRequest|null = null
$args : array<string|int, mixed> = []

get()

public get(string $path, callable $handler) : void
Parameters
$path : string
$handler : callable

getCharSet()

public getCharSet() : string
Return values
string

options()

public options(string $path, callable $handler) : void
Parameters
$path : string
$handler : callable

patch()

public patch(string $path, callable $handler) : void
Parameters
$path : string
$handler : callable

post()

public post(string $path, callable $handler) : void
Parameters
$path : string
$handler : callable

put()

public put(string $path, callable $handler) : void
Parameters
$path : string
$handler : callable

registerDefaultContentHandlers()

public registerDefaultContentHandlers() : void

resolve()

Resolves a route

public resolve(string $method, string $path) : ResolvedRouteInfo
Parameters
$method : string

Request method.

$path : string

Request path.

Return values
ResolvedRouteInfo —

Response route.

scopeTo()

Creates a scoped version of this router.

public scopeTo(string $prefix) : IRouter
Parameters
$prefix : string

Prefix path to prepend to all registered routes.

Return values
IRouter —

Scoped router.

setHTMLErrorHandler()

public setHTMLErrorHandler() : void

setPlainErrorHandler()

public setPlainErrorHandler() : void

use()

Apply middleware functions to a path.

public use(string $path, callable $handler) : void
Parameters
$path : string

Path to apply the middleware to.

$handler : callable

Middleware function.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results