aShellController

MMO\core\classes · 1 symbol · generated 30 Sep 2026

class

aShellController

Base controller for a CLI shell application: routes matched with method 'SHELL' (declared via #[Command(...)]) become subcommands, e.g. `php script.php mycommand --arg=value`. If the script is run with NO matching subcommand, the controller falls back to its built-in [`index`](https://mmoframework.fr/documentation/mmo.core/php/classes/aShellController.md#ashellcontroller-index) "interactive mode" -- a REPL that lists every #[InteractiveCommand(...)]-decorated method and lets the user pick one by name.

abstract class MMO\core\classes\aShellController extends MMO\core\classes\aController

Namespace: MMO\core\classes
Extends: aController

class MyShell extends aShellController { #[Command(['name' => 'string'], 'say hello')] public function routeHello(Route $route): void {\MMO\core\shell\say("hello {$route->get('name')}");} } // `php script.php routeHello --name=Marc` prints "- hello Marc"

Index

	interactive
	callInteractiveCommand($route, $cmd)	Invoke the method behind $cmd (looked up via `InteractiveCommands`), or print an "unknown command" message if $cmd doesn't match any registered interactive command.
	index($route)	The built-in interactive REPL: shows the splash + command list, then loops reading a command name (with autocompletion, via `ask`) and dispatching it through `callInteractive…`
	InteractiveCommands() static	Every #[InteractiveCommand(...)]-decorated method on this class, keyed by its command name.
	onRoute($route)	Same 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_help($route)	Print 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.
	setInteractive($interactive)
	showInteractiveCommands()	Print the list of available interactive commands, plus the [ENTER]/[ESC]/q hints.
	showSplash()	Print the application's icon/version/title/description banner.

Properties1

interactive

protected bool $interactive = false

Type: bool

Methods8

callInteractiveCommand($route, $cmd)

aShellController.php:110

Invoke the method behind $cmd (looked up via InteractiveCommands), or print an "unknown command" message if $cmd doesn't match any registered interactive command.

function callInteractiveCommand(MMO\core\server\Route $route, string $cmd): void

$route	Route
$cmd	string
returns	void

index($route)

aShellController.php:127

The built-in interactive REPL: shows the splash + command list, then loops reading a command name (with autocompletion, via ask) and dispatching it through callInteractiveCommand until the user types 'q' or presses ESC.

#[MMO\core\attributes\Command([], 'interactive mode', order: 1000)] function index(MMO\core\server\Route $route): void

$route	Route
returns	void

InteractiveCommands()

staticaShellController.php:68

Every #[InteractiveCommand(...)]-decorated method on this class, keyed by its command name. Computed once (via reflection over #[APIRoute]-family attributes, see tWithRoutes::ExtractRoutes) and cached in a static local variable.

static function InteractiveCommands(): array

returns

array

onRoute($route)

aShellController.php:48

Same 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 the ONLY matching route for the current invocation (i.e. no explicit subcommand was given).

function onRoute(MMO\core\server\Route $route): bool

None of that applies to an http request: a shell controller may also carry an #[APIRoute] of its own ([`AdminController::routeServerInfo`](https://mmoframework.fr/documentation/mmo.core/php/controllers/AdminController.md#admincontroller-routeserverinfo)), and a 'SHELL|**' command never matches a GET -- so the only route that got here is the api one, which would otherwise be answered as shell text and, being alone, would put the controller in interactive mode on a web server.

$route	Route
returns	bool

route_help($route)

aShellController.php:156

Print 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.

#[MMO\core\attributes\InteractiveCommand('help', 'show help')] function route_help(MMO\core\server\Route $route): void

$route	Route
returns	void

setInteractive($interactive)

aShellController.php:29

function setInteractive(bool $interactive)

$interactive	bool
returns

showInteractiveCommands()

aShellController.php:95

Print the list of available interactive commands, plus the [ENTER]/[ESC]/q hints.

function showInteractiveCommands(): void

returns

void

showSplash()

aShellController.php:84

Print the application's icon/version/title/description banner.

function showSplash(): void

returns

void

Inherited members (55)

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.
`ExtractRoutes($config)`	aController	Extract all the APIRoute from this class, regardless of the fact they are registered in the application
`getVerbosity()`	aModule
`HasRoutes()`	aController	Tells if any APIRoute are registered in the application
`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
`Link($method, $data)`	aController	Build a `Link` (URL + label/icon/description/title, taken from the route's APIRoute metadata) for a registered route.
`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`.
`Route($method)`	aController	Get a registered APIRoute WARNING: if this class was not registered in the application, it will return null.
`Routes()`	aController	Get 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.
`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.
`Url($method, $data)`	aController	Build the URL for a registered route, filling in any `{placeholder}` from $data.
`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.
`__wakeup()`	aController	Called 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…