class Query

A sync Query can be used to limit what type of resources and events should be synced

Methods

__construct()

Query constructor.

array
getQueryData()

Returns the parameters to execute this query.

string
getQueryString()

The urlencoded query string for this query.

string
getType()

Set the Type of event or resource to sync.

$this
setType(string|null $type)

Set the Type of event or resource to sync.

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

Details

at line 38
__construct()

Query constructor.

Empty for now, included for forward compatibility.

at line 49
array getQueryData()

Returns the parameters to execute this query.

Return Value

array

at line 67
string getQueryString()

The urlencoded query string for this query.

Return Value

string

at line 79
string getType()

Set the Type of event or resource to sync.

May be null if everything is synced.

Return Value

string

at line 105
$this setType(string|null $type)

Set the Type of event or resource to sync.

Set to null to sync everything.

Valid values for $type are: - all - Asset - Entry - Deletion - DeletedAsset - DeletedEntry

Parameters

string|null $type

Return Value

$this

Exceptions

InvalidArgumentException When an invalid $type is set.

at line 124
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 138
$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.

Parameters

ContentType|string|null $contentType

Return Value

$this