MMOframework
Pourquoi l'IA Playground Bibliothèques Documentation Rechercher Agence
FR EN
Index

OAuthShellController

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

class

OAuthShellController

OAuthShellController.php:15

mmo.oauth's commands on the application's command line. In dev mode, the bootstrap adds this controller to mmo.core's AdminController (AdminController::$commands), so php admin.php agent-login answers without the application listing it in its routes.

class MMO\oauth\controllers\OAuthShellController extends MMO\core\classes\aShellController
Espace de noms
MMO\oauth\controllers
Étend
aShellController

Index

createAgentLogin($username, $as, $ttl, $base, $redirect)A signed access token for $username, and the link that logs a browser in with it: login?token= is the route the password recovery already uses, so an AI agent testing a local deployment opens o…
route_agentLogin($route)Print createAgentLogin's link and header, or answer them as json with -m.

Méthodes2

createAgentLogin($username, $as, $ttl, $base, $redirect)

OAuthShellController.php:31

A signed access token for $username, and the link that logs a browser in with it: login?token= is the route the password recovery already uses, so an AI agent testing a local deployment opens one url instead of typing a password into the login form.

function createAgentLogin( string $username, ?string $as = null, string $ttl = 'PT8H', ?string $base = null, string $redirect = '' ): arrayDevelopment only, as it hands out a session of any user without a password.
$usernamestringthe user to log in
$as = nullnull | stringanother user to log in as, which $username needs sudo.switchAccount for
$ttl = 'PT8H'stringhow long the token lives, an ISO 8601 period
$base = nullnull | stringthe site's url ({siteurl} when null): the command line cannot know the one Apache serves
$redirect = ''stringthe page the login redirects to, relative to $base
retournearraystring, header: string, user: string, expires: string}
lèveif the application is not in dev mode, or the user cannot be found or switched to
$this->createAgentLogin('god', base: 'http://localhost/my.oviepro')['url']; // http://localhost/my.oviepro/login?token=eyJ...

route_agentLogin($route)

OAuthShellController.php:67

Print createAgentLogin's link and header, or answer them as json with -m.

#[MMO\core\attributes\Command([['const' => 'agent-login']], 'dev only: a link logging a browser in as a user, for an AI agent to test the pages')] function route_agentLogin(MMO\core\server\Route $route): void
$routeRoute--user (required), --as, --ttl (PT8H), --url (the site's url), --redirect
retournevoid
php admin.php agent-login --user=god --url=http://localhost/my.oviepro -m
Membres hérités (65)
ConstantesDéclaré parDescription
ALERTiLogLevelAlert: Action must be taken immediately.
ALLiLogLevelMask for all
ALL_PLUSiLogLeveldebug everything
BACKTRACEiLogLevel
CRITICALiLogLevelCritical: Critical conditions.
DEBUGiLogLevelDebug: Detailed debug information.
DEEPiLogLeveldebug everything with arguments
EMERGENCYiLogLevelEmergency: System is unusable.
ERRORiLogLevelError: Runtime errors that do not require immediate action but should typically be logged and monitored.
ERROR_PLUSiLogLevelMask for all error
FATALiLogLevelMask for all fatal error
INFOiLogLevelInfo: Interesting events.
INFO_PLUSiLogLevelMask for all errors/warning/notices/info
MEMORYiLogLevelinclude backtrace object
NOTICEiLogLevelNotice: Normal but significant events.
NOTICE_PLUSiLogLevelMask for all errors/warning/notices/info
TRACEiLogLevelinclude backtrace as origins
WARNINGiLogLevelWarning: Exceptional occurrences that are not errors.
WARNING_PLUSiLogLevelMask for all errors and warnings
PropriétésDéclaré parDescription
interactiveaShellController
verbosityaModule
MéthodesDéclaré parDescription
alert($message, $context)aModuleAction must be taken immediately.
backtraces($message, $context)aModuleForce-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).
callInteractiveCommand($route, $cmd)aShellControllerInvoke the method behind $cmd (looked up via InteractiveCommands), or print an "unknown command" message if $cmd doesn't match any registered interactive command.
Configure($config)aModuleMerge $config into this module's configuration in the shared Configuration.
critical($message, $context)aModuleCritical conditions. No-op if CRITICAL is currently filtered out by the verbosity mask.
debug($message, $context)aModuleDetailed debug information.
debugName()aModuleHuman-readable identifier used as the default {origin} in this instance's log messages.
DefaultConfig()aModuleThe config a module starts from before anything loaded via Configuration is merged in.
emergency($message, $context)aModuleSystem is unusable. No-op if EMERGENCY is currently filtered out by the verbosity mask.
error($message, $context)aModuleRuntime errors that do not require immediate action but should typically be logged and monitored.
ExtractRoutes($config)aControllerExtract all the APIRoute from this class, regardless of the fact they are registered in the application
getVerbosity()aModule
hasOtherCommand($route)aShellControllerTell if another shell controller matched a command of its own (anything but its index) for $route
HasRoutes()aControllerTells if any APIRoute are registered in the application
index($route)aShellControllerThe built-in interactive REPL: shows the splash + command list, then loops reading a command name (with autocompletion, via ask) and dispatching it through callInteractive…
info($message, $context)aModuleInteresting 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.
InteractiveCommands()aShellControllerEvery #[InteractiveCommand(...)]-decorated method on this class, keyed by its command name.
IsShared()aModule
Link($method, $data)aControllerBuild a Link (URL + label/icon/description/title, taken from the route's APIRoute metadata) for a registered route.
log($level, $message, $context)aModuleLogs with an arbitrary level.
notice($message, $context)aModuleNormal 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.
onRoute($route)aShellControllerSame as aController::onRoute, plus: forces the response to shell/text output, and decides whether to fall back to the built-in interactive index command -- it stays active only if this is…
Route($method)aControllerGet a registered APIRoute WARNING: if this class was not registered in the application, it will return null.
Routes()aControllerGet a list of registered APIRoutes (from this class) in the application WARNING: if this class was not registered in the application, it will return an empty array.
route_help($route)aShellControllerPrint CLI usage for every 'SHELL'-method route on this controller: the command line to type, each argument's name/required-ness/description, and any declared usage examples.
serialize($path, $serializer)aModule\MMO\core\interfaces\iSerializable::serialize -- exports every property (via
setInteractive($interactive)aShellController
setVerbosity($verb)aModuleSet the current verbosity mask, replacing whatever it was before.
Shared()aModuleGet the shared instance, creating (and configuring) it on first call.
showInteractiveCommands()aShellControllerPrint the list of available interactive commands, plus the [ENTER]/[ESC]/q hints.
showSplash()aShellControllerPrint the application's icon/version/title/description banner.
testVerbosity($level)aModuleTest whether a given level (or set of levels) is currently enabled by this instance's verbosity mask.
traitUnshare($serialize)aModuleRemove 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)aModuleLike tSingleton::Unshare, but also disconnects this module's instance from every event it was listening to (via Event::DisconnectListeners) before dropping it.
Url($method, $data)aControllerBuild the URL for a registered route, filling in any {placeholder} from $data.
warning($message, $context)aModuleExceptional occurrences that are not errors.
__construct($config)aModuleprotected constructor, so it is not possible to do new Module(...) called by the serialization process just before being injected with data.
__wakeup()aControllerCalled automatically right after the controller's shared instance is built (aModule::unserialize): registers onRoute as a Route listener with a low priority (-10), so it…