1. class
  2. RobBrazier
  3. \
  4. Piwik
  5. \
  6. Request
  7. \
  8. RequestOptions

RequestOptions

class RequestOptions (View source)

Traits

DateTrait
FormatTrait

Methods

QueryDate
getDate(string $period)

Get QueryDate object from period name.

from  DateTrait
string
validateFormat(string $format)

Check format against allowed values.

from  FormatTrait
RequestOptions
setMethod(string $method)

No description

RequestOptions
usePeriod(bool $period)

No description

RequestOptions
setSiteId(int $siteId)

No description

RequestOptions
useSiteId(bool $siteId)

No description

RequestOptions
setFormat(string $format)

No description

RequestOptions
useFormat(bool $format)

No description

string
getFormat(ConfigRepository $config)

No description

RequestOptions
useTokenAuth(bool $tokenAuth)

No description

RequestOptions
setArguments($arguments)

No description

array
flattenArray(array $array)

No description

string
build(ConfigRepository $config)

No description

Details

in DateTrait at line 19
QueryDate getDate(string $period)

Get QueryDate object from period name.

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

Parameters

string $period

Return Value

QueryDate

in FormatTrait at line 20
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

at line 67
RequestOptions setMethod(string $method)

No description

Parameters

string $method

Return Value

RequestOptions

at line 79
RequestOptions usePeriod(bool $period)

No description

Parameters

bool $period

Return Value

RequestOptions

at line 91
RequestOptions setSiteId(int $siteId)

No description

Parameters

int $siteId

Return Value

RequestOptions

at line 104
RequestOptions useSiteId(bool $siteId)

No description

Parameters

bool $siteId

Return Value

RequestOptions

at line 131
RequestOptions setFormat(string $format)

No description

Parameters

string $format

Return Value

RequestOptions

at line 146
RequestOptions useFormat(bool $format)

No description

Parameters

bool $format

Return Value

RequestOptions

at line 158
string getFormat(ConfigRepository $config)

No description

Parameters

ConfigRepository $config

Return Value

string

at line 173
RequestOptions useTokenAuth(bool $tokenAuth)

No description

Parameters

bool $tokenAuth

Return Value

RequestOptions

at line 200
RequestOptions setArguments($arguments)

No description

Parameters

$arguments

Return Value

RequestOptions

at line 215
array flattenArray(array $array)

No description

Parameters

array $array

Return Value

array

at line 248
string build(ConfigRepository $config)

No description

Parameters

ConfigRepository $config

Return Value

string