class SitesManagerModule extends Module (View source)

Class SitesManagerModule.

Properties

protected RequestRepository $request from  Module

Methods

__construct(RequestRepository $request)

Module constructor.

from  Module
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

__construct(RequestRepository $request)

Module constructor.

Parameters

RequestRepository $request

protected RequestOptions getOptions(string $format)

No description

Parameters

string $format

response format

Return Value

RequestOptions

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

mixed getSiteGroups(string $format = null)

No description

Parameters

string $format

override format (defaults to one specified in config file)

Return Value

mixed

mixed getSitesFromId(string $format = null)

No description

Parameters

string $format

override format (defaults to one specified in config file)

Return Value

mixed

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

mixed getAllSites(string $format = null)

No description

Parameters

string $format

override format (defaults to one specified in config file)

Return Value

mixed

mixed getAllSitesId(string $format = null)

No description

Parameters

string $format

override format (defaults to one specified in config file)

Return Value

mixed

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

No description

Parameters

$arguments
string $format

override format (defaults to one specified in config file)

Return Value

mixed

mixed getSitesWithViewAccess(string $format = null)

No description

Parameters

string $format

override format (defaults to one specified in config file)

Return Value

mixed

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

No description

Parameters

$arguments
string $format

override format (defaults to one specified in config file)

Return Value

mixed

mixed getSitesIdWithAdminAccess(string $format = null)

No description

Parameters

string $format

override format (defaults to one specified in config file)

Return Value

mixed

mixed getSitesIdWithViewAccess(string $format = null)

No description

Parameters

string $format

override format (defaults to one specified in config file)

Return Value

mixed

mixed getSitesIdWithAtLeastViewAccess(string $format = null)

No description

Parameters

string $format

override format (defaults to one specified in config file)

Return Value

mixed

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

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