API Documentation
\
VivialConnect
Common
Filters
Resources
Transport

\VivialConnect\CommonRequest

Summary

Methods
Properties
Constants
__construct()
getMethod()
setMethod()
getUrl()
setUrl()
getQueries()
setQueries()
getQuery()
setQuery()
getQueryAsString()
getHeaders()
setHeaders()
getHeader()
setHeader()
removeHeader()
getBody()
setBody()
newPsr7Request()
No public properties found
No constants found
No protected methods found
$method
$url
$query
$headers
$body
N/A
No private methods found
No private properties found
N/A

Properties

$method

$method : string

Type

string

$url

$url : string

Type

string

$query

$query : array

Type

array

$headers

$headers : array

Type

array

$body

$body : string

Type

string

Methods

__construct()

__construct(string  $method = null, string  $url = null, array  $query = array(), array  $headers = array(), string  $body = null)

Build a request object

Parameters

string $method

HTTP method (GET, POST, PUT, PATCH, DELETE, HEAD)
string $url

Fully qualified URL (https://some.api.com/v1/posts/456)
array $query

Associative array of query params to add to URL
array $headers

Associative array of headers to add to request
string $body

Request body

getMethod()

getMethod() : string

Get HTTP method for request

Returns

string

setMethod()

setMethod(string  $method)

Set the HTTP method for the request

Parameters

string $method

getUrl()

getUrl() : string

Get the URL for the request

Returns

string

setUrl()

setUrl(string  $url)

Set the URL for the request

Parameters

string $url

getQueries()

getQueries() : array

Get the URL query for the request

Returns

array

setQueries()

setQueries(array  $queries)

Set an array of queries

Parameters

array $queries

getQuery()

getQuery(  $name) : mixed|null

Get a query param from the request

Parameters

$name

Returns

mixed|null

setQuery()

setQuery(  $name,   $value)

Add a query parameter

Parameters

$name
$value

getQueryAsString()

getQueryAsString() : null|string

Return query as HTTP query string (RFC1738)

Returns

null|string

getHeaders()

getHeaders() : array

Get the headers for the request

Returns

array

setHeaders()

setHeaders(array  $headers)

Set an array of headers for the request

Parameters

array $headers

getHeader()

getHeader(  $name) : string|null

Get a header from the request

Parameters

$name

Returns

string|null

setHeader()

setHeader(string  $name, string  $value)

Set a header for the request

Parameters

string $name
string $value

removeHeader()

removeHeader(  $name) : boolean

Remove a header from the request

Parameters

$name

Returns

boolean

getBody()

getBody() : string

Get the request body

Returns

string

setBody()

setBody(string  $body)

Set the request body

Parameters

string $body

newPsr7Request()

newPsr7Request() : \GuzzleHttp\Psr7\Request

Build a PSR-7 Request instance

Returns

\GuzzleHttp\Psr7\Request