1. class
  2. RobBrazier
  3. \
  4. Piwik
  5. \
  6. Module
  7. \
  8. UsersManagerModule

UsersManagerModule

class UsersManagerModule extends Module (View source)

Class UsersManagerModule.

Properties

protected RequestRepository $request from  Module

Methods

__construct(RequestRepository $request)

Module constructor.

from  Module
RequestOptions
getOptions(string $format)

No description

from  Module
mixed
createAppSpecificTokenAuth(string $userLogin, string $password, string $description, string $expireDate = '', int $expireHours = 0, null $format = null)

Gets the user's Authentication Token for Matomo V4

mixed
getTokenAuth(string $userLogin, string $md5Password, string $format = null)

Gets the user's Authentication Token

setUserAccess(string $userLogin, string $access, array $idSites, string $format = null)

Assign an access role to a specified user for one or many site ids

addUser(string $userLogin, string $password, string $email, string $alias = null, string $initialIdSite = null, string $format = null)

Create a user

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 25
mixed createAppSpecificTokenAuth(string $userLogin, string $password, string $description, string $expireDate = '', int $expireHours = 0, null $format = null)

Gets the user's Authentication Token for Matomo V4

Parameters

string $userLogin

user login
string $password

user password
string $description

description of the token, e.g. its usage
string $expireDate

expire date of the token default: null
int $expireHours

expire hours of the token default: 0
null $format

override format (defaults to one specified in config file)

Return Value

mixed

at line 51
mixed getTokenAuth(string $userLogin, string $md5Password, string $format = null)

Gets the user's Authentication Token

Parameters

string $userLogin

user login
string $md5Password

md5 hashed password
string $format

override format (defaults to one specified in config file)

Return Value

mixed

at line 73
setUserAccess(string $userLogin, string $access, array $idSites, string $format = null)

Assign an access role to a specified user for one or many site ids

Parameters

string $userLogin

user login
string $access

user access role ({https://matomo.org/docs/manage-users/#advanced-user-management})
array $idSites

site ids to give the user access to
string $format

override format (defaults to one specified in config file)

at line 101
addUser(string $userLogin, string $password, string $email, string $alias = null, string $initialIdSite = null, string $format = null)

Create a user

Parameters

string $userLogin

user login
string $password

user password
string $email

user email
string $alias

user alias (optional)
string $initialIdSite

initial site id to give access to
string $format

override format (defaults to one specified in config file)