User
in package
Table of Contents
- $displayName : string|null
- $groups : array<string|int, mixed>|null
- $password : string|null
- $roles : array<string|int, mixed>|null
- $username : string
- __construct() : mixed
- build() : User
- Static helper to keep code more readable
- displayName() : string
- Gets the display name for the user.
- groups() : array<string|int, mixed>
- Gets the group names for the user.
- roles() : array<string|int, mixed>
- Gets the roles for the user.
- setDisplayName() : User
- Sets the display name for the user.
- setGroups() : User
- Sets the group names for the user.
- setPassword() : User
- Sets the password for the user.
- setRoles() : User
- Sets the roles for the user.
- setUsername() : User
- Sets the username for the user.
- username() : string
- Gets the username for the user.
Properties
$displayName
private
string|null
$displayName
= null
$groups
private
array<string|int, mixed>|null
$groups
= null
$password
private
string|null
$password
= null
$roles
private
array<string|int, mixed>|null
$roles
= null
$username
private
string
$username
= ""
Methods
__construct()
public
__construct() : mixed
Tags
Return values
mixed —build()
Static helper to keep code more readable
public
static build() : User
Tags
Return values
User —displayName()
Gets the display name for the user.
public
displayName() : string
Tags
Return values
string —groups()
Gets the group names for the user.
public
groups() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —roles()
Gets the roles for the user.
public
roles() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —setDisplayName()
Sets the display name for the user.
public
setDisplayName(string $name) : User
Parameters
- $name : string
-
the display name
Tags
Return values
User —setGroups()
Sets the group names for the user.
public
setGroups(array<string|int, mixed> $groups) : User
Parameters
- $groups : array<string|int, mixed>
-
the group names
Tags
Return values
User —setPassword()
Sets the password for the user.
public
setPassword(string $password) : User
Parameters
- $password : string
-
the password
Tags
Return values
User —setRoles()
Sets the roles for the user.
public
setRoles(array<string|int, mixed> $roles) : User
Parameters
- $roles : array<string|int, mixed>
-
the roles
Tags
Return values
User —setUsername()
Sets the username for the user.
public
setUsername(string $username) : User
Parameters
- $username : string
-
the username
Tags
Return values
User —username()
Gets the username for the user.
public
username() : string