tClient

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

trait

tClient

Model for client

trait MMO\oauth\classes\tClient use MMO\oauth\classes\tWithRoles

Namespace: MMO\oauth\classes
Uses traits: tWithRoles

Index

	clientFlags	Client flags
	config
	roles	Roles associated with the token.
	scopes
	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
	getConfig()
	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.
	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).
	markChanged($keys) abstract	Record that properties changed (`scopes`), so they are saved: `aEntity::markChanged`
	removeRole($role)
	scopesText($separator, $true, $false)
	setRoles($roles)
	setScope($uid, $value)	Set the scope's value
	setScopes($scopes)
	updateClientFlag($flag, $value)
	verifySecret($pwd)

Properties4

clientFlags

Client flags

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

Type: int

config

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

Type: array

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

Methods28

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

getConfig()

tClient.php:71

function getConfig(): array

returns

array

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>

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

markChanged($keys)

abstracttWithScopes.php:25

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

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

...$keys	string
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

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

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