BoardFileRepository

MMO\admin\helpers · 1 symbol · generated 5 Oct 2026

class

BoardFileRepository

A board file (boards/{board}.json, KanbanBoard, served by BoardController) as a repository of mmo.client's kanban entities: one KanbanBoard, its KanbanTickets and their KanbanComments.

class MMO\admin\helpers\BoardFileRepository extends MMO\core\entities\Repository

Namespace: MMO\admin\helpers
Extends: Repository

mmo.git's `BoardSync` merges it with GitHub, as it would a `JsonRepository`, while the file stays what the board's page, its AI prompts and the release checklists read and write. It needs mmo.client, which mmo.admin does not depend on. - It reads the file the first time one of its collections is asked for. - `\MMO\commit()` writes back the entities changed, made or removed, and only them, onto the file as it is then, under its lock ([`KanbanBoard::Edit`](https://mcp.mmoframework.fr/documentation/mmo.admin/php/helpers/KanbanBoard.md#kanbanboard-edit), the one the boards' controller takes): what the page saved meanwhile is kept. The board's version goes up, so a page holding the board before reloads it rather than overwriting it. A removed ticket's discussion goes with it. - A new ticket's id is one more than the highest number among the board's tickets; a new comment's, random hex, as the controller gives them.

$board = new BoardFileRepository(['boards' => \MMO\client\entities\KanbanBoard::class, 'tickets' => KanbanTicket::class, 'comments' => KanbanComment::class], '{root}/boards/my.oviepro-deploy.json', 'my.oviepro-deploy'); $board->getCollectionByClass(KanbanTicket::class)->getById('12')->get('title');

Index

	board
	filename
	read
	collectionOf($class)
	createEntity($class, $data, $collection)	Same as `Repository::createEntity`, giving a ticket or a comment the id the boards' controller would.
	file()
	getCollection($name)
	getCollectionByClass($entityClass, $allowChildClass)
	getCollections()
	made($entity)	an entity read from the file, or written to it, is not a new one
	onCommit($commit)	Write onto the file what changed among its entities.
	read()	read the file into the collections, once
	uid()
	writeComment($b, $comment)	a comment onto its ticket's discussion
	writeTicket($b, $ticket)	a ticket onto the file's tickets: in its place, at the end when new, gone with its discussion when removed
	__construct($collections, $filename, $board)

Properties3

board

string $board = 'main'

Type: string

filename

string $filename = ''

Type: string

read

protected bool $read = false

Type: bool

Methods13

collectionOf($class)

BoardFileRepository.php:211

protected function collectionOf(string $class): MMO\core\interfaces\iCollection

$class	string
returns	iCollection
throws		when it has no collection of $class

createEntity($class, $data, $collection)

BoardFileRepository.php:100

Same as Repository::createEntity, giving a ticket or a comment the id the boards' controller would.

function createEntity( string $class, array $data = [], ?MMO\core\interfaces\iCollection $collection = null ): MMO\core\interfaces\iEntity

$class	string
$data = []	array
$collection = null	null \| iCollection
returns	iEntity

file()

BoardFileRepository.php:195

protected function file(): string

returns

string

getCollection($name)

BoardFileRepository.php:58

function getCollection(string $name): MMO\core\interfaces\iCollection

$name	string
returns	iCollection

getCollectionByClass($entityClass, $allowChildClass)

BoardFileRepository.php:68

function getCollectionByClass(string $entityClass, bool $allowChildClass = true): ?MMO\core\interfaces\iCollection

$entityClass	string
$allowChildClass = true	bool
returns	null \| iCollection

getCollections()

BoardFileRepository.php:63

function getCollections(): array

returns

array

made($entity)

BoardFileRepository.php:200

an entity read from the file, or written to it, is not a new one

protected function made(MMO\core\interfaces\iEntity $entity): void

$entity	iEntity
returns	void

onCommit($commit)

BoardFileRepository.php:116

Write onto the file what changed among its entities.

function onCommit(MMO\core\events\Commit $commit): void

$commit	Commit
returns	void

read()

BoardFileRepository.php:74

read the file into the collections, once

protected function read(): void

returns

void

uid()

BoardFileRepository.php:52

function uid(): string

returns

string

writeComment($b, $comment)

BoardFileRepository.php:172

a comment onto its ticket's discussion

protected function writeComment( MMO\admin\helpers\KanbanBoard $b, MMO\client\entities\KanbanComment $comment ): void

$b	KanbanBoard
$comment	KanbanComment
returns	void

writeTicket($b, $ticket)

BoardFileRepository.php:148

a ticket onto the file's tickets: in its place, at the end when new, gone with its discussion when removed

protected function writeTicket( MMO\admin\helpers\KanbanBoard $b, MMO\client\entities\KanbanTicket $ticket ): void

$b	KanbanBoard
$ticket	KanbanTicket
returns	void

__construct($collections, $filename, $board)

BoardFileRepository.php:46

function __construct(array $collections = [], string $filename = '', string $board = 'main')

$collections = []	array	see `aRepository::setCollections`
$filename = ''	string
$board = 'main'	string

Inherited members (27)

	Properties	Declared by	Description
	`collections`	aRepository

Methods	Declared by	Description
`addCollection($name, $collection)`	aRepository	Add collection
`createCollection($name, $entityClass, $collectionId)`	aRepository	Create and register a plain `Collection` for entities of $entityClass.
`createLog($type, $origin, $collection, $data, $filters, $sorts, $limit, $offset)`	aRepository	Build (but not dispatch) a `LogQuery` entity describing a data-mutating operation, stored in the repository's LogQuery collection (if one is registered).
`debugName()`	aRepository
`dropCollection($collection)`	Repository	NOTE: this used to just `return $this->hasCollection($collection);` -- reporting whether the collection exists, but never actually removing it from `aRepository::$collections`.
`executeQuery($query, $opts)`	Repository	Find entities by content (delegates to the collection's own in-memory filtering -- see `Collection::executeQuery`).
`forceCommit($origin, $entities)`	aRepository
`generateId($collection)`	Repository
`getCollectionName($collection)`	aRepository
`getDistinct($collection, $key)`	aRepository	Every value one property takes across a collection, once each, in ascending order.
`getEntities()`	aRepository
`getIterator()`	aRepository	\IteratorAggregate::getIterator -- iterates name => iCollection
`hasCollection($collection)`	aRepository
`hideLogData($collection, $data)`	aRepository	What a repository logs is what it wrote (mmo.pdo's row, mmo.mongodb's document or its changes), hidden properties (`ArrayProperty::isHidden`) included, and a log is exported…
`logDelete($origin, $collection, $data, $filters, $sorts, $limit, $offset)`	aRepository	Log and dispatch a DELETE operation.
`logInsert($origin, $collection, $data, $filters, $sorts, $limit, $offset)`	aRepository	Log and dispatch an INSERT operation.
`logStatus($origin, $collection, $data, $filters, $sorts, $limit, $offset)`	aRepository	Log and dispatch a STATUS-change operation.
`logUpdate($origin, $collection, $data, $filters, $sorts, $limit, $offset)`	aRepository	Log and dispatch an UPDATE operation.
`offsetExists($key)`	aRepository	\ArrayAccess::offsetExists
`offsetGet($key)`	aRepository	\ArrayAccess::offsetGet
`offsetSet($key, $value)`	aRepository	\ArrayAccess::offsetSet -- equivalent to `addCollection`
`offsetUnset($key)`	aRepository	\ArrayAccess::offsetUnset
`onFetch($event)`	aRepository	Listener for `Fetch`: resolves a `repository-uid/collection-id#id` (or `repository-uid/collection-id#id/nested/path` for an embedded value) URL, what `Ent…`
`searchText($query, $text)`	aRepository	Full-text search. Not implemented at this level -- a concrete repository backed by a search-capable store should override this.
`setCollections($cols)`	aRepository	Register a batch of collections at once, e.g.
`__wakeup()`	aRepository	Register this repository's `onCommit` / `onFetch` as listeners on the global