ScopesList

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

class

ScopesList

Event to request the list of existing scopes: what the roles' editor offers (AccessController::routeScopesCatalog).

class MMO\oauth\events\ScopesList extends MMO\core\events\SingleSignal

Espace de noms: MMO\oauth\events
Étend: SingleSignal

Besides the scopes themselves, a listener says: - the actions checked under a scope ([`addAction`](https://mmoframework.fr/fr/documentation/mmo.oauth/php/events/ScopesList.md#scopeslist-addaction)): `data.main.orders#edit` only means something because the data api checks `#edit` under `data`. A listed scope holding a `#` declares its action too (`dev.boards#write`); - the scopes whose children are ids, not listed one by one ([`openScope`](https://mmoframework.fr/fr/documentation/mmo.oauth/php/events/ScopesList.md#scopeslist-openscope)): `data.main.orders.{id}`; - the scopes a page needs besides its own ([`addNeeds`](https://mmoframework.fr/fr/documentation/mmo.oauth/php/events/ScopesList.md#scopeslist-addneeds)): `pages.settings` needs `admin`.

ScopesList::AddListener(function (ScopesList $request) { $request->addScope('shop', 'Access to the shop'); $request->addAction('shop', 'refund', 'Refund an order'); // shop.orders#refund is checked by the shop });

Index

	actions
	needs
	open
	addAction($scope, $action, $text)	Declare an action checked under $scope and every scope below it: a rule `{scope}#{action}` means something
	addNeeds($scope, $scopes)	Say that $scope also needs $scopes: a page whose folder asks `"scopes": "admin"`
	addScope($id, $text)
	addScopes($scopes)
	getActions()
	getNeeds()
	getOpenScopes()
	getScopes()
	getUser()
	hasScope($id)
	openScope($scope)	Declare that $scope's children are ids (`data.main.orders.{id}`): a rule on one of them is not unknown
	__construct()

Propriétés3

actions

protected array $actions = []

Type: array

needs

protected array $needs = []

Type: array

open

protected array $open = []

Type: array

Méthodes12

addAction($scope, $action, $text)

ScopesList.php:67

Declare an action checked under $scope and every scope below it: a rule {scope}#{action} means something

function addAction(string $scope, string $action, string $text): void

$scope	string	`data`, `edms.files`
$action	string	without its `#`
$text	string	what it allows, translated
retourne	void

$request->addAction('data', 'edit', I18n::_('Change an entity'));

addNeeds($scope, $scopes)

ScopesList.php:103

Say that $scope also needs $scopes: a page whose folder asks "scopes": "admin"

function addNeeds(string $scope, string $scopes): void

$scope	string
$scopes	string	space-separated, all needed
retourne	void

$request->addNeeds('pages.settings', 'admin');

addScope($id, $text)

ScopesList.php:48

function addScope(string $id, string $text): void

$id	string
$text	string
retourne	void

addScopes($scopes)

ScopesList.php:52

function addScopes(array $scopes): void

$scopes	array
retourne	void

getActions()

ScopesList.php:75

function getActions(): array

retourne array array<string, string>> scope => action => text: those added and those of the scopes listed with a # (dev.boards#write)

getNeeds()

ScopesList.php:109

function getNeeds(): array

retourne

array

string> scope => the scopes, space-separated, it also needs

getOpenScopes()

ScopesList.php:94

function getOpenScopes(): array

retourne

array

the scopes whose children are ids

getScopes()

ScopesList.php:56

function getScopes(): array

retourne

array

getUser()

ScopesList.php:40

function getUser(): ?MMO\oauth\interfaces\iUser

retourne

null | iUser

hasScope($id)

ScopesList.php:44

function hasScope(string $id): bool

$id	string
retourne	bool

openScope($scope)

ScopesList.php:89

Declare that $scope's children are ids (data.main.orders.{id}): a rule on one of them is not unknown

function openScope(string $scope): void

$scope	string
retourne	void

$request->openScope('data.main.orders');

__construct()

ScopesList.php:35

protected function __construct()

Membres hérités (21)

	Propriétés	Déclaré par	Description
	`Listeners`	Event
	`origin`	Event
	`returnValue`	Signal

Méthodes	Déclaré par	Description
`AddListener($handler, $order)`	Event	Register a listener directly (as opposed to `ConnectListeners`'s attribute-based discovery).
`ConnectListeners($obj)`	Event	Scan $obj's methods for #[Listen(EventClass::class)] attributes and register each one as a listener on the matching event class.
`DisconnectListeners($obj)`	Event	Undo a previous `ConnectListeners`: removes every listener that `connect` had registered for $obj on this event class.
`dispatch()`	Event	Invoke every `GetListeners` listener with $this.
`GetListeners()`	Event	Collect every listener for this class, including those registered on its parent classes (so a subclass event is also caught by listeners of its parent event), sorted by ascending $order (ties keep …
`getOrigin()`	Event
`getReturn()`	Signal
`HasListener($handler)`	Event
`hasReturn()`	Signal
`Instantiate($config)`	SingleSignal	(Re)create the shared instance immediately, configured with $config merged into the class's existing config.
`IsShared()`	SingleSignal
`RemoveListener($handler)`	Event	Remove the last added handler from the listeners.
`Send($args)`	SingleSignal	Send this signal, but only the FIRST time it's ever called: subsequent calls (with any, even different, $args) just return the same already-dispatched instance, unchanged.
`SetListenerOrder($handler, $order)`	Event	Change the order of an already-registered listener, whether added directly via `AddListener` or indirectly via `ConnectListeners` (which also stores its `[$obj, $methodName]` callables here).
`setReturn($value, $stop)`	Signal
`Shared()`	SingleSignal	Get the shared instance, creating (and configuring) it on first call.
`Unshare($serialize)`	SingleSignal	Remove the shared instance, so the next `Shared()` call creates a fresh one.
`Value($args)`	SingleSignal