PHP Класс 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.
Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод Описание
__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 )

Приватные методы

Метод Описание
getDb ( )
updateUserFields ( $userLogin, $fields )

Описание методов

__construct() публичный Метод

public __construct ( )

addUser() публичный Метод

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

addUserAccess() публичный Метод

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

deleteUserAccess() публичный Метод

public deleteUserAccess ( $userLogin, $idSites = null )

deleteUserOnly() публичный Метод

public deleteUserOnly ( $userLogin )

getSitesAccessFromUser() публичный Метод

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
Результат array The returned array has the format array( idsite1 => 'view', idsite2 => 'admin', idsite3 => 'view', ... )

getUser() публичный Метод

public getUser ( $userLogin )

getUserByEmail() публичный Метод

public getUserByEmail ( $userEmail )

getUserByTokenAuth() публичный Метод

public getUserByTokenAuth ( $tokenAuth )

getUsers() публичный Метод

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
Результат array the list of all the users

getUsersAccessFromSite() публичный Метод

public getUsersAccessFromSite ( $idSite )

getUsersHavingSuperUserAccess() публичный Метод

Note that this returns the token_auth which is as private as the password!
public getUsersHavingSuperUserAccess ( ) : array[]
Результат array[] containing login, email and token_auth

getUsersLogin() публичный Метод

Returns the list of all the users login
public getUsersLogin ( ) : array
Результат array the list of all the users login

getUsersLoginWithSiteAccess() публичный Метод

public getUsersLoginWithSiteAccess ( $idSite, $access )

getUsersSitesFromAccess() публичный Метод

public getUsersSitesFromAccess ( $access )

setSuperUserAccess() публичный Метод

public setSuperUserAccess ( $userLogin, $hasSuperUserAccess )

updateUser() публичный Метод

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

updateUserTokenAuth() публичный Метод

public updateUserTokenAuth ( $userLogin, $tokenAuth )

userEmailExists() публичный Метод

public userEmailExists ( $userEmail )

userExists() публичный Метод

public userExists ( $userLogin )