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.
Mostra file Open project: piwik/piwik Class Usage Examples

Public Methods

Method 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

Method Description
getDb ( )
updateUserFields ( $userLogin, $fields )

Method Details

__construct() public method

public __construct ( )

addUser() public method

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

addUserAccess() public method

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

deleteUserAccess() public method

public deleteUserAccess ( $userLogin, $idSites = null )

deleteUserOnly() public method

public deleteUserOnly ( $userLogin )

getSitesAccessFromUser() public method

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
return array The returned array has the format array( idsite1 => 'view', idsite2 => 'admin', idsite3 => 'view', ... )

getUser() public method

public getUser ( $userLogin )

getUserByEmail() public method

public getUserByEmail ( $userEmail )

getUserByTokenAuth() public method

public getUserByTokenAuth ( $tokenAuth )

getUsers() public method

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
return array the list of all the users

getUsersAccessFromSite() public method

public getUsersAccessFromSite ( $idSite )

getUsersHavingSuperUserAccess() public method

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

getUsersLogin() public method

Returns the list of all the users login
public getUsersLogin ( ) : array
return array the list of all the users login

getUsersLoginWithSiteAccess() public method

public getUsersLoginWithSiteAccess ( $idSite, $access )

getUsersSitesFromAccess() public method

public getUsersSitesFromAccess ( $access )

setSuperUserAccess() public method

public setSuperUserAccess ( $userLogin, $hasSuperUserAccess )

updateUser() public method

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

updateUserTokenAuth() public method

public updateUserTokenAuth ( $userLogin, $tokenAuth )

userEmailExists() public method

public userEmailExists ( $userEmail )

userExists() public method

public userExists ( $userLogin )