class UserDetails

Constants

STATUS_ACTIVE

STATUS_LOCKOUT

STATUS_DISABLED

Properties

protected $login
protected $displayname
protected $firstname
protected $lastname
protected $email
protected $password
protected $url_access
protected $guest
protected $groups
protected $remove_groups
protected $status
protected $settings
protected $meta

Methods

__construct(string $login = null)

UserDetails constructor.

array
getProperties()

Get UserDetails as Array

setGroups(int[] $securityGroupIDs = [2])

Set security groups the user should be a member of (this will NOT delete other groups)

setIsGuest(bool $isGuest = true)

User is considered a guest (anonymous access and no access to profile)

setIsNotValidated(bool $isNotValidated = true)

Set true if user should reauthenticate against other methods to access sensitive data

setOptionalAttributes(string $firstname = null, string $lastname = null, string $email = null, string $password = null)

Optional Set/Update the following attributes for the user as effect of this login

setOptionalConfigSettings(array $config = [])

Set User Config Settings as Key => Value pairs

setOptionalMetaSettings(array $meta = [])

Set User Meta Settings as Key => Value pairs

setRevokeGroups(int[] $securityGroupIDs = [])

Set security groups the user should NOT be a member of

setStatus(string $status = self::STATUS_ACTIVE)

Set current status of user

setUserDisplayname(string $displayname)

No description

setUserIdentity(string $login)

No description

Details

at line 35
__construct(string $login = null)

UserDetails constructor.

Parameters

string $login

at line 144
array getProperties()

Get UserDetails as Array

Return Value

array

at line 92
setGroups(int[] $securityGroupIDs = [2])

Set security groups the user should be a member of (this will NOT delete other groups)

Parameters

int[] $securityGroupIDs

at line 82
setIsGuest(bool $isGuest = true)

User is considered a guest (anonymous access and no access to profile)

Parameters

bool $isGuest

at line 73
setIsNotValidated(bool $isNotValidated = true)

Set true if user should reauthenticate against other methods to access sensitive data

Parameters

bool $isNotValidated

at line 61
setOptionalAttributes(string $firstname = null, string $lastname = null, string $email = null, string $password = null)

Optional Set/Update the following attributes for the user as effect of this login

Parameters

string $firstname
string $lastname
string $email
string $password

Password for internal/fallback XELOS authentication

at line 119
setOptionalConfigSettings(array $config = [])

Set User Config Settings as Key => Value pairs

Parameters

array $config

at line 128
setOptionalMetaSettings(array $meta = [])

Set User Meta Settings as Key => Value pairs

Parameters

array $meta

at line 101
setRevokeGroups(int[] $securityGroupIDs = [])

Set security groups the user should NOT be a member of

Parameters

int[] $securityGroupIDs

at line 110
setStatus(string $status = self::STATUS_ACTIVE)

Set current status of user

Parameters

string $status

at line 49
setUserDisplayname(string $displayname)

No description

Parameters

string $displayname

Required if user should be created

at line 42
setUserIdentity(string $login)

No description

Parameters

string $login

Required to identify existing users