iClient

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

interface

iClient

Any object that can exchange credential with an oauth server

interface MMO\oauth\interfaces\iClient extends MMO\core\interfaces\iEntity, MMO\oauth\interfaces\iScopeProvider

Namespace: MMO\oauth\interfaces
Implements: iEntity, iScopeProvider

Index

	FLAG_FIRST_CONNECTION
	FLAG_RESET_SECRET
	FLAG_USER_DEFINED
	getClientRedirectUri() abstract	Returns the registered redirect URI (as a string).
	hasClientFlag($flag) abstract
	isConfidential() abstract	Returns true if the client is confidential.
	updateClientFlag($flag, $value) abstract
	verifySecret($secret) abstract	Validates the redirect uri.

Constants3

FLAG_FIRST_CONNECTION

const FLAG_FIRST_CONNECTION = 1

FLAG_RESET_SECRET

const FLAG_RESET_SECRET = 2

FLAG_USER_DEFINED

const FLAG_USER_DEFINED = 4

Methods5

getClientRedirectUri()

abstractiClient.php:24

Returns the registered redirect URI (as a string).

abstract function getClientRedirectUri(): string

returns

string

hasClientFlag($flag)

abstractiClient.php:15

abstract function hasClientFlag(int $flag): bool

$flag	int
returns	bool

isConfidential()

abstractiClient.php:32

Returns true if the client is confidential.

abstract 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

updateClientFlag($flag, $value)

abstractiClient.php:17

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

$flag	int
$value = true	bool
returns	bool

verifySecret($secret)

abstractiClient.php:44

Validates the redirect uri.

abstract function verifySecret(?string $secret): bool

$secret	null \| string
returns	bool	Return true if valid, false otherwise

Inherited members (55)

	Constants	Declared by	Description
	`FLAG_CHANGED`	iEntity
	`FLAG_CREATED`	iEntity
	`FLAG_IGNORE_CHANGE`	iEntity
	`FLAG_IGNORE_ENTITY`	iEntity
	`FLAG_OPACIFY`	iEntity
	`FLAG_REMOVED`	iEntity

Methods	Declared by	Description
`addFlags($flags)`	iEntity
`applyScopes($scopes, $set)`	iScopeProvider
`archive()`	iEntity
`ArrayProperties()`	iArrayProperties
`ArrayProperty($name)`	iArrayProperties
`blameScope($uid)`	iScopeProvider
`clearChanges()`	iEntity
`compareTo($value)`	iComparable
`debugName()`	iEntity
`get($path, $default)`	iEntity
`getChanges($asArray, $store)`	iEntity
`getCollection()`	iEntity
`getErrors()`	iEntity
`getFlags()`	iEntity
`getId()`	iEntity
`getRepository()`	iEntity
`getScopes()`	iScopeProvider	Get all the scopes.
`getStatus()`	iEntity
`getTitle()`	iEntity
`getUniqueName()`	iScopeProvider	Get the unique name for this scope provider
`hasStatusChanged()`	iEntity
`HiddenPath($path)`	iArrayProperties
`isAllowed($uids)`	iScopeProvider	Test if scopes are allowed
`isAnyAllowed($uids)`	iScopeProvider
`isArchive()`	iEntity
`isChanged()`	iEntity
`isCreated()`	iEntity
`isFinal()`	iEntity
`isRemoved()`	iEntity
`isValid()`	iEntity
`loadArray($data, $coerceOptions, $fromStore)`	iEntity
`loadFromStore($data)`	iEntity	Load data as read from storage: not recorded as a change.
`localName()`	iEntity	Get the local name (collection name and this id) in the current repository
`markChanged($keys)`	iEntity
`mutate($type, $path, $value, $oldValue)`	iMutationObserver
`offsetExists($offset)`	ArrayAccess
`offsetGet($offset)`	ArrayAccess
`offsetSet($offset, $value)`	ArrayAccess
`offsetUnset($offset)`	ArrayAccess
`removeFlags($flags)`	iEntity
`removePermanently()`	iEntity	Remove it for good: only an archived entity can be.
`Schema()`	iSchemaProvider
`setArrayPropertyOffset($key, $offset, $value, $coerceOptions)`	iEntity
`setStatus($status)`	iEntity
`store()`	iEntity
`test($filter)`	iEntity
`toArray($fields)`	iArrayProperties
`toLink($attributes)`	iEntity
`uid()`	iIdentifiable	Get the unique identifier