Commercetools\Client\ApiRequest Class Reference

Inheritance diagram for Commercetools\Client\ApiRequest:

Public Member Functions
	__construct (?ClientInterface $client, string $method, string $uri, array $headers=[], $body=null, string $version='1.1')
	withQueryParam (string $parameterName, $value)
	send (array $options=[])
	sendAsync (array $options=[])
	getClient ()

Protected Member Functions
	ensureHeader (array $headers, string $header, $defaultValue)
	responseData (ResponseInterface $response)

Detailed Description

@psalm-suppress PropertyNotSetInConstructor

Definition at line 22 of file ApiRequest.php.

Constructor & Destructor Documentation

__construct()

Commercetools\Client\ApiRequest::__construct	(	?ClientInterface	$client,
		string	$method,
		string	$uri,
		array	$headers = [],
			$body = null,
		string	$version = '1.1'
	)

@psalm-param array<string, scalar|scalar[]> $headers

Parameters

string | null | resource | \Psr\Http\Message\StreamInterface

$body

Definition at line 39 of file ApiRequest.php.

Member Function Documentation

ensureHeader()

Commercetools\Client\ApiRequest::ensureHeader ( array  $headers, string  $header,   $defaultValue  )

protected

@psalm-param array<string, scalar|scalar[]> $headers @psalm-param string|string[] $defaultValue @psalm-return array<string, scalar|scalar[]>

Parameters

array	$headers
string	$header
scalar | array	$defaultValue

Returns

array

Definition at line 56 of file ApiRequest.php.

getClient()

Commercetools\Client\ApiRequest::getClient

(

)

Implements Commercetools\Client\ApiRequestInterface.

Definition at line 137 of file ApiRequest.php.

responseData()

Commercetools\Client\ApiRequest::responseData ( ResponseInterface  $response )

finalprotected

@psalm-return stdClass

@psalm-var ?stdClass $data

Definition at line 145 of file ApiRequest.php.

send()

Commercetools\Client\ApiRequest::send

(

array

$options = []

)

Parameters

array

$options

Exceptions

InvalidArgumentException
GuzzleException	@psalm-suppress InvalidThrow

Implements Commercetools\Client\ApiRequestInterface.

Definition at line 115 of file ApiRequest.php.

sendAsync()

Commercetools\Client\ApiRequest::sendAsync

(

array

$options = []

)

Parameters

array

$options

Exceptions

InvalidArgumentException
GuzzleException	@psalm-suppress InvalidThrow

Implements Commercetools\Client\ApiRequestInterface.

Definition at line 129 of file ApiRequest.php.

withQueryParam()

Commercetools\Client\ApiRequest::withQueryParam	(	string	$parameterName,
			$value
	)

Parameters

string	$parameterName	@psalm-param scalar|scalar[] $value
mixed	$value	@psalm-return static

@psalm-var array<string, scalar[]>

@psalm-param scalar|scalar[] $value @psalm-return scalar[]

Implements Commercetools\Client\ApiRequestInterface.

Definition at line 77 of file ApiRequest.php.

---

The documentation for this class was generated from the following file:

• lib/commercetools-base/src/Client/ApiRequest.php