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 19
`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 37
`mixed getSiteGroups(string $format = null)`

No description

Parameters

string

$format

override format (defaults to one specified in config file)

Return Value

mixed

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

No description

Parameters

string

$format

override format (defaults to one specified in config file)

Return Value

mixed

at line 65
`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 81
`mixed getAllSites(string $format = null)`

No description

Parameters

string

$format

override format (defaults to one specified in config file)

Return Value

mixed

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

No description

Parameters

string

$format

override format (defaults to one specified in config file)

Return Value

mixed

at line 110
`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 125
`mixed getSitesWithViewAccess(string $format = null)`

No description

Parameters

string

$format

override format (defaults to one specified in config file)

Return Value

mixed

at line 140
`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 155
`mixed getSitesIdWithAdminAccess(string $format = null)`

No description

Parameters

string

$format

override format (defaults to one specified in config file)

Return Value

mixed

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

No description

Parameters

string

$format

override format (defaults to one specified in config file)

Return Value

mixed

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

No description

Parameters

string

$format

override format (defaults to one specified in config file)

Return Value

mixed

at line 198
`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 219
`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 19 mixed getSitesFromGroup(string $group, string $format = null)

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

at line 219 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 19
`mixed getSitesFromGroup(string $group, string $format = null)`

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

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

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

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

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

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

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

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

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

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

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

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

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