• Главная
• Piwik
• Plugins
• UsersManager
• API

PHP Класс Piwik\Plugins\UsersManager\API

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 ( Model $model, Piwik\Plugins\UsersManager\UserAccessFilter $filter, Password $password )
addUser ( $userLogin, $password, $email, $alias = false, $_isPasswordHashed = false )	Add a user in the database.
createTokenAuth ( string $userLogin ) : string	Generates a new random authentication token.
deleteUser ( string $userLogin ) : boolean	Delete a user and all its access, given its login.
getAllUsersPreferences ( array $preferenceNames ) : array	Returns an array of Preferences
getInstance ( ) : API	You can create your own Users Plugin to override this class.
getSitesAccessFromUser ( string $userLogin ) : array	For each website ID, returns the access level of the given $userLogin.
getTokenAuth ( string $userLogin, string $md5Password ) : string	Returns the user's API token.
getUser ( string $userLogin ) : array	Returns the user information (login, password hash, alias, email, date_registered, etc.)
getUserByEmail ( string $userEmail ) : array	Returns the user information (login, password hash, alias, email, date_registered, etc.)
getUserLoginFromUserEmail ( string $userEmail ) : boolean	Returns the first login name of an existing user that has the given email address. If no user can be found for this user an error will be returned.
getUserPreference ( string $userLogin, string $preferenceName ) : boolean | string	Gets a user preference
getUsers ( string $userLogins = '' ) : array	Returns the list of all the users
getUsersAccessFromSite ( integer $idSite ) : array	For each user, returns his access level for the given $idSite.
getUsersHavingSuperUserAccess ( ) : array	Returns a list of all Super Users containing there userLogin and email address.
getUsersLogin ( ) : array	Returns the list of all the users login
getUsersSitesFromAccess ( $access ) : array	For each user, returns the list of website IDs where the user has the supplied $access level.
getUsersWithSiteAccess ( $idSite, $access )
hasSuperUserAccess ( ) : boolean	Detect whether the current user has super user access or not.
initUserPreferenceWithDefault ( string $userLogin, string $preferenceName )	Sets a user preference in the DB using the preference's default value.
regenerateTokenAuth ( string $userLogin )	Regenerate the token_auth associated with a user.
setSuperUserAccess ( string $userLogin, boolean | integer $hasSuperUserAccess )	Enable or disable Super user access to the given user login. Note: When granting Super User access all previous permissions of the user will be removed as the user gains access to everything.
setUserAccess ( string $userLogin, string $access, integer | array $idSites ) : boolean	Set an access level to a given user for a list of websites ID.
setUserPreference ( string $userLogin, string $preferenceName, string $preferenceValue ) : void	Sets a user preference
updateUser ( $userLogin, $password = false, $email = false, $alias = false, $_isPasswordHashed = false )	Updates a user in the database.
userEmailExists ( string $userEmail ) : boolean	Returns true if user with given email (userEmail) is known in the database, or the Super User
userExists ( string $userLogin ) : boolean	Returns true if the given userLogin is known in the database

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

Метод	Описание
checkAccessType ( $access )
checkEmail ( $email )
checkLogin ( $userLogin )
checkUserEmailExists ( string $userEmail )	Throws an exception is the user email cannot be found
checkUserExists ( string $userLogin )	Throws an exception is the user login doesn't exist
checkUserHasNotSuperUserAccess ( $userLogin )
checkUserIsNotAnonymous ( $userLogin )
enrichUser ( $user )
enrichUsers ( $users )
getCleanAlias ( $alias, $userLogin )
getDefaultUserPreference ( $preferenceName, $login )
getPreferenceId ( $login, $preference )
getPreferenceValue ( $userLogin, $preferenceName )
isUserTheOnlyUserHavingSuperUserAccess ( $userLogin )

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