SectionTypesController

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

class

SectionTypesController

The section-type editor's api (SectionTypeStore does the work), under admin/section-types:

class MMO\editor\controllers\SectionTypesController extends MMO\core\classes\aDataController use MMO\editor\controllers\tAdminApi

Espace de noms: MMO\editor\controllers
Étend: aDataController
Utilise les traits: tAdminApi

| route | | |---|---| | `GET admin/section-types` | the editor's html page: `<mmo-section-editor>` (`templates/section-types.phtml`) | | `GET admin/section-types.json` | every type: `{name, label, icon, order, origin, editable, overrides}`, and `writable` | | `GET`, `PUT`, `DELETE admin/section-types/{name}.json` | a type's files `{schema, template, css}`; `PUT` writes them (201 a new type), `DELETE` removes them | | `POST admin/section-types/{name}/copy.json` `{as}` | another folder's type copied into the site's | | `POST admin/section-types/generate.json` `{name, schema}` | the template of a schema, to start from | | `POST admin/section-types/preview` `{name, schema, template, css, data}` | the html of a page holding one section of a type that is not saved | Someone logged in (401) holding `editor.sections#edit` (403): a type's template is PHP that the server runs, so this right is a developer's. A request changing something -- a preview runs the template it is sent, so it is one -- sends the session's CSRF token (`X-CSRF-Token`, the pages api's: `MMO.editor.config.token`). What is not valid is a 422 whose `errors` say why: `name`, `schema`, `template`, `css`.

curl -X PUT -H 'Content-Type: application/json' -H "X-CSRF-Token: $TOKEN" -d '{"schema": "{…}", "template": "<?php …"}' .../admin/section-types/faq.json

Index

	body($route)
	checkToken($route)	Make sure a request changing something comes from a page of the site: it has the session's token, or is authenticated by an `Authorization` header (which a browser does not send on its own)
	explainErrors($route)	An error says why in the answer's body too (`meta.error`): http/2 has no status text to carry it
	invalid($route, $e)
	onRoute($route)
	routeCopy($route)
	routeDelete($route)
	routeEditor($route)	The editor's page: `<mmo-section-editor>`, which works from the api
	routeGenerate($route)
	routeGet($route)
	routeList($route)
	routePreview($route)	The html of a page holding one section of a type that is not saved: its schema, its template, its css as the editor has them, and the section's `data` (its examples by default).
	routeSave($route)
	setStatus($route, $status)
	store($route, $token)
	user($route)

Méthodes16

body($route)

tAdminApi.php:52

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

$route	Route
retourne	array	mixed> the body of the request, a json object

checkToken($route)

tAdminApi.php:42

Make sure a request changing something comes from a page of the site: it has the session's token, or is authenticated by an Authorization header (which a browser does not send on its own)

protected function checkToken(MMO\core\server\Route $route): void

$route	Route
retourne	void
lève		(403) if it has not

explainErrors($route)

tAdminApi.php:18

An error says why in the answer's body too (meta.error): http/2 has no status text to carry it

protected function explainErrors(MMO\core\server\Route $route): void

$route	Route
retourne	void

invalid($route, $e)

tAdminApi.php:59

protected function invalid(MMO\core\server\Route $route, MMO\editor\exceptions\eInvalidPage $e): array

$route	Route
$e	eInvalidPage
retourne	array	array<string, string>} a 422 saying what is wrong

onRoute($route)

SectionTypesController.php:35

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

$route	Route
retourne	bool

routeCopy($route)

SectionTypesController.php:100

#[MMO\core\attributes\APIRoute('POST|admin/section-types/{name}/copy.json', 'Copy a type of section into the site\'s: {as}', mediaTypes: ['json'])] function routeCopy(MMO\core\server\Route $route): array

$route	Route
retourne	array	mixed> the copy (201), or `errors` (422)

routeDelete($route)

SectionTypesController.php:91

#[MMO\core\attributes\APIRoute('DELETE|admin/section-types/{name}.json', 'Remove a type of section of the site', mediaTypes: ['json'])] function routeDelete(MMO\core\server\Route $route): array

$route	Route
retourne	array	string, deleted: true}

routeEditor($route)

SectionTypesController.php:52

The editor's page: <mmo-section-editor>, which works from the api

#[MMO\core\attributes\APIRoute('GET|admin/section-types?type={?type}', 'The section-type editor', mediaTypes: ['html'])] function routeEditor(MMO\core\server\Route $route): MMO\core\server\Response

$route	Route
retourne	Response

routeGenerate($route)

SectionTypesController.php:111

#[MMO\core\attributes\APIRoute('POST|admin/section-types/generate.json', 'Write the template of a schema: {name, schema}', mediaTypes: ['json'])] function routeGenerate(MMO\core\server\Route $route): array

$route	Route
retourne	array	string}\|array{errors: array<string, string>} the template of a schema

routeGet($route)

SectionTypesController.php:71

#[MMO\core\attributes\APIRoute('GET|admin/section-types/{name}.json', 'A type of section: its schema, its template, its css', mediaTypes: ['json'])] function routeGet(MMO\core\server\Route $route): array

$route	Route
retourne	array	mixed> a type's files, and its history

routeList($route)

SectionTypesController.php:64

#[MMO\core\attributes\APIRoute('GET|admin/section-types.json', 'The types of section, and where they come from', mediaTypes: ['json'])] function routeList(MMO\core\server\Route $route): array

$route	Route
retourne	array	bool, folder: ?string, types: list<array<string, mixed>>}

routePreview($route)

SectionTypesController.php:125

The html of a page holding one section of a type that is not saved: its schema, its template, its css as the editor has them, and the section's data (its examples by default). The template runs -- it is PHP --, written in the temporary folder for the time of the request.

#[MMO\core\attributes\APIRoute('POST|admin/section-types/preview', 'The html of a section of a type that is not saved', mediaTypes: ['html'])] function routePreview(MMO\core\server\Route $route): MMO\core\server\Response

$route	Route
retourne	Response

routeSave($route)

SectionTypesController.php:79

#[MMO\core\attributes\APIRoute('PUT|admin/section-types/{name}.json', 'Write a type of section of the site: {schema, template, css}', mediaTypes: ['json'])] function routeSave(MMO\core\server\Route $route): array

$route	Route
retourne	array	mixed> the type as it was written (201 when new), or its `errors` (422)

setStatus($route, $status)

tAdminApi.php:64

protected function setStatus(MMO\core\server\Route $route, int $status): void

$route	Route
$status	int
retourne	void

store($route, $token)

SectionTypesController.php:42

protected function store(MMO\core\server\Route $route, bool $token = false): MMO\editor\cms\SectionTypeStore

$route	Route
$token = false	bool
retourne	SectionTypeStore	the store, for $route's user (who must hold the right)

user($route)

tAdminApi.php:31

protected function user(MMO\core\server\Route $route): MMO\oauth\interfaces\iClient

$route	Route
retourne	iClient	the logged-in user
lève		(401) if nobody is

Membres hérités (61)

Constantes	Déclaré par	Description
`ALERT`	iLogLevel	Alert: Action must be taken immediately.
`ALL`	iLogLevel	Mask for all
`ALL_PLUS`	iLogLevel	debug everything
`BACKTRACE`	iLogLevel
`COLORS`	aDataController	Named color palettes for chart/report endpoints, e.g.
`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

	Propriétés	Déclaré par	Description
	`repositories`	aDataController
	`verbosity`	aModule

Méthodes	Déclaré par	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
`getMainRepository()`	aDataController
`getRepositories()`	aDataController
`getRepository($repo)`	aDataController
`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
`setRepositories($repositories)`	aDataController	Register the repositories this controller can query, keyed by name (e.g.
`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…