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(string $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

string
build(ConfigRepository $config)

No description

Details

in DateTrait at line 18
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 19
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 66
RequestOptions setMethod(string $method)

No description

Parameters

string $method

Return Value

RequestOptions

at line 75
RequestOptions usePeriod(bool $period)

No description

Parameters

bool $period

Return Value

RequestOptions

at line 84
RequestOptions setSiteId(string $siteId)

No description

Parameters

string $siteId

Return Value

RequestOptions

at line 94
RequestOptions useSiteId(bool $siteId)

No description

Parameters

bool $siteId

Return Value

RequestOptions

at line 115
RequestOptions setFormat(string $format)

No description

Parameters

string $format

Return Value

RequestOptions

at line 127
RequestOptions useFormat(bool $format)

No description

Parameters

bool $format

Return Value

RequestOptions

at line 136
string getFormat(ConfigRepository $config)

No description

Parameters

ConfigRepository $config

Return Value

string

at line 148
RequestOptions useTokenAuth(bool $tokenAuth)

No description

Parameters

bool $tokenAuth

Return Value

RequestOptions

at line 169
RequestOptions setArguments($arguments)

No description

Parameters

$arguments

Return Value

RequestOptions

at line 181
string build(ConfigRepository $config)

No description

Parameters

ConfigRepository $config

Return Value

string