API Documentation
Back to top  

RequestParameters

Container for request parameters

package

Default

Methods

__construct

__construct()

Return request body

body() : \io\vertx\jphp\ext\web\api\RequestParameter

Response

\io\vertx\jphp\ext\web\api\RequestParameter

Get cookie parameter by name

cookieParameter( $arg0) : \io\vertx\jphp\ext\web\api\RequestParameter

Arguments

$arg0

string

Response

\io\vertx\jphp\ext\web\api\RequestParameter

Get list of all parameter names inside cookie

cookieParametersNames() : array

Response

array

Get form parameter by name

formParameter( $arg0) : \io\vertx\jphp\ext\web\api\RequestParameter

Arguments

$arg0

string

Response

\io\vertx\jphp\ext\web\api\RequestParameter

Get list of all parameter names inside body form

formParametersNames() : array

Response

array

Get header parameter by name

headerParameter( $arg0) : \io\vertx\jphp\ext\web\api\RequestParameter

Arguments

$arg0

string

Response

\io\vertx\jphp\ext\web\api\RequestParameter

Get list of all parameter names inside header

headerParametersNames() : array

Response

array

Get path parameter by name

pathParameter( $arg0) : \io\vertx\jphp\ext\web\api\RequestParameter

Arguments

$arg0

string

Response

\io\vertx\jphp\ext\web\api\RequestParameter

Get list of all parameter names inside path

pathParametersNames() : array

Response

array

Get query parameter by name

queryParameter( $arg0) : \io\vertx\jphp\ext\web\api\RequestParameter

Arguments

$arg0

string

Response

\io\vertx\jphp\ext\web\api\RequestParameter

Get list of all parameter names inside query

queryParametersNames() : array

Response

array

This method converts RequestParameters in an unique JsonObject with 6 fields: cookie, path, query, header, form, body<br/>

toJson() : array

cookie, path, query, header, form are JsonObject where keys are param names and values are param values, while body depends on body's shape and may not exist

Response

array