User

MMO\oauth\entities · 1 symbol · generated 5 Oct 2026

class

User

Model for user

#[MMO\core\attributes\ArrayProperty(name: 'password', setter: 'setPassword')] class MMO\oauth\entities\User extends MMO\core\entities\Entity implements MMO\oauth\interfaces\iUser use MMO\oauth\classes\tUser

Namespace: MMO\oauth\entities
Extends: Entity
Implements: iUser
Uses traits: tUser

Index

	clientFlags	Client flags
	config
	email
	firstname
	lastname
	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()
	getEmail()
	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.
	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)

Properties10

clientFlags

Client flags

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

Type: int

config

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

Type: array

email

#[MMO\core\attributes\ArrayProperty()] protected ?string $email = null

Type: null | string

firstname

#[MMO\core\attributes\ArrayProperty()] protected string $firstname

Type: string

lastname

#[MMO\core\attributes\ArrayProperty()] protected string $lastname

Type: string

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

Methods37

addRole($role)

tWithRoles.php:24

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

$role	Role
returns	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
returns	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`
returns	void

blameOwnScope($uid)

tWithScopes.php:52

function blameOwnScope(string $uid): array

$uid	string
returns	array

blameScope($uid)

tWithRoles.php:100

function blameScope(string $uid): array

$uid	string
returns	array

clearRoles()

tWithRoles.php:57

function clearRoles(): void

returns

void

clearScopes()

tWithScopes.php:91

function clearScopes(): void

returns

void

disallow($uids)

tWithScopes.php:106

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

...$uids	object \| string
returns	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
returns	array \| string

getClientRedirectUri()

tUser.php:115

Returns the registered redirect URI (as a string).

function getClientRedirectUri(): string

returns

string

getClientSecret()

tUser.php:129

function getClientSecret(): ?string

returns

null | string

getConfig()

tClient.php:71

function getConfig(): array

returns

array

getEmail()

User.php:33

function getEmail(): ?string

returns

null | string

getLastPasswordChange()

tUser.php:90

function getLastPasswordChange(): ?DateTime

returns

null | DateTime

getOwnScope($uid)

tWithScopes.php:27

function getOwnScope(string $uid): ?bool

$uid	string
returns	null \| bool

getOwnScopes()

tWithScopes.php:40

Return an array of scopes associated with the token.

function getOwnScopes(): array

returns

array

bool>

getRoles()

tWithRoles.php:62

function getRoles(): array

returns

array

getScope($uid)

tWithRoles.php:87

function getScope(string $uid): ?bool

$uid	string
returns	null \| bool

getScopes()

tWithRoles.php:79

Return an array of scopes associated with the token.

function getScopes(): array

returns

array

iScope>

getUniqueName()

tUser.php:45

function getUniqueName(): string

returns

string

getUsername()

tUser.php:41

function getUsername(): string

returns

string

hasClientFlag($flag)

tClient.php:43

function hasClientFlag(int $flag): bool

$flag	int
returns	bool

hasRole($role)

tWithRoles.php:32

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

$role	Role \| string
returns	bool

hasScope($uid)

tWithScopes.php:31

function hasScope(string $uid): bool

$uid	string
returns	bool

isAllowed($uids)

tWithScopes.php:116

Test if all scopes are allowed

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

...$uids	object \| string
returns	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
returns	bool

isConfidential()

tUser.php:125

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.

returns

bool

removeRole($role)

tWithRoles.php:40

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

$role	Role \| string
returns	bool

scopesText($separator, $true, $false)

tWithScopes.php:44

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

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

setLastPasswordChange($datetime)

tUser.php:94

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

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

setPassword($pwd, $verify)

tUser.php:68

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

$pwd	string
$verify = true	bool
returns	bool

setRoles($roles)

tWithRoles.php:66

function setRoles(array $roles): bool

$roles	array
returns	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
returns	void

setScopes($scopes)

tWithScopes.php:76

function setScopes(array|string $scopes): bool

$scopes	array \| string
returns	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`

$value	string
returns	bool

updateClientFlag($flag, $value)

tClient.php:47

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

$flag	int
$value = true	bool
returns	bool

verifySecret($pwd)

tClient.php:38

function verifySecret(?string $pwd): bool

$pwd	null \| string
returns	bool

Inherited members (114)

	Constants	Declared by	Description
	`FLAG_CHANGED`	iEntity
	`FLAG_CREATED`	iEntity
	`FLAG_FIRST_CONNECTION`	iClient
	`FLAG_IGNORE_CHANGE`	iEntity
	`FLAG_IGNORE_ENTITY`	iEntity
	`FLAG_OPACIFY`	iEntity
	`FLAG_REMOVED`	iEntity
	`FLAG_RESET_SECRET`	iClient
	`FLAG_USER_DEFINED`	iClient

Properties	Declared by	Description
`ArrayProperties`	aEntity
`changes`	aEntity
`collection`	Entity
`ctime`	Entity
`errors`	aEntity
`flags`	aEntity
`id`	Entity	identifier in collection
`label`	Entity	short name
`links`	aEntity
`mtime`	Entity
`SearchProperties`	aEntity
`status`	aEntity
`title`	Entity	long name

Methods	Declared by	Description
`addFlags($flags)`	aEntity
`addLink($link)`	aEntity	Append a link.
`archive()`	aEntity	This function is called to 'delete' the entity.
`ArrayProperties()`	aEntity	Build (once per class, then cached in the static `$ArrayProperties` array) the list of every #[ArrayProperty] declared on this class, its parent classes, and the traits they use -- by reflection…
`ArrayProperty($name)`	aEntity
`CheckData($data, $errors)`	aEntity	Check data before it touches any entity: would an entity made from $data be valid?
`clearChanges()`	aEntity	Reset change tracking: clears `iEntity::FLAG_CHANGED` and forgets every recorded change.
`compareTo($value)`	aEntity	Compare value
`conversionError($key, $e)`	aEntity	The error recorded for a value that could not be set at all (usually: it could not be converted to its property's type), in the same form as a validation error.
`Copy($entity, $properties)`	Entity	Build a new entity from $entity's own stored data (a duplicate, minus its id -- so saving it creates a genuinely new record -- in the same collection).
`debugName()`	aEntity
`get($path, $default)`	aEntity	Read a (possibly nested) value by json-path, e.g.
`getArrayProperty($key, $isRef, $store)`	aEntity	Read a single array property's current value, through its getter (a direct property, a path alias, or a method).
`getChanges($asArray, $store)`	aEntity
`getCollection()`	Entity
`getCtime()`	Entity
`getErrors()`	aEntity
`getFlags()`	aEntity
`getId()`	Entity
`getLabel()`	Entity
`getLinks()`	aEntity
`getLinksByRel($rels, $all)`	aEntity	Get a list of Reference that have a specific relationship.
`getMetadata()`	aEntity
`getMtime()`	Entity
`getRepository()`	Entity
`getStatus()`	aEntity
`getTitle()`	Entity
`getView()`	aEntity
`hasChanged($keys)`	aEntity
`hasFlags($flags, $strict)`	aEntity
`hasStatusChanged()`	aEntity
`HiddenPath($path)`	aEntity	The hidden property (`ArrayProperty::isHidden`) a json-path goes through, known from the declared types alone: of this class, or of a class a property on the way may hold -- every class of its t…
`ignore()`	Entity	Ignore everything about this entity: discard its pending changes and flag it so it's skipped by future commits (`aRepository::onCommit`).
`ignoreChanges($value)`	aEntity	Temporarily suppress `markChanged` (used e.g.
`isActive()`	aEntity
`isArchive()`	aEntity
`isArrayPropertySet($key, $store)`	Entity	Same as `aEntity::isArrayPropertySet`, but 'ctime'/'mtime' are never reported as "set" (they're always present, so listing them adds no information), and neither is 'id' once the entity is alrea…
`isChanged()`	aEntity
`isCreated()`	aEntity
`isDraft()`	aEntity
`isEmpty()`	aEntity
`isFinal()`	aEntity
`isHiddenPath($path)`	aEntity
`isIgnored()`	Entity
`isOpacified()`	aEntity
`isPending()`	aEntity
`isRemoved()`	aEntity
`isSimilar($value)`	Entity
`isUnique()`	aEntity	Tells if an entity has enough information to be unique (at least one unique group has no null)
`isValid()`	aEntity
`isValidated()`	aEntity
`ListClassReferences($onlyStorable)`	aEntity	Get a list of all the classes and their properties that are using references to this class.
`loadArray($data, $coerceOptions, $fromStore)`	Entity	Same as `aEntity::loadArray`, but 'ctime'/'mtime' are never taken from $data: they belong to the server (set when the entity is created, bumped by `markChanged`), and a client sending back th…
`loadFromStore($data)`	Entity	Restore from stored data, setting 'ctime'/'mtime' directly (bypassing their normal setters -- see `setCtime`/`setMtime`, which are read-only via #[ArrayProperty]).
`localName()`	Entity
`loopReferences()`	Entity	Yield all the entities in the repository that have a reference on this one.
`markChanged($keys)`	Entity	Same as `aEntity::markChanged`, also bumping `$mtime` to now -- unless the change itself was to 'ctime'/'mtime' (avoiding infinite recursion via `setMtime`'s own markChanged call).
`mutate($type, $path, $value, $oldValue)`	aEntity	\MMO\core\interfaces\iMutationObserver::mutate -- besides the normal `tArrayProperties::mutate` behavior, walks up $path to find the nearest enclosing aEntity (the mutation may have happened dee…
`offsetExists($key)`	aEntity	\ArrayAccess::offsetExists -- tells whether $key is a declared #[ArrayProperty], not whether it currently holds a non-default value (use `isArrayPropertySet` for that).
`offsetGet($key)`	aEntity	\ArrayAccess::offsetGet
`offsetSet($key, $value)`	aEntity	\ArrayAccess::offsetSet
`offsetUnset($key)`	aEntity	\ArrayAccess::offsetUnset -- equivalent to setting the property to null (its coerced value depends on the property's schema: e.g.
`opacify($value)`	aEntity	Hide this entity's properties from `toArray` output (typically used to redact an entity the current viewer isn't allowed to see the details of, while still letting it be referenced by uid/metadata).
`push($path, $value)`	aEntity	Append a value to a (possibly nested) list property by json-path.
`reload()`	Entity	Reload entity from its repository
`removeFlags($flags)`	aEntity
`removeLink($link)`	aEntity	Remove a link (by identity).
`removePermanently($force)`	Entity	Remove entity from database
`replaceBy($replace, $mergeData)`	Entity	Replace this entity by another one, trying to change all references to this entity to the new one.
`Schema()`	aEntity	The JSON-Schema describing every #[ArrayProperty] of this class (built once and cached by `ArrayProperties`).
`SearchProperty($name)`	aEntity
`set($path, $value)`	aEntity	Write a (possibly nested) value by json-path, creating intermediate structure as needed.
`setArrayProperty($key, $value, $coerceOptions, $ignoreReadonly)`	aEntity	Same as `tArrayProperties::setArrayProperty`, plus: any coercion/validation failure is caught and recorded in `getErrors` (making the entity `isValid()-false`) instead of propagating as an…
`setArrayPropertyOffset($key, $offset, $value, $coerceOptions)`	aEntity	Same as `tArrayProperties::setArrayPropertyOffset`, plus: when pushing (offset === null) a new entity onto a list property, if an existing item is `isSimilar` to the new value, that item's of…
`setCollection($collection, $removeFromCollection)`	Entity	Move this entity to (or out of, if null) a collection.
`setCtime($date, $force)`	Entity	Set creation time
`setId($id)`	Entity	Set the id, re-registering this entity in its `$collection` under the new id (`Collection`'s entities are keyed by id).
`setLinks($links)`	aEntity	Replace every link with $links.
`setMtime($date, $force)`	Entity	Set modification time
`setStatus($status)`	aEntity
`store()`	aEntity	Export all array properties with `store` set to true.
`test($filter)`	aEntity
`toArray($fields, $flatten, $recursive)`	aEntity	Same as `tArrayProperties::toArray`, except an `isOpacified` entity always exports only its 'uid' and 'metadata' (its other properties are hidden from output).
`toLink($attributes)`	aEntity
`traitMutate($type, $path, $value, $oldValue)`	aEntity	\MMO\core\interfaces\iMutationObserver::mutate -- reacts to a mutation that happened deep inside one of this object's array properties (e.g.
`traitSetArrayProperty($key, $value, $coerceOptions, $fromStore)`	aEntity	Set array property
`traitSetArrayPropertyOffset($key, $offset, $value, $coerceOptions)`	aEntity	Set/push a value into an array property
`traitToArray($fields, $flatten, $recursive)`	aEntity	Export fields to an array.
`uid()`	Entity
`validate($errors)`	aEntity	Validate this entity: its current values against its own `tArrayProperties::Schema`, plus every value that could not even be set -- one that could not be converted to its property's type never r…
`View()`	aEntity
`__construct($data, $collection)`	Entity