$storeCode
$storeCode : null|string
This class is a utility to create custom requests.
getFunction() : string
Returns the API function name to be executed.
Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293getScope() : string
Get the scope of the request. Returns a RequestInterface::REQUEST_SCOPE_* constant.
Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293getStoreCode() : mixed
Get the request level store code, if set.
Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293setStoreCode( $storeCode) : \MerchantAPI\ResponseInterface
Override client level store code from the request. Only applies to store scoped requests.
| $storeCode |
toArray() : array
Returns the data for the request as an array.
Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293__construct( $function, array $data = array()) : \MerchantAPI\Request\RequestBuilder
Constructor.
| $function | ||
| array | $data |
setFunction( $function) : \MerchantAPI\Request\RequestBuilder
Set the API function name.
| $function |
set( $field, $value) : \MerchantAPI\Request\RequestBuilder
Set a field int the request.
| $field | ||
| $value |
get( $field, $defaultValue = null) : mixed
Get a defined field from the request, or provided default.
| $field | ||
| $defaultValue |
has( $field) : boolean
Check if a field is defined in the request.
| $field |
remove( $field) : \MerchantAPI\Request\RequestBuilder
Remove a defined field from the request.
| $field |
offsetSet( $offset, $value)
| $offset | ||
| $value |
offsetExists( $offset)
| $offset |
offsetUnset( $offset)
| $offset |
offsetGet( $offset)
| $offset |
setScope( $scope) : \MerchantAPI\Request\RequestBuilder
Set the scope of the request.
| $scope |
createResponse(\MerchantAPI\Http\HttpResponse $httpResponse, array $data)
| \MerchantAPI\Http\HttpResponse | $httpResponse | |
| array | $data |