ClientRepository

MMO\oauth · 1 symbol · generated 27 Oct 2026

class

ClientRepository

User storage interface.

class MMO\oauth\ClientRepository extends MMO\core\classes\aModule

Namespace: MMO\oauth
Extends: aModule

Index

	accessTokens
	accessTokenTTL
	codeDefaultRoles
	collections
	defaultRoles
	fields
	refreshTokens
	refreshTokenTTL
	roles
	userClass
	addCollection($collection, $name, $fields)
	createAccessToken($client, $ttl, $actor)
	createClient($class, $type, $secret, $expires)
	createClientTokens($client, $tokenTTL, $refreshTTL, $actor)	Create a token and its refresh token
	createRefreshToken($token, $ttl)
	createUser($username, $password, $email, $data, $class, $roles, $flags)
	findUser($data)
	findUsersIgnoringCase($field, $value)	The accounts whose $field (`username`, `email`) is $value whatever the case, in every collection of accounts (each with its field override): an address is typed in any case, Google gives it in lowe…
	getByCredentials($username, $password)	Get a user entity.
	getByEmail($email)
	getByUsername($username)	The account of a username: an active one first, an archived account keeping its username (a double archived by `duplicate-accounts`, my.oviepro #351) -- the first found was the one whose password w…
	getClient($id)	Get a client.
	getCollections()
	getEmailField($collection)
	getEntities()
	getFieldOverride($collection, $field)
	getIdField($collection)
	getRole($name)
	getUsernameField($collection)
	getUsernameHolder($user)	The other account that holds $user's username, whatever the case, an archived one included: a username is one account's, the one a password or a Google sign-in (`GoogleAPI::fi…`
	isUsernameAvailable($username)
	isUsernameChanged($user)
	loadAccessToken($jwt)	Load access token from a JWT
	prepareData($collection, $data)
	setCollections($collections)	Set collection for this repository
	setFieldOverride($collection, $field, $alias)	Set the fields to lookup into to find a user.
	setIdField($collection, $field)
	setRole($name, $description, $allowedScopes, $disallowedScopes, $allowSelfEdit)
	setUsernameField($collection, $field)

Properties10

accessTokens

MMO\core\entities\Collection $accessTokens

Type: Collection

accessTokenTTL

string $accessTokenTTL = 'P1D'

Type: string

codeDefaultRoles

string $codeDefaultRoles = ''

Type: string

collections

#[MMO\core\attributes\Serialize(unserialize: 'setCollections')] protected array $collections = []

Type: array

defaultRoles

string $defaultRoles = ''

Type: string

fields

protected array $fields = []

Type: array

refreshTokens

MMO\core\entities\Collection $refreshTokens

Type: Collection

refreshTokenTTL

string|false $refreshTokenTTL = false

Type: string | false

roles

MMO\core\entities\Collection $roles

Type: Collection

userClass

string $userClass = 'MMO\\oauth\\entities\\User'

Type: string

Methods29

addCollection($collection, $name, $fields)

ClientRepository.php:78

function addCollection( MMO\core\interfaces\iCollection $collection, ?string $name = null, array $fields = [] ): string|int

$collection	iCollection
$name = null	null \| string
$fields = []	array
returns	string \| int

createAccessToken($client, $ttl, $actor)

ClientRepository.php:380

function createAccessToken( MMO\oauth\interfaces\iClient $client, DateTimeInterface|string|null $ttl = null, ?MMO\oauth\interfaces\iUser $actor = null ): MMO\oauth\entities\AccessToken

$client	iClient
$ttl = null	DateTimeInterface \| string \| null	can be a period started with 'P'
$actor = null	null \| iUser	who opens this session in $client's name (`sudo.switchAccount`), `aToken::getActor`
returns	AccessToken

createClient($class, $type, $secret, $expires)

ClientRepository.php:176

function createClient(string $class, int $type, ?string $secret = null, ?int $expires = null): MMO\oauth\interfaces\iClient

$class	string
$type	int
$secret = null	null \| string
$expires = null	null \| int
returns	iClient

createClientTokens($client, $tokenTTL, $refreshTTL, $actor)

ClientRepository.php:419

Create a token and its refresh token

function createClientTokens( MMO\oauth\interfaces\iClient $client, DateTimeInterface|string|null $tokenTTL = null, DateTimeInterface|string|null $refreshTTL = null, ?MMO\oauth\interfaces\iUser $actor = null ): MMO\oauth\entities\AccessToken|MMO\oauth\entities\RefreshToken

$client	iClient
$tokenTTL = null	DateTimeInterface \| string \| null	can be a period started with 'P'
$refreshTTL = null	DateTimeInterface \| string \| null	can be a period started with 'P'
$actor = null	null \| iUser	who opens this session in $client's name (`sudo.switchAccount`), `aToken::getActor`
returns	AccessToken \| RefreshToken

createRefreshToken($token, $ttl)

ClientRepository.php:392

function createRefreshToken( MMO\oauth\entities\AccessToken $token, DateTimeInterface|string|null $ttl = null ): MMO\oauth\entities\RefreshToken

$token	AccessToken
$ttl = null	DateTimeInterface \| string \| null
returns	RefreshToken

createUser($username, $password, $email, $data, $class, $roles, $flags)

ClientRepository.php:298

function createUser( string $username, string $password, string $email, array $data = [], ?string $class = null, array|string $roles = [], int $flags = MMO\oauth\interfaces\iClient::FLAG_FIRST_CONNECTION ): MMO\oauth\interfaces\iUser

$username	string
$password	string
$email	string
$data = []	array
$class = null	null \| string	if null use default userClass
$roles = []	array \| string	if string, list of role separated by a space
$flags = MMO\oauth\interfaces\iClient::FLAG_FIRST_CONNECTION	int
returns	iUser

findUser($data)

ClientRepository.php:196

function findUser(array $data): ?MMO\oauth\interfaces\iUser

$data	array
returns	null \| iUser

findUsersIgnoringCase($field, $value)

ClientRepository.php:246

The accounts whose $field (username, email) is $value whatever the case, in every collection of accounts (each with its field override): an address is typed in any case, Google gives it in lowercase. A collection whose accounts have no such field (users without an email) is not searched.

function findUsersIgnoringCase(string $field, string $value): array

$field	string	the field, as the accounts of the default collection name it
$value	string	the whole value, not a pattern
returns	array	the accounts, archived ones included

$clients->findUsersIgnoringCase('username', 'Ada@Example.com'); // the account `ada@example.com`

getByCredentials($username, $password)

ClientRepository.php:225

Get a user entity.

function getByCredentials(string $username, string $password): ?MMO\oauth\interfaces\iUser

$username	string
$password	string
returns	null \| iUser

getByEmail($email)

ClientRepository.php:213

function getByEmail(string $email): ?MMO\oauth\interfaces\iUser

$email	string
returns	null \| iUser

getByUsername($username)

ClientRepository.php:209

The account of a username: an active one first, an archived account keeping its username (a double archived by duplicate-accounts, my.oviepro #351) -- the first found was the one whose password was checked, and an archived one cannot sign in.

function getByUsername(string $username): ?MMO\oauth\interfaces\iUser

$username	string
returns	null \| iUser

$clients->getByUsername('ada'); // the active account `ada`, else the archived one

getClient($id)

ClientRepository.php:166

Get a client.

function getClient(mixed $id): ?MMO\oauth\interfaces\iClient

$id	mixed	The client's identifier
returns	null \| iClient

getCollections()

ClientRepository.php:36

function getCollections(): array

returns

array

getEmailField($collection)

ClientRepository.php:143

function getEmailField(MMO\core\interfaces\iCollection|string|int $collection): string

$collection	iCollection \| string \| int
returns	string

getEntities()

ClientRepository.php:40

function getEntities(): array

returns

array

getFieldOverride($collection, $field)

ClientRepository.php:117

function getFieldOverride(MMO\core\interfaces\iCollection|string|int $collection, string $field): ?string

$collection	iCollection \| string \| int
$field	string
returns	null \| string

getIdField($collection)

ClientRepository.php:131

function getIdField(MMO\core\interfaces\iCollection|string|int $collection): string

$collection	iCollection \| string \| int
returns	string

getRole($name)

ClientRepository.php:368

function getRole(string $name): ?MMO\core\interfaces\iEntity

$name	string
returns	null \| iEntity

getUsernameField($collection)

ClientRepository.php:139

function getUsernameField(MMO\core\interfaces\iCollection|string|int $collection): string

$collection	iCollection \| string \| int
returns	string

getUsernameHolder($user)

ClientRepository.php:267

The other account that holds $user's username, whatever the case, an archived one included: a username is one account's, the one a password or a Google sign-in (GoogleAPI::findUserByEmail) finds.

function getUsernameHolder(MMO\oauth\interfaces\iUser $user): ?MMO\oauth\interfaces\iUser

$user	iUser
returns	null \| iUser	that account, null if the username is free (or empty)

$clients->getUsernameHolder($ada); // null, unless another account is `ada@example.com` (or `ADA@...`)

isUsernameAvailable($username)

ClientRepository.php:233

function isUsernameAvailable(string $username): bool

$username	string
returns	bool

isUsernameChanged($user)

ClientRepository.php:281

function isUsernameChanged(MMO\oauth\interfaces\iUser $user): bool

$user	iUser
returns	bool	whether $user's username is changed (not created): a field override of its collection is read

$clients->isUsernameChanged($ada); // true after `$ada->loadArray(['username' => 'new@x.com'], [], true)`

loadAccessToken($jwt)

ClientRepository.php:433

Load access token from a JWT

function loadAccessToken(MMO\oauth\helpers\JWT $jwt): MMO\oauth\entities\AccessToken|MMO\oauth\entities\RefreshToken

$jwt	JWT
returns	AccessToken \| RefreshToken

prepareData($collection, $data)

ClientRepository.php:147

function prepareData(string|int $collection, array ...$data): array

$collection	string \| int
...$data	array
returns	array

setCollections($collections)

ClientRepository.php:60

Set collection for this repository

function setCollections(iterable $collections): void

$collections	iterable	if array, MUST have this field: - collection: {iCollection} - fields: [array<string: string>] - id: {string} the new id field's name - username: {string} - password: {string} - email: {string} - client: {string} - others custom fields
returns	void

setFieldOverride($collection, $field, $alias)

ClientRepository.php:101

Set the fields to lookup into to find a user.

function setFieldOverride( MMO\core\interfaces\iCollection|string|int $collection, string $field, string|false|null $alias ): void

WARNING: these fields MUST be unique in ALL the collections in this repo.

$collection	iCollection \| string \| int
$field	string	the field to use an alias for
$alias	string \| false \| null	the field key to use instead of filed. If null, remove the alias. If false, prevent importing the data
returns	void

setIdField($collection, $field)

ClientRepository.php:127

function setIdField( MMO\core\interfaces\iCollection|string|int $collection, ?string $field = null ): void

$collection	iCollection \| string \| int
$field = null	null \| string
returns	void

setRole($name, $description, $allowedScopes, $disallowedScopes, $allowSelfEdit)

ClientRepository.php:343

function setRole( string $name, string $description, array|string $allowedScopes, string $disallowedScopes = '', bool $allowSelfEdit = true ): MMO\core\interfaces\iEntity

$name	string
$description	string
$allowedScopes	array \| string	if string, list of allowed scopes separated by a space. If array, scopes to use
$disallowedScopes = ''	string	if allowedScopes was a string, these are the disallowed scopes
$allowSelfEdit = true	bool	if false, user with this role cannot change the role scopes
returns	iEntity

setUsernameField($collection, $field)

ClientRepository.php:135

function setUsernameField( MMO\core\interfaces\iCollection|string|int $collection, ?string $field = null ): void

$collection	iCollection \| string \| int
$field = null	null \| string
returns	void

Inherited members (48)

Constants	Declared by	Description
`ALERT`	iLogLevel	Alert: Action must be taken immediately.
`ALL`	iLogLevel	Mask for all
`ALL_PLUS`	iLogLevel	debug everything
`BACKTRACE`	iLogLevel
`CRITICAL`	iLogLevel	Critical: Critical conditions.
`DEBUG`	iLogLevel	Debug: Detailed debug information.
`DEEP`	iLogLevel	debug everything with arguments
`EMERGENCY`	iLogLevel	Emergency: System is unusable.
`ERROR`	iLogLevel	Error: Runtime errors that do not require immediate action but should typically be logged and monitored.
`ERROR_PLUS`	iLogLevel	Mask for all error
`FATAL`	iLogLevel	Mask for all fatal error
`INFO`	iLogLevel	Info: Interesting events.
`INFO_PLUS`	iLogLevel	Mask for all errors/warning/notices/info
`MEMORY`	iLogLevel	include backtrace object
`NOTICE`	iLogLevel	Notice: Normal but significant events.
`NOTICE_PLUS`	iLogLevel	Mask for all errors/warning/notices/info
`TRACE`	iLogLevel	include backtrace as origins
`WARNING`	iLogLevel	Warning: Exceptional occurrences that are not errors.
`WARNING_PLUS`	iLogLevel	Mask for all errors and warnings

	Properties	Declared by	Description
	`verbosity`	aModule

Methods	Declared by	Description
`alert($message, $context)`	aModule	Action must be taken immediately.
`backtraces($message, $context)`	aModule	Force-log a message at INFO level together with a full stack trace/memory snapshot (`iLogLevel::BACKTRACE`), bypassing the verbosity mask entirely (any non-zero verbosity is enough to trigger it).
`Configure($config)`	aModule	Merge $config into this module's configuration in the shared `Configuration`.
`critical($message, $context)`	aModule	Critical conditions. No-op if CRITICAL is currently filtered out by the verbosity mask.
`debug($message, $context)`	aModule	Detailed debug information.
`debugName()`	aModule	Human-readable identifier used as the default `{origin}` in this instance's log messages.
`DefaultConfig()`	aModule	The config a module starts from before anything loaded via `Configuration` is merged in.
`emergency($message, $context)`	aModule	System is unusable. No-op if EMERGENCY is currently filtered out by the verbosity mask.
`error($message, $context)`	aModule	Runtime errors that do not require immediate action but should typically be logged and monitored.
`getVerbosity()`	aModule
`info($message, $context)`	aModule	Interesting events. No-op if INFO is currently filtered out by the verbosity mask.
`Instantiate($config)`	aModule	(Re)create the shared instance immediately, configured with $config merged into the class's existing config.
`IsShared()`	aModule
`log($level, $message, $context)`	aModule	Logs with an arbitrary level.
`notice($message, $context)`	aModule	Normal but significant events.
`offsetExists($key)`	aModule	\ArrayAccess::offsetExists -- tells whether $key is a declared property at all, regardless of whether it is currently readable/writable through array access.
`offsetGet($key)`	aModule	\ArrayAccess::offsetGet -- reads a property directly, unless it has a `#[Serialize(serialize: 'methodName')]` attribute, in which case that zero-argument method is called instead (e.g.
`offsetSet($key, $value)`	aModule	\ArrayAccess::offsetSet -- sets a property directly, unless it has a `#[Serialize(unserialize: 'methodName')]` attribute, in which case that method is called with $value instead (e.g.
`offsetUnset($key)`	aModule	\ArrayAccess::offsetUnset -- equivalent to `$module[$key] = null`.
`serialize($path, $serializer)`	aModule	\MMO\core\interfaces\iSerializable::serialize -- exports every property (via
`setVerbosity($verb)`	aModule	Set the current verbosity mask, replacing whatever it was before.
`Shared()`	aModule	Get the shared instance, creating (and configuring) it on first call.
`testVerbosity($level)`	aModule	Test whether a given level (or set of levels) is currently enabled by this instance's verbosity mask.
`traitUnshare($serialize)`	aModule	Remove the shared instance, so the next `Shared()` call creates a fresh one.
`unserialize($data, $path, $instances)`	aModule	\MMO\core\interfaces\iSerializable::unserialize -- merges $data onto `DefaultConfig`, runs it through the (possibly overridden) constructor, then applies each resulting value to its property (via
`Unshare($serialize)`	aModule	Like `tSingleton::Unshare`, but also disconnects this module's instance from every event it was listening to (via `Event::DisconnectListeners`) before dropping it.
`warning($message, $context)`	aModule	Exceptional occurrences that are not errors.
`__construct($config)`	aModule	protected constructor, so it is not possible to do `new Module(...)` called by the serialization process just before being injected with data.