ThemeController

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

class

ThemeController

The http face of ThemeConfigurator: reads the theme's customizable surface, and writes a new one.

class MMO\client\controllers\ThemeController extends MMO\core\classes\aController

Namespace: MMO\client\controllers
Extends: aController

Four routes, three of which are what `<mmo-theme-config>` calls: - `GET theme/config.json` the model (every value the token sources declare) and the current overrides; - `POST theme/config/preview.json` compiles a candidate theme and answers the css, writing nothing; - `PUT theme/config.json` stores it, regenerates the `.scs` and recompiles the application's stylesheet; - `DELETE theme/config.json` drops every override. ### Who may call it Saving writes two files of the project and recompiles its css. That is a build step, not a user preference, so the controller answers 403 outside of development unless an application explicitly says otherwise ([`$devOnly`](https://mmoframework.fr/documentation/mmo.client/php/controllers/ThemeController.md#themecontroller-devonly)) -- and an application that opens it in production is expected to put it behind its own authentication, exactly as it would an admin screen. What a caller sends is never trusted: a value is re-parsed in the context of the entry it replaces and re-printed from the ast before it reaches a file ([`ThemeConfigurator::validate`](https://mmoframework.fr/documentation/mmo.client/php/ThemeConfigurator.md#themeconfigurator-validate)), so what is written is this package's own output rather than the request's text. ```json // PUT theme/config.json {"overrides": {"tokens:let::brand.s500": "#8B5CF6", "tokens:theme::radius.md": "20px"}} ```

Index

	devOnly
	configurator($route)
	DefaultConfig() static
	overrides($route)
	payload($configurator)	The payload every route answers: what can be changed, what is changed, and where it was written.
	routeConfig($route)	The whole customizable surface of the theme, and the values that currently override it.
	routePreview($route)	Compile a candidate theme and answer its css, without writing anything.
	routeReset($route)	Drop every override: the theme goes back to what its sources declare.
	routeSave($route)	Store a new configuration, regenerate the theme and recompile the application's stylesheet.

Properties1

devOnly

protected bool $devOnly = true

Type: bool

Methods8

configurator($route)

ThemeController.php:52

protected function configurator(MMO\core\server\Route $route): MMO\client\ThemeConfigurator

$route	Route
returns	ThemeConfigurator	the configurator these routes drive
throws		when the theme may not be configured over http here

DefaultConfig()

staticThemeController.php:44

static function DefaultConfig(): array

returns

array

overrides($route)

ThemeController.php:70

protected function overrides(MMO\core\server\Route $route): array

$route	Route
returns	array	the `overrides` of the request body
throws		when the body is not an object of scalars

payload($configurator)

ThemeController.php:89

The payload every route answers: what can be changed, what is changed, and where it was written.

protected function payload(MMO\client\ThemeConfigurator $configurator): array

The css url carries the stylesheet's own timestamp, so a page that has just saved can reload the document's stylesheet instead of reloading the document.

$configurator	ThemeConfigurator
returns	array

routeConfig($route)

ThemeController.php:117

The whole customizable surface of the theme, and the values that currently override it.

#[MMO\core\attributes\APIRoute('GET|theme/config.json', […2 items], mediaTypes: ['json'])] function routeConfig(MMO\core\server\Route $route): array

$route	Route
returns	array

routePreview($route)

ThemeController.php:135

Compile a candidate theme and answer its css, without writing anything.

#[MMO\core\attributes\APIRoute('POST|theme/config/preview.json', […2 items], mediaTypes: ['json'])] function routePreview(MMO\core\server\Route $route): array

The generated token layer *is* the theme, so this css is the `:root` rule and the dark theme's rules and nothing else -- small enough for a page to append it to its head on every keystroke, which is how the configurator previews a change that no custom property can express on its own (a brand ramp moves every token derived from it, and only a compilation knows which).

$route	Route
returns	array

routeReset($route)

ThemeController.php:165

Drop every override: the theme goes back to what its sources declare.

#[MMO\core\attributes\APIRoute('DELETE|theme/config.json', ['title' => 'Reset the theme', 'description' => 'drop every override'], mediaTypes: ['json'])] function routeReset(MMO\core\server\Route $route): array

$route	Route
returns	array	`payload`

routeSave($route)

ThemeController.php:149

Store a new configuration, regenerate the theme and recompile the application's stylesheet.

#[MMO\core\attributes\APIRoute('PUT|theme/config.json', […2 items], mediaTypes: ['json'])] function routeSave(MMO\core\server\Route $route): array

$route	Route
returns	array	`payload`, with the css url carrying the new stylesheet's timestamp

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.
`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`.
`onRoute($route)`	aController	This function is called before any api route declared.
`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…