DeveloperController

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

class

DeveloperController

The developer layer of an application (mmo.client's display mode dev, DeveloperMode): on each page, the tickets of the board and the items of the checklists that are about it; a ticket filed from the page, with what it was showing; the project lead notified.

class MMO\admin\controllers\DeveloperController extends MMO\core\classes\aDataController implements MMO\core\interfaces\iRoutable

Espace de noms: MMO\admin\controllers
Étend: aDataController
Implémente: iRoutable

- `GET api/developer/page.json?route=` the page's tickets (`pages` of a ticket, or an item of a checklist naming it) and checks (the items whose `url` is the page); - `POST api/developer/tickets.json` a ticket filed from a page -- a screenshot with it only for [`SCREENSHOT`](https://mmoframework.fr/fr/documentation/mmo.admin/php/controllers/DeveloperController.md#developercontroller-screenshot); - `POST api/developer/reports.json` a problem a user reports (the bug button): a ticket too, never with a screenshot; - `POST api/developer/tickets/{ticket}/comments.json` a comment on one of them; - `GET api/developer/screenshots/{id}.png`, `GET api/developer/summary.json`. Where it is kept is [`$store`](https://mmoframework.fr/fr/documentation/mmo.admin/php/controllers/DeveloperController.md#developercontroller-store)'s: `board` on a development machine, straight onto [`$board`](https://mmoframework.fr/fr/documentation/mmo.admin/php/controllers/DeveloperController.md#developercontroller-board)'s file; `inbox` on a server, a git repository of its own in [`$folder`](https://mmoframework.fr/fr/documentation/mmo.admin/php/controllers/DeveloperController.md#developercontroller-folder) that `php admin.php developer pull` brings onto the board. The screenshots stay in [`$folder`](https://mmoframework.fr/fr/documentation/mmo.admin/php/controllers/DeveloperController.md#developercontroller-folder), wherever it is: they may show the clients' data. Declared like any controller: "MMO\\admin\\controllers\\DeveloperController": {"board": "my.oviepro-deploy", "boards": "{root}/boards", "checklists": "{root}/checklists", "store": "board", "folder": "{db}/developer", "basePaths": ["/my.oviepro/"]} The scopes (mmo.oauth) it asks: [`VIEW`](https://mmoframework.fr/fr/documentation/mmo.admin/php/controllers/DeveloperController.md#developercontroller-view) for the cues, [`CREATE`](https://mmoframework.fr/fr/documentation/mmo.admin/php/controllers/DeveloperController.md#developercontroller-create), [`SCREENSHOT`](https://mmoframework.fr/fr/documentation/mmo.admin/php/controllers/DeveloperController.md#developercontroller-screenshot), [`COMMENT`](https://mmoframework.fr/fr/documentation/mmo.admin/php/controllers/DeveloperController.md#developercontroller-comment), [`TRIAGE`](https://mmoframework.fr/fr/documentation/mmo.admin/php/controllers/DeveloperController.md#developercontroller-triage) (who is notified). [`$open`](https://mmoframework.fr/fr/documentation/mmo.admin/php/controllers/DeveloperController.md#developercontroller-open): a development machine, everything to whoever calls -- the agents' `curl`.

curl 'http://localhost/my.oviepro/api/developer/page.json?route=settings/utilisateurs'

curl -X POST -H 'Content-Type: application/json' -d '{"title": "Save fails", "route": "settings/utilisateurs"}' http://localhost/my.oviepro/api/developer/tickets.json

Index

	CHECK	checking an item
	CHECKLISTS	the checks of a page
	COMMENT	commenting a ticket from a page
	CREATE	filing a ticket from a page
	RUN	running an item's command (▶, on the developer's own machine only: `ChecklistController::$runScope`)
	SCREENSHOT	a screenshot with it
	TOOLS	the developer's tools (logs, database...)
	TRIAGE	sorting the tickets filed: who is notified of a new one
	VIEW	the cues of a page: its tickets (and the board)
	author
	basePaths
	board
	boardPage
	boards
	checklists
	checklistsPage
	folder
	git
	instance
	labels
	notify
	open
	status
	store
	storeInstance
	abilities()
	backfillPages($write)	Give the board's tickets that have none their `pages`: what the checklists' recipes say of them (`checks: {ticket: {url}}`), the ``` ``check` `` `blocks of their discussion (`page \| url \| what`),…
	basePaths()
	buildTicket($input, $author, $screenshot, $report)	Build the ticket filed from a page, as the board keeps it.
	can($scope)
	checksOf($routes, $member)	The items of the checklists whose `url` is one of $routes.
	ConnectRoutes($routes, $config) static
	content($route)
	fail($route, $status, $error)
	file($input, $report, $png)	File a ticket: keep it (`getStore`), learn the board its labels, notify who triages.
	getAuthor()
	getBoard()
	getStore()
	instanceName()
	isEnabled()
	notifyFiled($ticket, $author, $report)	Tell who triages (`$notify`) of a ticket filed: the notification centre of mmo.client, the author left out.
	page($route, $done, $member)	What the developer layer shows on a page.
	pagesOf($ticket)	The pages a ticket is about: its `pages`, else what its description cites.
	png($dataUrl)
	routeComment($route)
	routeFile($route)
	routeOf($url)
	routePage($route)
	routeReport($route)	A problem a user reports (the bug button of the application): a ticket in « to sort », without any screenshot -- a user's screen may show what only they may see.
	routeScreenshot($route)
	routesOf($route)	The names a page goes by: its route, and where its folder's `default` leads (`settings` is `settings/users`).
	routeSummary($route)
	routeTodo($route)
	setStore($store)
	sourceOf($route)
	ticketCue($id, $t, $status, $labels, $board, $pages, $via, $routes)
	todo($checklist, $member)	The pages where something is left to check, in the checklists' order: where the « next » button of a walkthrough leads.

Constantes9

CHECK

checking an item

const CHECK = 'dev.checklists#check'

CHECKLISTS

the checks of a page

const CHECKLISTS = 'dev.checklists'

COMMENT

commenting a ticket from a page

const COMMENT = 'dev.tickets#comment'

CREATE

filing a ticket from a page

const CREATE = 'dev.tickets#create'

RUN

running an item's command (▶, on the developer's own machine only: ChecklistController::$runScope)

const RUN = 'dev.checklists#run'

SCREENSHOT

a screenshot with it

const SCREENSHOT = 'dev.tickets#screenshot'

TOOLS

the developer's tools (logs, database...)

const TOOLS = 'dev.tools'

TRIAGE

sorting the tickets filed: who is notified of a new one

const TRIAGE = 'dev.tickets#triage'

VIEW

the cues of a page: its tickets (and the board)

const VIEW = 'dev.boards'

Propriétés16

author

?string $author = null

Type: null | string

basePaths

array $basePaths = []

Type: array

board

?string $board = null

Type: null | string

boardPage

string $boardPage = 'developer/boards'

Type: string

boards

string $boards = '{root}/boards'

Type: string

checklists

?string $checklists = '{root}/checklists'

Type: null | string

checklistsPage

string $checklistsPage = 'developer/checklists'

Type: string

folder

string $folder = '{db}/developer'

Type: string

git

bool $git = true

Type: bool

instance

string $instance = ''

Type: string

labels

array $labels = […4 items]

Type: array

notify

?string $notify = 'dev.tickets#triage'

Type: null | string

open

bool $open = false

Type: bool

status

?string $status = null

Type: null | string

store

string $store = 'board'

Type: string

storeInstance

protected ?MMO\admin\interfaces\iDeveloperStore $storeInstance = null

Type: null | iDeveloperStore

Méthodes32

abilities()

DeveloperController.php:133

function abilities(): array

retourne array bool> what the page may offer: view, checklists, check, create, screenshot, comment, triage, tools

backfillPages($write)

DeveloperController.php:378

Give the board's tickets that have none their pages: what the checklists' recipes say of them (checks: {ticket: {url}}), the ``` `check `` blocks of their discussion (page | url | what`), the urls of their description.

function backfillPages(bool $write = false): array

$write = false	bool	false: only say what would be given
retourne	array	string, title: string, pages: list<string>}> the tickets given pages

basePaths()

DeveloperController.php:183

function basePaths(): array

retourne array the paths the application is served below: $basePaths, and this site's own

buildTicket($input, $author, $screenshot, $report)

DeveloperController.php:449

Build the ticket filed from a page, as the board keeps it.

function buildTicket( array $input, array $author, ?string $screenshot = null, bool $report = false ): array

$input	array	`{title, description, type, urgency, route, url, target, context}`
$author	array
$screenshot = null	null \| string	its id (`iDeveloperStore::saveScreenshot`)
$report = false	bool	a user's report (the bug button), rather than a developer's ticket
retourne	array

can($scope)

DeveloperController.php:127

function can(string $scope): bool

$scope	string
retourne	bool	whether whoever is asking holds $scope (mmo.oauth); everything on an `$open` machine

checksOf($routes, $member)

DeveloperController.php:321

The items of the checklists whose url is one of $routes.

function checksOf(array $routes, ?string $member = null): array

$routes	array
$member = null	null \| string	whose box is said `checked`, on a checklist with members (else: anyone's)
retourne	array	string, checklistTitle: string, id: string, ref: string, group: string, section: string, kind: string, title: string, detail: string, tickets: list<string>, checked: bool, members: list<string>, boxes: array<string, bool>}>

ConnectRoutes($routes, $config)

staticDeveloperController.php:117

static function ConnectRoutes(array &$routes, array $config): void

Voir: $open: every route is mmo.oauth's anonymous

$routes	array
$config	array
retourne	void

content($route)

DeveloperController.php:210

function content(string $route): ?object

$route	string
retourne	null \| object	the page's content (mmo.client)

fail($route, $status, $error)

DeveloperController.php:695

protected function fail(MMO\core\server\Route $route, int $status, string $error): array

$route	Route
$status	int
$error	string
retourne	array	string}

file($input, $report, $png)

DeveloperController.php:514

File a ticket: keep it (getStore), learn the board its labels, notify who triages.

function file(array $input, bool $report = false, ?string $png = null): array

$input	array	as `buildTicket`
$report = false	bool
$png = null	null \| string	a screenshot's bytes
retourne	array	the ticket kept

getAuthor()

DeveloperController.php:172

function getAuthor(): array

retourne array string, name: string} who files: the logged in user (mmo.oauth), else $author

getBoard()

DeveloperController.php:144

function getBoard(): ?string

retourne null | string the board the tickets are filed on and shown from: the one the user picked in Développeur > Boards (BoardSelection, a development machine's board store only), else $board; null for no developer layer

\MMO\admin\helpers\DeveloperMode::Controller()?->getBoard(); // 'my.oviepro-billing'

getStore()

DeveloperController.php:154

function getStore(): MMO\admin\interfaces\iDeveloperStore

retourne

iDeveloperStore

instanceName()

DeveloperController.php:167

function instanceName(): string

retourne string what this server is called: $instance, else its host

isEnabled()

DeveloperController.php:150

function isEnabled(): bool

retourne

bool

whether the developer layer has a board to work with

notifyFiled($ticket, $author, $report)

DeveloperController.php:533

Tell who triages ($notify) of a ticket filed: the notification centre of mmo.client, the author left out.

protected function notifyFiled(array $ticket, array $author, bool $report): void

$ticket	array
$author	array
$report	bool
retourne	void

page($route, $done, $member)

DeveloperController.php:237

What the developer layer shows on a page.

function page(string $route, bool $done = false, ?string $member = null): array

$route	string
$done = false	bool	with the tickets that are done
$member = null	null \| string	whose box a check is, on a checklist with members
retourne	array	string, routes: list<string>, tickets: list<array>, checks: list<array>, counts: array}

pagesOf($ticket)

DeveloperController.php:283

The pages a ticket is about: its pages, else what its description cites.

function pagesOf(array $ticket): array

$ticket	array
retourne	array	string, target?: string}>

png($dataUrl)

DeveloperController.php:687

protected function png(string $dataUrl): ?string

$dataUrl	string
retourne	null \| string	the png of a `data:image/png;base64,...` url

routeComment($route)

DeveloperController.php:629

#[MMO\core\attributes\APIRoute('POST|api/developer/tickets/{ticket}/comments.json', 'Comment on a ticket from a page: {body}', mediaTypes: ['json'])] function routeComment(MMO\core\server\Route $route): array

$route	Route	a JSON body `{body}`
retourne	array	`{comment}`

routeFile($route)

DeveloperController.php:586

#[MMO\core\attributes\APIRoute('POST|api/developer/tickets.json', 'File a ticket from a page: {title, description, type, urgency, route, url, target, context, screenshot}', mediaTypes: ['json'])] function routeFile(MMO\core\server\Route $route): array

$route	Route	a JSON body `{title, description, type, urgency, route, url, target, context, screenshot}`: `screenshot` a png's data url, kept only for `SCREENSHOT`
retourne	array	`{ticket}`

routeOf($url)

DeveloperController.php:191

function routeOf(?string $url): ?string

$url	null \| string
retourne	null \| string	the route of an url of the application, whichever of its sites (`PageRoute::FromUrl`)

routePage($route)

DeveloperController.php:561

#[MMO\core\attributes\APIRoute('GET|api/developer/page.json', 'The tickets and checks of a page: ?route=settings/users&member=Marc', mediaTypes: ['json'])] function routePage(MMO\core\server\Route $route): array

$route	Route	`?route=` the page (or `?url=`), `&done=1` with the tickets done, `&member=` whose checks
retourne	array	as `page`

routeReport($route)

DeveloperController.php:610

A problem a user reports (the bug button of the application): a ticket in « to sort », without any screenshot -- a user's screen may show what only they may see.

#[MMO\core\attributes\APIRoute('POST|api/developer/reports.json', 'Report a problem from a page, as a user: {title, description, url, context}', mediaTypes: ['json'])] function routeReport(MMO\core\server\Route $route): array

$route	Route	a JSON body `{title, description, url, context}`
retourne	array	`{ticket: {id}}`

routeScreenshot($route)

DeveloperController.php:644

#[MMO\core\attributes\APIRoute('GET|api/developer/screenshots/{id}.png', 'A ticket\'s screenshot', mediaTypes: ['json'])] function routeScreenshot(MMO\core\server\Route $route): array

$route	Route
retourne	array	an error, or nothing: the image is the response

routesOf($route)

DeveloperController.php:200

The names a page goes by: its route, and where its folder's default leads (settings is settings/users).

function routesOf(string $route): array

$route	string
retourne	array

routeSummary($route)

DeveloperController.php:657

#[MMO\core\attributes\APIRoute('GET|api/developer/summary.json', 'The developer\'s home: the board\'s counts, what is to sort, what is pending, the checklists', mediaTypes: ['json'])] function routeSummary(MMO\core\server\Route $route): array

$route	Route
retourne	array	`{board, tickets: {status: count}, toSort: [ticket], pending: [entry], checklists: [{name, title, progress}]}`: the Developer home page

routeTodo($route)

DeveloperController.php:573

#[MMO\core\attributes\APIRoute('GET|api/developer/todo.json', 'The pages where something is left to check: ?checklist=&member=', mediaTypes: ['json'])] function routeTodo(MMO\core\server\Route $route): array

$route	Route	`?checklist=`, `&member=`
retourne	array	`{pages: [{route, url, todo}]}`: where something is left to check

setStore($store)

DeveloperController.php:162

function setStore(?MMO\admin\interfaces\iDeveloperStore $store): void

$store	null \| iDeveloperStore
retourne	void

sourceOf($route)

DeveloperController.php:219

function sourceOf(string $route): ?string

$route	string
retourne	null \| string	the file the page is written in, relative to the project (`src/pages/settings/users.phtml`)

ticketCue($id, $t, $status, $labels, $board, $pages, $via, $routes)

DeveloperController.php:293

protected function ticketCue( string $id, array $t, ?array $status, array $labels, ?MMO\admin\helpers\KanbanBoard $board, array $pages, string $via, array $routes ): array

$id	string
$t	array
$status	null \| array
$labels	array
$board	null \| KanbanBoard
$pages	array
$via	string
$routes	array
retourne	array	what the page is told of a ticket

todo($checklist, $member)

DeveloperController.php:350

The pages where something is left to check, in the checklists' order: where the « next » button of a walkthrough leads.

function todo(?string $checklist = null, ?string $member = null): array

$checklist = null	null \| string	one of them, null for all
$member = null	null \| string
retourne	array	string, url: string, todo: int}>

Membres hérités (62)

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`.
`onRoute($route)`	aDataController	Same as `aController::onRoute`, plus forcing the response to JSON (`Response::Json`) for every route this controller claims.
`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…