aBoard

MMO\git\classes · 1 symbole · générée le 27 Oct 2026

class

aBoard

Something on GitHub seen as the data of mmo.client's <mmo-kanban>: {statuses, labels, categories, tickets}.

abstract class MMO\git\classes\aBoard

Espace de noms: MMO\git\classes

A board is read with [`load`](https://mmoframework.fr/fr/documentation/mmo.git/php/classes/aBoard.md#aboard-load), and written with [`save`](https://mmoframework.fr/fr/documentation/mmo.git/php/classes/aBoard.md#aboard-save), which is given the data as `load()` gave it and the board's data now: it changes on GitHub only what differs between the two, and answers the id GitHub gave each ticket the board made (a new ticket carries the board's own id until then).

$data = $board->load(); $ids = $board->save($data, $changed)['ids'];

Index

	COLORS	the colours mmo-kanban names, as GitHub's label colours: a colour read from GitHub is named when it is one
	ColorHex($color) static
	ColorName($color) static
	discussion($ticketId) abstract
	getState()
	getTitle() abstract
	getUrl() abstract
	isGone($ticketId, $locator)	Whether a ticket the board's listing leaves out is gone indeed: a listing can miss a ticket that is there (GitHub lists a project's draft just made minutes later).
	keepsColor($kind)
	load() abstract
	locator($ticketId)
	meta($ticket, $type)
	remap($ticket, $ids, $categories)	Give the board's ids of new tickets and categories the ones GitHub gave them.
	remapCondition($node, $ids)
	save($before, $after) abstract
	setState($state)

Constantes1

COLORS

the colours mmo-kanban names, as GitHub's label colours: a colour read from GitHub is named when it is one

const COLORS = […9 items]

Méthodes15

ColorHex($color)

staticaBoard.php:53

static function ColorHex(?string $color): ?string

$color	null \| string
retourne	null \| string	`rrggbb`, what GitHub takes, for a name of `COLORS` or a `#rrggbb`; null for anything else

ColorName($color)

staticaBoard.php:43

static function ColorName(?string $color): ?string

$color	null \| string	a GitHub colour (`rrggbb`), or a name of `COLORS`
retourne	null \| string	its name when it is one of `COLORS`, else `#rrggbb`

discussion($ticketId)

abstractaBoard.php:83

abstract function discussion(string $ticketId): ?MMO\git\helpers\IssueDiscussion

$ticketId	string
retourne	null \| IssueDiscussion	the ticket's discussion, null when it has none (a draft)

getState()

aBoard.php:89

function getState(): array

retourne array what load learnt of GitHub besides the board's data, and saving needs (a project's ids): with the data, it is what a cache keeps, and gives back with setState rather than load again

getTitle()

abstractaBoard.php:59

abstract function getTitle(): ?string

retourne

null | string

what the board is called on GitHub (null until it is read, when it has to be)

getUrl()

abstractaBoard.php:62

abstract function getUrl(): string

retourne

string

the board's page on GitHub

isGone($ticketId, $locator)

aBoard.php:114

Whether a ticket the board's listing leaves out is gone indeed: a listing can miss a ticket that is there (GitHub lists a project's draft just made minutes later).

function isGone(string $ticketId, ?string $locator): ?bool

$ticketId	string
$locator	null \| string	what `locator` gave for it while it was there
retourne	null \| bool	true: gone; false: GitHub still has it; null: it cannot tell (no locator, GitHub did not answer). By default, the listing says it: true

keepsColor($kind)

aBoard.php:35

function keepsColor(string $kind): bool

$kind	string	`status`, `label` or `category`
retourne	bool	whether GitHub keeps the colour of that kind for this board, so `save` writes it there: what GitHub does not keep (an icon, the colour of a category) is for the application to keep

load()

abstractaBoard.php:68

abstract function load(): array

retourne	array	array, labels: array, categories: array, tickets: array}
lève		when GitHub refuses (no access, rate limit...)

locator($ticketId)

aBoard.php:102

function locator(string $ticketId): ?string

Voir: isGone to ask it once the board's listing leaves it out; null: the board's listing is all there is

$ticketId	string	a ticket the last `load` listed, or `save` made
retourne	null \| string	what finds the ticket again without listing the board (a project's item node id), for

meta($ticket, $type)

aBoard.php:152

protected function meta(array $ticket, string $type): array

$ticket	array
$type	string	the type of its status: `backlog`, `active` or `done`
retourne	array	what the ticket holds that GitHub has no field for, empty values left out

remap($ticket, $ids, $categories)

aBoard.php:125

Give the board's ids of new tickets and categories the ones GitHub gave them.

protected function remap(array $ticket, array $ids, array $categories = []): array

$ticket	array
$ids	array
$categories = []	array
retourne	array	the ticket

remapCondition($node, $ids)

aBoard.php:137

protected function remapCondition(mixed $node, array $ids): mixed

$node	mixed	a condition, `remap`
$ids	array
retourne	mixed

save($before, $after)

abstractaBoard.php:77

abstract function save(array $before, array $after): array

$before	array	the board's data as `load` gave it
$after	array	the board's data now
retourne	array	array<string, string>, saved?: array} the id each new ticket got, by the id the board gave it; and, when the board can tell without reading GitHub again, the board as GitHub holds it now (`load`'s shape)
lève		when GitHub refuses a change: the ones made before it are made

setState($state)

aBoard.php:94

function setState(array $state): void

$state	array	as `getState` gave it
retourne	void