tUser

MMO\oauth\classes · 1 symbole · générée le 27 Oct 2026

trait

tUser

Model for user

#[MMO\core\attributes\ArrayProperty('password', getter: false, setter: 'loadPassword', schema: ['type' => 'string', 'description' => 'the new password'])] trait MMO\oauth\classes\tUser use MMO\oauth\classes\tClient

Espace de noms: MMO\oauth\classes
Utilise les traits: tClient

Index

	clientFlags	Client flags
	config
	lastPasswordChange	Last date the password was changed.
	passhash	Password hash: stored, never exported (an API response, a user embedded in another entity's)
	roles	Roles associated with the token.
	scopes
	username
	addRole($role)
	allow($uids)	Add scope if it is not already disallowed
	applyScopes($scopes, $set)	Apply this scopes onto a list of scopes
	blameOwnScope($uid)
	blameScope($uid)
	clearRoles()
	clearScopes()
	disallow($uids)
	getClientFlagsText($separator)	Get the flags as text
	getClientRedirectUri()	Returns the registered redirect URI (as a string).
	getClientSecret()
	getConfig()
	getLastPasswordChange()
	getOwnScope($uid)
	getOwnScopes()	Return an array of scopes associated with the token.
	getRoles()
	getScope($uid)
	getScopes()	Return an array of scopes associated with the token.
	getUniqueName()
	getUsername()
	hasClientFlag($flag)
	hasRole($role)
	hasScope($uid)
	isAllowed($uids)	Test if all scopes are allowed
	isAnyAllowed($uids)	Test if any scope is allowed Scopes expressed as string can be a list of scope's uid seperated by a space (in this case, all scopes MUST be allowed).
	isConfidential()	Returns true if the client is confidential.
	loadPassword($pwd)	The `password` of the entity's data (an api's PUT, a form saved): a field left blank, or null, keeps the password -- a form sends its empty field with the rest.
	markChanged($keys) abstract	Record that properties changed (`scopes`), so they are saved: `aEntity::markChanged`
	removeRole($role)
	scopesText($separator, $true, $false)
	setLastPasswordChange($datetime)
	setPassword($pwd, $verify)
	setRoles($roles)
	setScope($uid, $value)	Set the scope's value
	setScopes($scopes)
	setUsername($value)	The property is declared readonly.
	updateClientFlag($flag, $value)
	verifySecret($pwd)

Propriétés7

clientFlags

Client flags

#[MMO\core\attributes\ArrayProperty()] protected int $clientFlags = 0

Type: int

config

#[MMO\core\attributes\ArrayProperty()] protected array $config = []

Type: array

lastPasswordChange

Last date the password was changed.

#[MMO\core\attributes\ArrayProperty(setter: false, store: true)] protected ?DateTime $lastPasswordChange = null

Type: null | DateTime

passhash

Password hash: stored, never exported (an API response, a user embedded in another entity's)

#[MMO\core\attributes\ArrayProperty(setter: false, store: true)] protected string $passhash

Type: string

roles

Roles associated with the token.

#[MMO\core\attributes\ArrayProperty(schema: '[MMO\\oauth\\entities\\Role]')] protected array $roles = []

Type: array

scopes

#[MMO\core\attributes\Serialize(serialize: 'getOwnScopes')] #[MMO\core\attributes\ArrayProperty(schema: '{...: bool}')] protected array $scopes = []

Type: array

username

#[MMO\core\attributes\ArrayProperty(setter: false, store: true)] protected string $username = ''

Type: string

Méthodes38

addRole($role)

tWithRoles.php:24

function addRole(MMO\oauth\entities\Role $role): bool

$role	Role
retourne	bool

allow($uids)

tWithScopes.php:100

Add scope if it is not already disallowed

function allow(object|string ...$uids): void

...$uids	object \| string	list of scope's uid separated by space or a list of uid
retourne	void

applyScopes($scopes, $set)

tWithScopes.php:136

Apply this scopes onto a list of scopes

function applyScopes(array &$scopes, bool $set = false): void

$scopes	array	list of {scope:uid} => {allow:bool}
$set = false	bool	`mergeScopes`
retourne	void

blameOwnScope($uid)

tWithScopes.php:52

function blameOwnScope(string $uid): array

$uid	string
retourne	array

blameScope($uid)

tWithRoles.php:100

function blameScope(string $uid): array

$uid	string
retourne	array

clearRoles()

tWithRoles.php:57

function clearRoles(): void

retourne

void

clearScopes()

tWithScopes.php:91

function clearScopes(): void

retourne

void

disallow($uids)

tWithScopes.php:106

function disallow(object|string ...$uids): void

...$uids	object \| string
retourne	void

getClientFlagsText($separator)

tClient.php:64

Get the flags as text

function getClientFlagsText(?string $separator = ','): array|string

$separator = ','	null \| string	if null, will return an array
retourne	array \| string

getClientRedirectUri()

tUser.php:129

Returns the registered redirect URI (as a string).

function getClientRedirectUri(): string

retourne

string

getClientSecret()

tUser.php:143

function getClientSecret(): ?string

retourne

null | string

getConfig()

tClient.php:71

function getConfig(): array

retourne

array

getLastPasswordChange()

tUser.php:102

function getLastPasswordChange(): ?DateTime

retourne

null | DateTime

getOwnScope($uid)

tWithScopes.php:27

function getOwnScope(string $uid): ?bool

$uid	string
retourne	null \| bool

getOwnScopes()

tWithScopes.php:40

Return an array of scopes associated with the token.

function getOwnScopes(): array

retourne

array

bool>

getRoles()

tWithRoles.php:62

function getRoles(): array

retourne

array

getScope($uid)

tWithRoles.php:87

function getScope(string $uid): ?bool

$uid	string
retourne	null \| bool

getScopes()

tWithRoles.php:79

Return an array of scopes associated with the token.

function getScopes(): array

retourne

array

iScope>

getUniqueName()

tUser.php:45

function getUniqueName(): string

retourne

string

getUsername()

tUser.php:41

function getUsername(): string

retourne

string

hasClientFlag($flag)

tClient.php:43

function hasClientFlag(int $flag): bool

$flag	int
retourne	bool

hasRole($role)

tWithRoles.php:32

function hasRole(MMO\oauth\entities\Role|string $role): bool

$role	Role \| string
retourne	bool

hasScope($uid)

tWithScopes.php:31

function hasScope(string $uid): bool

$uid	string
retourne	bool

isAllowed($uids)

tWithScopes.php:116

Test if all scopes are allowed

function isAllowed(object|string ...$uids): bool

...$uids	object \| string
retourne	bool

isAnyAllowed($uids)

tWithScopes.php:125

Test if any scope is allowed Scopes expressed as string can be a list of scope's uid seperated by a space (in this case, all scopes MUST be allowed).

function isAnyAllowed(object|string ...$uids): bool

...$uids	object \| string
retourne	bool

isConfidential()

tUser.php:139

Returns true if the client is confidential.

function isConfidential(): bool

Confidential client are generally web application that use rest to get the credentials. User-agent (browser) or native application are usually public clients.

retourne

bool

loadPassword($pwd)

tUser.php:71

The password of the entity's data (an api's PUT, a form saved): a field left blank, or null, keeps the password -- a form sends its empty field with the rest. Set in code, setPassword.

function loadPassword(?string $pwd): bool

$pwd	null \| string
retourne	bool

$user->loadArray(['firstname' => 'Ada', 'password' => '']); // the password is unchanged

markChanged($keys)

abstracttWithScopes.php:25

Record that properties changed (scopes), so they are saved: aEntity::markChanged

abstract function markChanged(string ...$keys): bool

...$keys	string
retourne	bool

removeRole($role)

tWithRoles.php:40

function removeRole(MMO\oauth\entities\Role|string $role): bool

$role	Role \| string
retourne	bool

scopesText($separator, $true, $false)

tWithScopes.php:44

function scopesText(string $separator = ' | ', string $true = '✓', string $false = '✗'): string

$separator = ' \| '	string
$true = '✓'	string
$false = '✗'	string
retourne	string

setLastPasswordChange($datetime)

tUser.php:106

function setLastPasswordChange(DateTimeInterface|string|int|null $datetime = 'now'): bool

$datetime = 'now'	DateTimeInterface \| string \| int \| null
retourne	bool

setPassword($pwd, $verify)

tUser.php:79

function setPassword(string $pwd, bool $verify = true): bool

$pwd	string
$verify = true	bool
retourne	bool

setRoles($roles)

tWithRoles.php:66

function setRoles(array $roles): bool

$roles	array
retourne	bool

setScope($uid, $value)

tWithScopes.php:65

Set the scope's value

function setScope(object|string $uid, ?bool $value): void

$uid	object \| string
$value	null \| bool	if null, remove the scope from the list of scopes
retourne	void

setScopes($scopes)

tWithScopes.php:76

function setScopes(array|string $scopes): bool

$scopes	array \| string
retourne	bool

setUsername($value)

tUser.php:59

The property is declared readonly. $entity['username'] = 'xxx' will not work.

function setUsername(string $value): bool

But calling directly this function will set the username. WARNING: you MUST verify that the username is unique before calling this function. [`ClientRepository::isUsernameAvailable`](https://mmoframework.fr/fr/documentation/mmo.oauth/php/ClientRepository.md#clientrepository-isusernameavailable)

$value	string
retourne	bool

updateClientFlag($flag, $value)

tClient.php:47

function updateClientFlag(int $flag, bool $value = true): bool

$flag	int
$value = true	bool
retourne	bool

verifySecret($pwd)

tClient.php:38

function verifySecret(?string $pwd): bool

$pwd	null \| string
retourne	bool