UserManager
in package
implements
UserManagerInterface
Interfaces, Classes, Traits and Enums
Table of Contents
- $core : resource
- changePassword() : mixed
- Changes password of the currently authenticated user,
- dropGroup() : mixed
- Remove a group.
- dropUser() : mixed
- Remove a user.
- getAllGroups() : array<string|int, mixed>
- Get all groups.
- getAllUsers() : array<string|int, mixed>
- Fetch all users.
- getGroup() : Group
- Fetch a group.
- getRoles() : array<string|int, mixed>
- Get all roles and descriptions.
- getUser() : UserAndMetadata
- Fetch a user.
- upsertGroup() : mixed
- Create or replace a group.
- upsertUser() : mixed
- Create or replace a user.
Properties
$core
private
resource
$core
Methods
changePassword()
Changes password of the currently authenticated user,
public
changePassword(string $newPassword[, ChangePasswordOptions|null $options = null ]) : mixed
Parameters
- $newPassword : string
-
new password
- $options : ChangePasswordOptions|null = null
-
the options to use when changing the password of the user
Tags
Return values
mixed —dropGroup()
Remove a group.
public
dropGroup(string $name[, DropGroupOptions|null $options = null ]) : mixed
Parameters
- $name : string
-
the name of the group.
- $options : DropGroupOptions|null = null
-
the options to use when dropping the group.
Tags
Return values
mixed —dropUser()
Remove a user.
public
dropUser(string $name[, DropUserOptions|null $options = null ]) : mixed
Parameters
- $name : string
-
the name of the user.
- $options : DropUserOptions|null = null
-
the options to use when dropping the user.
Tags
Return values
mixed —getAllGroups()
Get all groups.
public
getAllGroups([GetAllGroupsOptions|null $options = null ]) : array<string|int, mixed>
Parameters
- $options : GetAllGroupsOptions|null = null
-
the options to use when fetching the groups.
Tags
Return values
array<string|int, mixed> —getAllUsers()
Fetch all users.
public
getAllUsers([GetAllUsersOptions|null $options = null ]) : array<string|int, mixed>
Parameters
- $options : GetAllUsersOptions|null = null
-
the options to use when fetching the users.
Tags
Return values
array<string|int, mixed> —getGroup()
Fetch a group.
public
getGroup(string $name[, GetGroupOptions|null $options = null ]) : Group
Parameters
- $name : string
-
the name of the user.
- $options : GetGroupOptions|null = null
-
the options to use when fetching the group.
Tags
Return values
Group —getRoles()
Get all roles and descriptions.
public
getRoles([GetRolesOptions|null $options = null ]) : array<string|int, mixed>
Parameters
- $options : GetRolesOptions|null = null
-
the options to use when fetching the roles.
Tags
Return values
array<string|int, mixed> —getUser()
Fetch a user.
public
getUser(string $name[, GetUserOptions|null $options = null ]) : UserAndMetadata
Parameters
- $name : string
-
the name of the user.
- $options : GetUserOptions|null = null
-
the options to use when fetching the user.
Tags
Return values
UserAndMetadata —upsertGroup()
Create or replace a group.
public
upsertGroup(Group $group[, UpsertGroupOptions|null $options = null ]) : mixed
Parameters
- $group : Group
-
the group.
- $options : UpsertGroupOptions|null = null
-
the options to use when upserting the group.
Tags
Return values
mixed —upsertUser()
Create or replace a user.
public
upsertUser(User $user[, UpsertUserOptions|null $options = null ]) : mixed
Parameters
- $user : User
-
the user.
- $options : UpsertUserOptions|null = null
-
the options to use when upserting the user.