API Documentation
Back to top  

Route

A route is a holder for a set of criteria which determine whether an HTTP request or failure should be routed to a handler.

package

Default

Methods

__construct

__construct()

Like @see \io\vertx\jphp\ext\web\Route::blockingHandler called with ordered = true

blockingHandler( $arg0,  $arg1 = null) : $this

param $requestHandler [callable] blockingHandler($requestHandler)

Specify a blocking request handler for the route. This method works just like @see \io\vertx\jphp\ext\web\Route::handler excepted that it will run the blocking handler on a worker thread so that it won't block the event loop. Note that it's safe to call context.next() from the blocking handler as it will be executed on the event loop context (and not on the worker thread.

If the blocking handler is ordered it means that any blocking handlers for the same context are never executed concurrently but always in the order they were called. The default value of ordered is true. If you do not want this behaviour and don't mind if your blocking handlers are executed in parallel you can set ordered to false.

param $requestHandler [callable] the blocking request handler param $ordered [boolean] if true handlers are executed in sequence, otherwise are run in parallel blockingHandler($requestHandler, $ordered)

Arguments

$arg0

callable

$arg1

boolean

Response

$this

Add a content type consumed by this route. Used for content based routing.

consumes( $arg0) : $this

Arguments

$arg0

string

Response

$this

a reference to this, so the API can be used fluently

Disable this route. While disabled the router will not route any requests or failures to it.

disable() : $this

Response

$this

a reference to this, so the API can be used fluently

Enable this route.

enable() : $this

Response

$this

a reference to this, so the API can be used fluently

Append a failure handler to the route failure handlers list. The router routes failures to failurehandlers depending on whether the various criteria such as method, path, etc match. When method, path, etc are the same for different routes, You should add multiple failure handlers to the same route object rather than creating two different routes objects with one failure handler for route

failureHandler( $arg0) : $this

Arguments

$arg0

callable

Response

$this

a reference to this, so the API can be used fluently

getPath

getPath() : string

Response

string

the path prefix (if any) for this route

Append a request handler to the route handlers list. The router routes requests to handlers depending on whether the various criteria such as method, path, etc match. When method, path, etc are the same for different routes, You should add multiple handlers to the same route object rather than creating two different routes objects with one handler for route

handler( $arg0) : $this

Arguments

$arg0

callable

Response

$this

a reference to this, so the API can be used fluently

Specify this is the last route for the router.

last() : $this

Response

$this

a reference to this, so the API can be used fluently

Add an HTTP method for this route. By default a route will match all HTTP methods. If any are specified then the route will only match any of the specified methods

method( $arg0) : $this

Arguments

$arg0

string

Response

$this

a reference to this, so the API can be used fluently

Specify the order for this route. The router tests routes in that order.

order( $arg0) : $this

Arguments

$arg0

integer

Response

$this

a reference to this, so the API can be used fluently

Set the path prefix for this route. If set then this route will only match request URI paths which start with this path prefix. Only a single path or path regex can be set for a route.

path( $arg0) : $this

Arguments

$arg0

string

Response

$this

a reference to this, so the API can be used fluently

Set the path prefix as a regular expression. If set then this route will only match request URI paths, the beginning of which match the regex. Only a single path or path regex can be set for a route.

pathRegex( $arg0) : $this

Arguments

$arg0

string

Response

$this

a reference to this, so the API can be used fluently

Add a content type produced by this route. Used for content based routing.

produces( $arg0) : $this

Arguments

$arg0

string

Response

$this

a reference to this, so the API can be used fluently

Remove this route from the router

remove() : $this

Response

$this

a reference to this, so the API can be used fluently

When you add a new route with a regular expression, you can add named capture groups for parameters. <br/> However, if you need more complex parameters names (like "param_name"), you can add parameters names with this function. You have to name capture groups in regex with names: "p0", "p1", "p2", .

setRegexGroupsNames( $arg0) : $this

..

For example: If you declare route with regex \/(?[a-z])\/(?[a-z]) and group names ["param_a", "param-b"] for uri /hello/world you receive inside pathParams() the parameter param_a = "hello"

Arguments

$arg0

array

Response

$this

a reference to this, so the API can be used fluently

If true then the normalised request path will be used when routing (e.g. removing duplicate /) Default is true

useNormalisedPath( $arg0) : $this

Arguments

$arg0

boolean

Response

$this

a reference to this, so the API can be used fluently