Index

TestController

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

class

TestController

TestController.php:30

The test runner's page: every installed package that ships a test suite, and a button to run each one.

class MMO\core\controllers\TestController extends MMO\core\classes\aController
Namespace
MMO\core\controllers
Extends
aController
Two routes, one job. [`routeIndex`](https://mmoframework.fr/documentation/mmo.core/php/controllers/TestController.md#testcontroller-routeindex) is the page; [`routeRun`](https://mmoframework.fr/documentation/mmo.core/php/controllers/TestController.md#testcontroller-routerun) is the json endpoint behind its buttons, which runs one package's suite (or one suite of it) and answers the whole result -- totals, per-suite rows and every failing test with its message and location. The page never reloads: it asks for one library at a time and fills its own row, so a slow suite does not hold the others up. It is a **development tool**: running a suite executes the package's own code, with whatever side effects its tests have. Both routes refuse with 403 unless [`TestRunner::$enabled`](https://mmoframework.fr/documentation/mmo.core/php/TestRunner.md#testrunner-enabled), which is on in dev mode only. ### Using it ```php \MMO\config([ \MMO\core\Application::class => ['routes' => [\MMO\core\controllers\TestController::class => []]], ]); ``` The page then answers on `tools/mmo/tests`, and adds itself to the application's menu.

Index

inMenu
template
templateFolder
describeBinary($runner)
onRoute($route)
routeIndex($route)The page: one row per package, with its declared suites and a run button.
routeRun($route)Run one package's suite and answer the result.
__wakeup()Adds the page to every html document's menu.

Properties3

inMenu

bool $inMenu = true
Type
bool

template

string $template = 'tests.phtml'
Type
string

templateFolder

string $templateFolder = '{MMO\\core}/templates'
Type
string

Methods5

describeBinary($runner)

TestController.php:118
protected function describeBinary(MMO\core\TestRunner $runner): string
$runnerTestRunner
returnsstringthe phpunit that would be used, or why there is none -- the first thing to check when every run fails identically

routeIndex($route)

TestController.php:78

The page: one row per package, with its declared suites and a run button.

#[MMO\core\attributes\APIRoute('tools/mmo/tests', 'Run any installed library\'s phpunit suite.', order: 1000, mediaTypes: ['html'])] function routeIndex(MMO\core\server\Route $route): void
$routeRoute
returnsvoid

routeRun($route)

TestController.php:101

Run one package's suite and answer the result.

#[MMO\core\attributes\APIRoute('POST|tools/mmo/tests/run', 'Run one library\'s phpunit suite and return its result.', body: ['library' => 'string', 'suite' => '?string'], mediaTypes: ['json'])] function routeRun(MMO\core\server\Route $route): array
$routeRoute
returnsarrayTestRunner::run
throwswhen running tests is disabled in this environment

__wakeup()

TestController.php:48

Adds the page to every html document's menu.

function __wakeup(): voidDone here rather than in the package's bootstrap on purpose: the link only makes sense once an application has actually registered this controller, and a module's `__wakeup()` is the framework's own "run once, when I am first used" hook. `HtmlDocument::addMenu()` is core's own api, so this costs no dependency on any client package -- a document that is never rendered as html simply never gets the listener's attention.
returnsvoid
Inherited members (54)
ConstantsDeclared byDescription
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
PropertiesDeclared byDescription
verbosityaModule
MethodsDeclared byDescription
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).
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
HasRoutes()aControllerTells if any APIRoute are registered in the application
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.
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.
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.
serialize($path, $serializer)aModule\MMO\core\interfaces\iSerializable::serialize -- exports every property (via
setVerbosity($verb)aModuleSet the current verbosity mask, replacing whatever it was before.
Shared()aModuleGet the shared instance, creating (and configuring) it on first call.
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.