RobBrazier\Piwik\Module\APIModule

class APIModule extends Module (View source)

Class APIModule.

Properties

protected RequestRepository

$request

from Module

Methods

__construct(RequestRepository $request)

Module constructor.

from Module

RequestOptions

getOptions(string $format)

No description

from Module

mixed

getPiwikVersion(string $format = null)

No description

mixed

getIpFromHeader(string $format = null)

No description

mixed

getSettings(string $format = null)

No description

mixed

getSegmentsMetadata(string[] $siteIds, string $format = null)

No description

mixed

getMetadata($arguments = [], string $format = null)

No description

mixed

getReportMetadata(string[] $siteIds, $arguments = [], string $format = null)

No description

mixed

getProcessedReport(string $apiModule, string $apiAction, $arguments = [], string $format = null)

No description

mixed

getReportPagesMetadata(string $format = null)

No description

mixed

getWidgetMetadata(string $format = null)

No description

mixed

get($arguments = [], string $format = null)

No description

mixed

getRowEvolution(string $apiModule, string $apiAction, $arguments = [], string $format = null)

No description

Details

in Module at line 20
`__construct(RequestRepository $request)`

Module constructor.

Parameters

RequestRepository

$request

in Module at line 30
`protected RequestOptions getOptions(string $format)`

No description

Parameters

string

$format

response format

Return Value

RequestOptions

at line 18
`mixed getPiwikVersion(string $format = null)`

No description

Parameters

string

$format

override format (defaults to one specified in config file)

Return Value

mixed

at line 32
`mixed getIpFromHeader(string $format = null)`

No description

Parameters

string

$format

override format (defaults to one specified in config file)* @param string $format

Return Value

mixed

at line 46
`mixed getSettings(string $format = null)`

No description

Parameters

string

$format

override format (defaults to one specified in config file)

Return Value

mixed

at line 61
`mixed getSegmentsMetadata(string[] $siteIds, string $format = null)`

No description

Parameters

string[]	$siteIds	list of site ids to get segment metadata for
string	$format	override format (defaults to one specified in config file)

Return Value

mixed

at line 81
`mixed getMetadata($arguments = [], string $format = null)`

No description

Parameters

	$arguments
string	$format	override format (defaults to one specified in config file)

Return Value

mixed

at line 95
`mixed getReportMetadata(string[] $siteIds, $arguments = [], string $format = null)`

No description

Parameters

string[]	$siteIds	list of site ids to get report metadata for
	$arguments
string	$format	override format (defaults to one specified in config file)

Return Value

mixed

at line 115
`mixed getProcessedReport(string $apiModule, string $apiAction, $arguments = [], string $format = null)`

No description

Parameters

string	$apiModule	api module to get report for
string	$apiAction	api action/method to get report for
	$arguments
string	$format	override format (defaults to one specified in config file)

Return Value

mixed

at line 129
`mixed getReportPagesMetadata(string $format = null)`

No description

Parameters

string

$format

override format (defaults to one specified in config file)

Return Value

mixed

at line 142
`mixed getWidgetMetadata(string $format = null)`

No description

Parameters

string

$format

override format (defaults to one specified in config file)

Return Value

mixed

at line 156
`mixed get($arguments = [], string $format = null)`

No description

Parameters

	$arguments
string	$format	override format (defaults to one specified in config file)

Return Value

mixed

at line 171
`mixed getRowEvolution(string $apiModule, string $apiAction, $arguments = [], string $format = null)`

No description

Parameters

string	$apiModule	api module to get report for
string	$apiAction	api action/method to get report for
	$arguments
string	$format	override format (defaults to one specified in config file)

Return Value

mixed

APIModule

Properties

Methods

Details

in Module at line 20 __construct(RequestRepository $request)

Parameters

in Module at line 30 protected RequestOptions getOptions(string $format)

Parameters

Return Value

at line 18 mixed getPiwikVersion(string $format = null)

Parameters

Return Value

at line 32 mixed getIpFromHeader(string $format = null)

Parameters

Return Value

at line 46 mixed getSettings(string $format = null)

Parameters

Return Value

at line 61 mixed getSegmentsMetadata(string[] $siteIds, string $format = null)

Parameters

Return Value

at line 81 mixed getMetadata($arguments = [], string $format = null)

Parameters

Return Value

at line 95 mixed getReportMetadata(string[] $siteIds, $arguments = [], string $format = null)

Parameters

Return Value

at line 115 mixed getProcessedReport(string $apiModule, string $apiAction, $arguments = [], string $format = null)

Parameters

Return Value

at line 129 mixed getReportPagesMetadata(string $format = null)

Parameters

Return Value

at line 142 mixed getWidgetMetadata(string $format = null)

Parameters

Return Value

at line 156 mixed get($arguments = [], string $format = null)

Parameters

Return Value

at line 171 mixed getRowEvolution(string $apiModule, string $apiAction, $arguments = [], string $format = null)

Parameters

Return Value

in Module at line 20
`__construct(RequestRepository $request)`

in Module at line 30
`protected RequestOptions getOptions(string $format)`

at line 18
`mixed getPiwikVersion(string $format = null)`

at line 32
`mixed getIpFromHeader(string $format = null)`

at line 46
`mixed getSettings(string $format = null)`

at line 61
`mixed getSegmentsMetadata(string[] $siteIds, string $format = null)`

at line 81
`mixed getMetadata($arguments = [], string $format = null)`

at line 95
`mixed getReportMetadata(string[] $siteIds, $arguments = [], string $format = null)`

at line 115
`mixed getProcessedReport(string $apiModule, string $apiAction, $arguments = [], string $format = null)`

at line 129
`mixed getReportPagesMetadata(string $format = null)`

at line 142
`mixed getWidgetMetadata(string $format = null)`

at line 156
`mixed get($arguments = [], string $format = null)`

at line 171
`mixed getRowEvolution(string $apiModule, string $apiAction, $arguments = [], string $format = null)`