Class PagedQueryResponse

Commercetools\Core\Response\AbstractApiResponse implements Commercetools\Core\Response\ApiResponseInterface, Commercetools\Core\Model\Common\ContextAwareInterface, Commercetools\Core\Response\ApiPromiseGetInterface uses Commercetools\Core\Model\Common\ContextTrait

Extended by

Commercetools\Core\Response\PagedQueryResponse implements IteratorAggregate, ArrayAccess

Direct known subclasses

Commercetools\Core\Response\PagedSearchResponse

Namespace: Commercetools\Core\Response
Located at Core/Response/PagedQueryResponse.php

Methods summary

`public integer`	# `getCount( )` Returns integer
`public integer`	# `getOffset( )` Returns integer
`public integer`	# `getTotal( )` Returns integer
`public array`	# `getResults( )` Returns array
`public Traversable`	# `getIterator( )` (PHP 5 >= 5.0.0) Retrieve an external iterator (PHP 5 >= 5.0.0) Retrieve an external iterator Returns Traversable An instance of an object implementing Iterator or Traversable Link http://php.net/manual/en/iteratoraggregate.getiterator.php Implementation of `IteratorAggregate::getIterator()`
`public boolean`	# `offsetExists( mixed $offset )` (PHP 5 >= 5.0.0) Whether a offset exists (PHP 5 >= 5.0.0) Whether a offset exists Parameters `$offset` An offset to check for. Returns boolean true on success or false on failure. < p> The return value will be casted to boolean if non-boolean was returned. Link http://php.net/manual/en/arrayaccess.offsetexists.php Implementation of `ArrayAccess::offsetExists()`
`public mixed`	# `offsetGet( mixed $offset )` (PHP 5 >= 5.0.0) Offset to retrieve (PHP 5 >= 5.0.0) Offset to retrieve Parameters `$offset` The offset to retrieve. Returns mixed Can return all value types. Link http://php.net/manual/en/arrayaccess.offsetget.php Implementation of `ArrayAccess::offsetGet()`
`public`	# `offsetSet( mixed $offset, mixed $value )` (PHP 5 >= 5.0.0) Offset to set (PHP 5 >= 5.0.0) Offset to set Parameters `$offset` The offset to assign the value to. `$value` The value to set. Link http://php.net/manual/en/arrayaccess.offsetset.php Implementation of `ArrayAccess::offsetSet()`
`public`	# `offsetUnset( mixed $offset )` (PHP 5 >= 5.0.0) Offset to unset (PHP 5 >= 5.0.0) Offset to unset Parameters `$offset` The offset to unset. Link http://php.net/manual/en/arrayaccess.offsetunset.php Implementation of `ArrayAccess::offsetUnset()`

Methods inherited from Commercetools\Core\Response\AbstractApiResponse

__construct(), getBody(), getCorrelationId(), getErrors(), getHeader(), getHeaders(), getPromise(), getRequest(), getResponse(), getStatusCode(), isError(), then(), toArray(), toObject(), wait()

Methods inherited from Commercetools\Core\Model\Common\ContextAwareInterface

getContext(), getContextCallback(), setContext(), setContextIfNull()

Methods used from Commercetools\Core\Model\Common\ContextTrait

getContext(), getContextCallback(), setContext(), setContextIfNull()

Constants summary

`string`	`COUNT`	# `'count'`
`string`	`OFFSET`	# `'offset'`
`string`	`TOTAL`	# `'total'`
`string`	`RESULTS`	# `'results'`

Constants inherited from Commercetools\Core\Response\AbstractApiResponse

X_CORRELATION_ID