1. class
  2. Contentful
  3. \
  4. Core
  5. \
  6. Api
  7. \
  8. BaseQuery

BaseQuery

class BaseQuery

BaseQuery class.

A BaseQuery 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.

$this
setLimit(int|null $limit)

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

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

Set the order of the items retrieved by this query.

$this
setContentType(string|null $contentType)

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

$this
setMimeTypeGroup(string|null $group)

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.

$this
linksToEntry(string $entryId)

Filters for all entries that link to an entry.

$this
linksToAsset(string $assetId)

Filters for all entries that link to an asset.

Details

at line 92
__construct()

Query constructor.

at line 101
array getQueryData()

Returns the parameters to execute this query.

Return Value

array

at line 120
string getQueryString()

The urlencoded query string for this query.

Return Value

string

at line 134
$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 157
$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 182
$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 202
$this setContentType(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

string|null $contentType

Return Value

$this

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

Parameters

string|null $group

Return Value

$this

Exceptions

InvalidArgumentException if $group is not a valid value

at line 271
$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 324
$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

at line 346
$this linksToEntry(string $entryId)

Filters for all entries that link to an entry.

Parameters

string $entryId

Return Value

$this

at line 360
$this linksToAsset(string $assetId)

Filters for all entries that link to an asset.

Parameters

string $assetId

Return Value

$this