Theme

MMO\client · 1 symbol · generated 27 Oct 2026

class

Theme

class MMO\client\Theme extends MMO\core\classes\aModule

Namespace: MMO\client
Extends: aModule

Index

	assets
	bin
	enabled
	errorTpl
	fonts
	imports
	pages
	releaseCheck
	rootAttributes
	rootElement
	stylesheet
	addAsset($filename, $key)
	BuildHook($manifest, $filename, $options) static	Hook in mmo.json triggered when library is built into a phar package
	compileCSS($opts, $dev)	Compile the theme's stylesheet (`$stylesheet`) into `getBin(`'css').
	compileJHS($sassOpts, $dev)	Compile every `.jhs` of `getAssets(`'jhs') into `getBin(`'jhs').
	compileJS($opts, $dev)	Bundle every `.js` of `getAssets(`'js') into `getBin(`'js').
	compileOther()
	compileSVG()
	configureHtmlDocument($document)	Configure the HTMLDocument to include the mmo-app custom element as root
	createErrorResponse($e, $route)	Import an error template when the route trigger an exception.
	DefaultConfig() static
	exportMenu($content, $document)
	getAssets($key, $resolve)
	getBin($key, $resolve)
	getBinUrl($key)
	getBinVersion($key, $sources)	The version of a built file: its modification time, or in dev mode that of its newest source when it is newer.
	getRelease()	What identifies the code the site runs.
	getStylesheet($resolve)
	getVersionedBinUrl($key)
	hasAsset($filename, $key)
	isUpToDate($key, $time)
	loopAssets($key, $resolve)
	onDocumentInit($event)	Configure HTMLDocument after it has been created
	onPageContents($contents)
	onRelease($response)	Every response says the release the site runs in `X-App-Version` -- json included: the calls a page makes tell it when the site was deployed again since it was loaded (`MMO.release`, src/js/core/Re…
	onResponse($response)
	onRoute($route)
	recordSources($key)
	removeAsset($filename, $key)	Remove from the list $key every entry that resolves to $filename (the file, folder or glob as it was added).
	sourcesFingerprint($key)
	unserialize($data, $path, $instances)	The asset lists of the configuration are ADDED to the defaults, never merged onto them.
	__wakeup()

Properties11

assets

protected array $assets

Type: array

bin

protected array $bin

Type: array

enabled

protected bool $enabled = true

Type: bool

errorTpl

protected string $errorTpl = 'error.phtml'

Type: string

fonts

protected array $fonts

Type: array

imports

protected array $imports = []

Type: array

releaseCheck

protected bool $releaseCheck = true

Type: bool

rootAttributes

protected array $rootAttributes

Type: array

rootElement

protected string $rootElement

Type: string

stylesheet

protected string $stylesheet

Type: string

See: getBin('css') and linked in every html document. It declares the design tokens at :root, from where they inherit into every shadow root, so a reskin is this one file.

Methods31

addAsset($filename, $key)

Theme.php:529

function addAsset(string $filename, ?string $key = null): string

$filename	string
$key = null	null \| string
returns	string

BuildHook($manifest, $filename, $options)

staticTheme.php:106

Hook in mmo.json triggered when library is built into a phar package

static function BuildHook( ?MMO\core\helpers\PackageManifest $manifest = null, ?string $filename = null, array $options = [] ): void

$manifest = null	null \| PackageManifest
$filename = null	null \| string
$options = []	array
returns	void

compileCSS($opts, $dev)

Theme.php:630

Compile the theme's stylesheet ($stylesheet) into getBin('css').

function compileCSS(array $opts = [], bool $dev = true): void

This is the document stylesheet: it declares the design tokens at `:root`, from where they inherit into every shadow root, so the custom elements never redeclare them. A theme is written in Simple CSS, and only in Simple CSS. The sass design system this package used to ship is archived in `.mmo/sass`; [`JHSCompiler`](https://mmoframework.fr/en/documentation/mmo.client/php/JHSCompiler.md#jhscompiler) still has a `lang="sass"` path for a package that carries sass of its own, but no part of a theme is sass any more.

$opts = []	array	per-compilation overrides for `SCSCompiler`
$dev = true	bool	false to force a production build (compressed, no source map)
returns	void
throws		when the stylesheet is not a `.scs` file

compileJHS($sassOpts, $dev)

Theme.php:654

Compile every .jhs of getAssets('jhs') into getBin('jhs').

function compileJHS(array $sassOpts = [], bool $dev = true): void

$sassOpts = []	array	options for the elements of other packages, which are still written in sass
$dev = true	bool
returns	void

compileJS($opts, $dev)

Theme.php:609

Bundle every .js of getAssets('js') into getBin('js').

function compileJS(array $opts = [], bool $dev = true): void

$opts = []	array	per-compilation overrides for `JSCompiler`
$dev = true	bool	false to force a production build (minified, no source map)
returns	void

compileOther()

Theme.php:659

function compileOther(): void

returns

void

compileSVG()

Theme.php:598

function compileSVG(): void

returns

void

configureHtmlDocument($document)

Theme.php:281

Configure the HTMLDocument to include the mmo-app custom element as root

function configureHtmlDocument(MMO\core\documents\HtmlDocument $document): void

$document	HtmlDocument
returns	void

createErrorResponse($e, $route)

Theme.php:175

Import an error template when the route trigger an exception.

function createErrorResponse(Throwable $e, MMO\core\server\Route $route): MMO\core\server\Response

It looks for a template in the folder `errors`

$e	Throwable
$route	Route
returns	Response

for a 404, it will look for a template named `errors/404.phtml` or `errors/400.phtml`

DefaultConfig()

staticTheme.php:42

static function DefaultConfig(): array

returns

array

exportMenu($content, $document)

Theme.php:188

protected function exportMenu( MMO\client\entities\Content $content, MMO\core\documents\HtmlDocument $document ): void

$content	Content
$document	HtmlDocument
returns	void

getAssets($key, $resolve)

Theme.php:566

function getAssets(string $key = '*', bool $resolve = true): array

$key = '*'	string
$resolve = true	bool
returns	array

getBin($key, $resolve)

Theme.php:450

function getBin(string $key, bool $resolve = true): string

$key	string
$resolve = true	bool
returns	string

getBinUrl($key)

Theme.php:455

function getBinUrl(string $key): string

$key	string
returns	string

getBinVersion($key, $sources)

Theme.php:481

The version of a built file: its modification time, or in dev mode that of its newest source when it is newer.

function getBinVersion(string $key, bool $sources = true): int

In dev mode the page that finds a bundle stale rebuilds it only once its document is configured (the jobs of

See: __wakeup): with the bundle's own time alone, that page still linked the url of the old build, which the browser had cached, and a change was seen only on the reload after (or a forced one).

$key	string	a file of `$bin`
$sources = true	bool	also the times of its sources (`loopAssets`): what a dev build is about to become
returns	int	a unix time, 0 when the file is not built and has no source

Theme::Shared()->getBinVersion('css'); // 1791190000

getRelease()

Theme.php:499

What identifies the code the site runs. It changes with every deployment, not only when a version is raised: - an mmo.admin release: its `.release` stamp, at the project's root; - a git checkout (a working tree, a site deployed by `git checkout`): the commit it is on; - otherwise: the project's version (its `mmo.json`).

function getRelease(): string

Only known once the application is configured (`{root}`): not while the libraries are bootstrapped.

returns

string

printable ascii only (it goes in a header), '' when nothing is known

getStylesheet($resolve)

Theme.php:525

function getStylesheet(bool $resolve = true): string

$resolve = true	bool
returns	string

getVersionedBinUrl($key)

Theme.php:465

function getVersionedBinUrl(string $key): string

$key	string	a file of `$bin`: `js`, `jhs`, `css`, `svg`
returns	string	its url, with `getBinVersion` (`?v=`): another url once a source changes or it is built again

Theme::Shared()->getVersionedBinUrl('js'); // http://localhost/app/www/bin/mmo.client.js?v=1791190000

hasAsset($filename, $key)

Theme.php:557

function hasAsset(string $filename, ?string $key = null): bool

$filename	string
$key = null	null \| string
returns	bool

isUpToDate($key, $time)

Theme.php:410

function isUpToDate(string $key, ?int $time = null): bool

$key	string	a file of `$bin`
$time = null	null \| int	the time to compare its sources with, else the built file's: then its sources must also be the ones it was built from (`sourcesFingerprint`) -- a package added to the project brings sources older than the bundle, a source removed none newer
returns	bool	false when the file must be built again

Theme::Shared()->isUpToDate('js'); // false once a package is added to `mmo.json`

loopAssets($key, $resolve)

Theme.php:570

function loopAssets(string $key = '*', bool $resolve = true): Generator

$key = '*'	string
$resolve = true	bool
returns	Generator

onDocumentInit($event)

Theme.php:203

Configure HTMLDocument after it has been created

#[MMO\core\attributes\Listen('MMO\\core\\events\\DocumentInit')] function onDocumentInit(MMO\core\events\DocumentInit $event): void

$event	DocumentInit
returns	void

onPageContents($contents)

Theme.php:256

#[MMO\core\attributes\Listen('MMO\\client\\events\\PageContents')] function onPageContents(MMO\client\events\PageContents $contents): void

$contents	PageContents
returns	void

onRelease($response)

Theme.php:249

Every response says the release the site runs in X-App-Version -- json included: the calls a page makes tell it when the site was deployed again since it was loaded (MMO.release, src/js/core/Release.js).

#[MMO\core\attributes\Listen('MMO\\core\\server\\Response')] function onRelease(MMO\core\server\Response $response): void

Sent with `header()`: the application sends the response's own headers right after its listeners, they add to it.

$response	Response
returns	void

onResponse($response)

Theme.php:215

#[MMO\core\attributes\Listen('MMO\\core\\server\\Response', order: 1000)] function onResponse(MMO\core\server\Response $response): void

$response	Response
returns	void

onRoute($route)

Theme.php:208

#[MMO\core\attributes\Listen('MMO\\core\\server\\Route')] function onRoute(MMO\core\server\Route $route): void

$route	Route
returns	void

recordSources($key)

Theme.php:446

protected function recordSources(string $key): void

$key	string	a file of `$bin`, just built from its sources (`isUpToDate`)
returns	void

removeAsset($filename, $key)

Theme.php:544

Remove from the list $key every entry that resolves to $filename (the file, folder or glob as it was added).

function removeAsset(string $filename, ?string $key = null): bool

A file only matched through a folder or a glob stays: removing it would remove the others the entry matches, so the method returns false ([`hasAsset`](https://mmoframework.fr/en/documentation/mmo.client/php/Theme.md#theme-hasasset) still says true).

$filename	string
$key = null	null \| string
returns	bool	whether an entry was removed

sourcesFingerprint($key)

Theme.php:439

function sourcesFingerprint(string $key): string

$key	string	a file of `$bin`
returns	string	what identifies the list of its sources (`loopAssets`), whatever their contents: kept beside the built file (`{bin}.sources`, `recordSources`), a hash only since `{bin}` is served

unserialize($data, $path, $instances)

Theme.php:84

The asset lists of the configuration are ADDED to the defaults, never merged onto them.

function unserialize( array $data, string $path, Psr\Container\ContainerInterface|array &$instances ): void

The libraries add their files from their bootstraps (`'?js' => ['$[..]', __DIR__ . '/js*.js']`), and so does a project's config.json -- all of it loaded before this theme exists, when `$[..]` has nothing to splice yet. The configuration keeps what it could not resolve as it was written (`?js`, `$[..]` and all) and resolves the rest against nothing (`js` => the library's files alone). Injected over [`DefaultConfig`](https://mmoframework.fr/en/documentation/mmo.client/php/Theme.md#theme-defaultconfig), those lists merged index by index: `[editor, edms, oauth]` replaced this package's own `js*.js`, and a release bundled everything but mmo.client's own js, elements and icons. So each entry is applied here, in order, onto the defaults: a list adds its files (once), `?key` only adds to a list it splices (`$[..]`) or creates one that does not exist, and `=key` replaces the list outright.

$data	array
$path	string
$instances	`ContainerInterface` \| array
returns	void

__wakeup()

Theme.php:125

function __wakeup(): void

returns

void

Inherited members (46)

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.
`getVerbosity()`	aModule
`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
`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`.
`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.
`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.
`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.