PHP Class Piwik\Plugins\UsersManager\Model

You can create users via "addUser", update existing users via "updateUser" and delete users via "deleteUser". There are many ways to list users based on their login "getUser" and "getUsers", their email "getUserByEmail", or which users have permission (view or admin) to access the specified websites "getUsersWithSiteAccess". Existing Permissions are listed given a login via "getSitesAccessFromUser", or a website ID via "getUsersAccessFromSite", or you can list all users and websites for a given permission via "getUsersSitesFromAccess". Permissions are set and updated via the method "setUserAccess". See also the documentation about Managing Users in Piwik.
Afficher le fichier Open project: piwik/piwik Class Usage Examples

Méthodes publiques

Méthode Description
__construct ( )
addUser ( $userLogin, $hashedPassword, $email, $alias, $tokenAuth, $dateRegistered )
addUserAccess ( $userLogin, $access, $idSites )
deleteUserAccess ( $userLogin, $idSites = null )
deleteUserOnly ( $userLogin )
getSitesAccessFromUser ( string $userLogin ) : array For each website ID, returns the access level of the given $userLogin.
getUser ( $userLogin )
getUserByEmail ( $userEmail )
getUserByTokenAuth ( $tokenAuth )
getUsers ( array $userLogins ) : array Returns the list of all the users
getUsersAccessFromSite ( $idSite )
getUsersHavingSuperUserAccess ( ) : array[] Note that this returns the token_auth which is as private as the password!
getUsersLogin ( ) : array Returns the list of all the users login
getUsersLoginWithSiteAccess ( $idSite, $access )
getUsersSitesFromAccess ( $access )
setSuperUserAccess ( $userLogin, $hasSuperUserAccess )
updateUser ( $userLogin, $hashedPassword, $email, $alias, $tokenAuth )
updateUserTokenAuth ( $userLogin, $tokenAuth )
userEmailExists ( $userEmail )
userExists ( $userLogin )

Private Methods

Méthode Description
getDb ( )
updateUserFields ( $userLogin, $fields )

Method Details

__construct() public méthode

public __construct ( )

addUser() public méthode

public addUser ( $userLogin, $hashedPassword, $email, $alias, $tokenAuth, $dateRegistered )

addUserAccess() public méthode

public addUserAccess ( $userLogin, $access, $idSites )

deleteUserAccess() public méthode

public deleteUserAccess ( $userLogin, $idSites = null )

deleteUserOnly() public méthode

public deleteUserOnly ( $userLogin )

getSitesAccessFromUser() public méthode

If the user doesn't have any access to a website ('noaccess'), this website will not be in the returned array. If the user doesn't have any access, the returned array will be an empty array.
public getSitesAccessFromUser ( string $userLogin ) : array
$userLogin string User that has to be valid
Résultat array The returned array has the format array( idsite1 => 'view', idsite2 => 'admin', idsite3 => 'view', ... )

getUser() public méthode

public getUser ( $userLogin )

getUserByEmail() public méthode

public getUserByEmail ( $userEmail )

getUserByTokenAuth() public méthode

public getUserByTokenAuth ( $tokenAuth )

getUsers() public méthode

Returns the list of all the users
public getUsers ( array $userLogins ) : array
$userLogins array List of users to select. If empty, will return all users
Résultat array the list of all the users

getUsersAccessFromSite() public méthode

public getUsersAccessFromSite ( $idSite )

getUsersHavingSuperUserAccess() public méthode

Note that this returns the token_auth which is as private as the password!
public getUsersHavingSuperUserAccess ( ) : array[]
Résultat array[] containing login, email and token_auth

getUsersLogin() public méthode

Returns the list of all the users login
public getUsersLogin ( ) : array
Résultat array the list of all the users login

getUsersLoginWithSiteAccess() public méthode

public getUsersLoginWithSiteAccess ( $idSite, $access )

getUsersSitesFromAccess() public méthode

public getUsersSitesFromAccess ( $access )

setSuperUserAccess() public méthode

public setSuperUserAccess ( $userLogin, $hasSuperUserAccess )

updateUser() public méthode

public updateUser ( $userLogin, $hashedPassword, $email, $alias, $tokenAuth )

updateUserTokenAuth() public méthode

public updateUserTokenAuth ( $userLogin, $tokenAuth )

userEmailExists() public méthode

public userEmailExists ( $userEmail )

userExists() public méthode

public userExists ( $userLogin )