RobBrazier\Piwik\Module\SitesManagerModule

class SitesManagerModule extends Module (View source)

Class SitesManagerModule.

Properties

protected RequestRepository

$request

from Module

Methods

__construct(RequestRepository $request)

Module constructor.

from Module

RequestOptions

getOptions(string $format)

No description

from Module

mixed

getSitesFromGroup(string $group, string $format = null)

No description

mixed

getSiteGroups(string $format = null)

No description

mixed

getSitesFromId(string $format = null)

No description

mixed

getSiteUrlsFromId(int $siteId = null, string $format = null)

No description

mixed

getAllSites(string $format = null)

No description

mixed

getAllSitesId(string $format = null)

No description

mixed

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

No description

mixed

getSitesWithViewAccess(string $format = null)

No description

mixed

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

No description

mixed

getSitesIdWithAdminAccess(string $format = null)

No description

mixed

getSitesIdWithViewAccess(string $format = null)

No description

mixed

getSitesIdWithAtLeastViewAccess(string $format = null)

No description

mixed

getSitesIdFromSiteUrl(string $url, string $format = null)

No description

mixed

addSite(string $siteName, $urls = [], $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 getSitesFromGroup(string $group, string $format = null)`

No description

Parameters

string	$group	group to search for
string	$format	override format (defaults to one specified in config file)

Return Value

mixed

at line 36
`mixed getSiteGroups(string $format = null)`

No description

Parameters

string

$format

override format (defaults to one specified in config file)

Return Value

mixed

at line 50
`mixed getSitesFromId(string $format = null)`

No description

Parameters

string

$format

override format (defaults to one specified in config file)

Return Value

mixed

at line 64
`mixed getSiteUrlsFromId(int $siteId = null, string $format = null)`

No description

Parameters

int	$siteId	Override for ID, so you can specify one rather than fetching it from config
string	$format	override format (defaults to one specified in config file)

Return Value

mixed

at line 80
`mixed getAllSites(string $format = null)`

No description

Parameters

string

$format

override format (defaults to one specified in config file)

Return Value

mixed

at line 94
`mixed getAllSitesId(string $format = null)`

No description

Parameters

string

$format

override format (defaults to one specified in config file)

Return Value

mixed

at line 109
`mixed getSitesWithAdminAccess($arguments = [], string $format = null)`

No description

Parameters

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

Return Value

mixed

at line 124
`mixed getSitesWithViewAccess(string $format = null)`

No description

Parameters

string

$format

override format (defaults to one specified in config file)

Return Value

mixed

at line 139
`mixed getSitesWithAtLeastViewAccess($arguments = [], string $format = null)`

No description

Parameters

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

Return Value

mixed

at line 154
`mixed getSitesIdWithAdminAccess(string $format = null)`

No description

Parameters

string

$format

override format (defaults to one specified in config file)

Return Value

mixed

at line 168
`mixed getSitesIdWithViewAccess(string $format = null)`

No description

Parameters

string

$format

override format (defaults to one specified in config file)

Return Value

mixed

at line 182
`mixed getSitesIdWithAtLeastViewAccess(string $format = null)`

No description

Parameters

string

$format

override format (defaults to one specified in config file)

Return Value

mixed

at line 197
`mixed getSitesIdFromSiteUrl(string $url, string $format = null)`

No description

Parameters

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

Return Value

mixed

at line 218
`mixed addSite(string $siteName, $urls = [], $arguments = [], string $format = null)`

No description

Parameters

string	$siteName	name of the site to be created
	$urls
	$arguments
string	$format	override format (defaults to one specified in config file)

Return Value

mixed

SitesManagerModule

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 getSitesFromGroup(string $group, string $format = null)

Parameters

Return Value

at line 36 mixed getSiteGroups(string $format = null)

Parameters

Return Value

at line 50 mixed getSitesFromId(string $format = null)

Parameters

Return Value

at line 64 mixed getSiteUrlsFromId(int $siteId = null, string $format = null)

Parameters

Return Value

at line 80 mixed getAllSites(string $format = null)

Parameters

Return Value

at line 94 mixed getAllSitesId(string $format = null)

Parameters

Return Value

at line 109 mixed getSitesWithAdminAccess($arguments = [], string $format = null)

Parameters

Return Value

at line 124 mixed getSitesWithViewAccess(string $format = null)

Parameters

Return Value

at line 139 mixed getSitesWithAtLeastViewAccess($arguments = [], string $format = null)

Parameters

Return Value

at line 154 mixed getSitesIdWithAdminAccess(string $format = null)

Parameters

Return Value

at line 168 mixed getSitesIdWithViewAccess(string $format = null)

Parameters

Return Value

at line 182 mixed getSitesIdWithAtLeastViewAccess(string $format = null)

Parameters

Return Value

at line 197 mixed getSitesIdFromSiteUrl(string $url, string $format = null)

Parameters

Return Value

at line 218 mixed addSite(string $siteName, $urls = [], $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 getSitesFromGroup(string $group, string $format = null)`

at line 36
`mixed getSiteGroups(string $format = null)`

at line 50
`mixed getSitesFromId(string $format = null)`

at line 64
`mixed getSiteUrlsFromId(int $siteId = null, string $format = null)`

at line 80
`mixed getAllSites(string $format = null)`

at line 94
`mixed getAllSitesId(string $format = null)`

at line 109
`mixed getSitesWithAdminAccess($arguments = [], string $format = null)`

at line 124
`mixed getSitesWithViewAccess(string $format = null)`

at line 139
`mixed getSitesWithAtLeastViewAccess($arguments = [], string $format = null)`

at line 154
`mixed getSitesIdWithAdminAccess(string $format = null)`

at line 168
`mixed getSitesIdWithViewAccess(string $format = null)`

at line 182
`mixed getSitesIdWithAtLeastViewAccess(string $format = null)`

at line 197
`mixed getSitesIdFromSiteUrl(string $url, string $format = null)`

at line 218
`mixed addSite(string $siteName, $urls = [], $arguments = [], string $format = null)`