1. class
  2. Contentful
  3. \
  4. Query

Query

class Query

A Query is used to filter and order collections when making API requests.

Constants

DATE_FORMAT

ISO8601 but with the seconds forced to 0.

Methods

__construct()

Query constructor.

array
getQueryData()

Returns the parameters to execute this query.

string
getQueryString()

The urlencoded query string for this query.

$this
setSkip(int|null $skip)

Sets the index of the first result to retrieve. To reset set to NULL.

int|null
getSkip()

Returns the index of the first result to retrieve. Can return NULL if no index is specified.

$this
setLimit(int|null $limit)

Set the maximum number of results to retrieve. To reset set to NULL;

int|null
getLimit()

Returns the maximum number of results to retrieve. Can return NULL if no maximum is defined.

$this
orderBy(string|null $field, bool $reverse = false)

Set the order of the items retrieved by this query.

$this
setContentType(ContentType|string|null $contentType)

Set the content type to which results should be limited. Set to NULL to not filter for a content type.

string|null
getContentType()

Returns the name of the content type for which results will be retrieved. Can be NULL if no content type is set

$this
setMimeTypeGroup(string|null $group)

No description

null|string
getMimeTypeGroup()

No description

$this
where(string $field, string|array|DateTimeInterface|Location $value, string|null $operator = null)

Add a filter condition to this query.

$this
select(array $select)

The select operator allows you to choose what to return from an entity.

Details

at line 79
__construct()

Query constructor.

Empty for now, included for forward compatibility.

at line 90
array getQueryData()

Returns the parameters to execute this query.

Return Value

array

at line 138
string getQueryString()

The urlencoded query string for this query.

Return Value

string

at line 154
$this setSkip(int|null $skip)

Sets the index of the first result to retrieve. To reset set to NULL.

Parameters

int|null $skip The index of the first result that will be retrieved. Must be >= 0.

Return Value

$this

Exceptions

RangeException If $skip is not within the specified range

at line 172
int|null getSkip()

Returns the index of the first result to retrieve. Can return NULL if no index is specified.

Return Value

int|null

at line 188
$this setLimit(int|null $limit)

Set the maximum number of results to retrieve. To reset set to NULL;

Parameters

int|null $limit The maximum number of results to retrieve, must be between 1 and 1000 or null

Return Value

$this

Exceptions

RangeException If $maxArguments is not withing the specified range

at line 206
int|null getLimit()

Returns the maximum number of results to retrieve. Can return NULL if no maximum is defined.

Return Value

int|null

at line 224
$this orderBy(string|null $field, bool $reverse = false)

Set the order of the items retrieved by this query.

Note that when ordering Entries by fields you must set the content_type URI query parameter to the ID of the Content Type you want to filter by. Can be called multiple times to order by multiple values.

Parameters

string|null $field
bool $reverse

Return Value

$this

at line 245
$this setContentType(ContentType|string|null $contentType)

Set the content type to which results should be limited. Set to NULL to not filter for a content type.

Only works when querying entries.

Parameters

ContentType|string|null $contentType

Return Value

$this

at line 263
string|null getContentType()

Returns the name of the content type for which results will be retrieved. Can be NULL if no content type is set

Return Value

string|null The name of the content type results will be limited to

at line 277
$this setMimeTypeGroup(string|null $group)

Parameters

string|null $group

Return Value

$this

Exceptions

InvalidArgumentException if $group is not a valid value

at line 305
null|string getMimeTypeGroup()

Return Value

null|string

at line 337
$this where(string $field, string|array|DateTimeInterface|Location $value, string|null $operator = null)

Add a filter condition to this query.

Valid operators are - ne - all - in - nin - exists - lt - lte - gt - gte - match - near - within

Parameters

string $field
string|array|DateTimeInterface|Location $value
string|null $operator The operator to use for this condition. Default is strict equality.

Return Value

$this

Exceptions

InvalidArgumentException If $operator is not one of the valid values

at line 388
$this select(array $select)

The select operator allows you to choose what to return from an entity.

You provide one or multiple JSON paths and the API will return the properties at those paths.

To only request the metadata simply query for 'sys'.

Parameters

array $select

Return Value

$this