class RequestOptions (View source)

Traits

Methods

getDate(string $period)

Get QueryDate object from period name.

string
validateFormat(string $format)

Check format against allowed values.

setMethod(string $method)

No description

usePeriod(bool $period)

No description

setSiteId(int|string|null $siteId)

No description

useSiteId(bool $siteId)

No description

setFormat(string|null $format)

No description

useFormat(bool $format)

No description

string|null
getFormat(ConfigRepository $config)

No description

useTokenAuth(bool $tokenAuth)

No description

setArguments($arguments)

No description

array
flattenArray(array $array)

No description

string
build(ConfigRepository $config)

No description

Details

QueryDate getDate(string $period)

Get QueryDate object from period name.

e.g. "yesterday" => QueryDate(period = "day", date = "yesterday")

Parameters

string $period

Return Value

QueryDate

string validateFormat(string $format)

Check format against allowed values.

Parameters

string $format

format to validate

Return Value

string

the format if it has passed validation

Exceptions

PiwikException

RequestOptions setMethod(string $method)

No description

Parameters

string $method

Return Value

RequestOptions

RequestOptions usePeriod(bool $period)

No description

Parameters

bool $period

Return Value

RequestOptions

RequestOptions setSiteId(int|string|null $siteId)

No description

Parameters

int|string|null $siteId

Return Value

RequestOptions

RequestOptions useSiteId(bool $siteId)

No description

Parameters

bool $siteId

Return Value

RequestOptions

RequestOptions setFormat(string|null $format)

No description

Parameters

string|null $format

Return Value

RequestOptions

RequestOptions useFormat(bool $format)

No description

Parameters

bool $format

Return Value

RequestOptions

string|null getFormat(ConfigRepository $config)

No description

Parameters

ConfigRepository $config

Return Value

string|null

RequestOptions useTokenAuth(bool $tokenAuth)

No description

Parameters

bool $tokenAuth

Return Value

RequestOptions

RequestOptions setArguments($arguments)

No description

Parameters

$arguments

Return Value

RequestOptions

array flattenArray(array $array)

No description

Parameters

array $array

Return Value

array

string build(ConfigRepository $config)

No description

Parameters

ConfigRepository $config

Return Value

string