GitHubRepository

MMO\git\helpers · 1 symbol · generated 27 Oct 2026

class

GitHubRepository

A GitHub project, or a repository's issues, as a repository of mmo.client's kanban entities: one KanbanBoard, its KanbanTickets, and their KanbanComments. mmo.client's KanbanController reads and saves a board through it as it does through a JsonRepository.

class MMO\git\helpers\GitHubRepository extends MMO\core\entities\Repository

Namespace: MMO\git\helpers
Extends: Repository

```php \MMO\app([ 'kanban' => ['$' => GitHubRepository::class, 'project' => 'https://github.com/users/<login>/projects/<n>', 'collections' => ['boards' => KanbanBoard::class, 'tickets' => KanbanTicket::class, 'comments' => KanbanComment::class]], \MMO\client\controllers\KanbanController::class => ['repositories' => ['main' => ['$' => '#kanban']]], ]); ``` - It reads GitHub the first time something asks for one of its collections, through [`ProjectBoard`](https://mmoframework.fr/en/documentation/mmo.git/php/helpers/ProjectBoard.md#projectboard) (a `project`) or [`IssueBoard`](https://mmoframework.fr/en/documentation/mmo.git/php/helpers/IssueBoard.md#issueboard) (the issues of `repository`, or of GitHubAPI's). The board is named [`$board`](https://mmoframework.fr/en/documentation/mmo.git/php/helpers/GitHubRepository.md#githubrepository-board). - A ticket's comments are read the first time a query asks for them by ticket (`['ticket' => '12']`): GitHub answers them issue by issue ([`IssueDiscussion`](https://mmoframework.fr/en/documentation/mmo.git/php/helpers/IssueDiscussion.md#issuediscussion)). - `\MMO\commit()` writes the changes: the board's and its tickets' through the board's `save()`, which changes only what differs from what was read; a new ticket gets its id there (an issue's number, `d<n>` for a project's draft). A comment is added, changed or deleted on GitHub (only the token owner's). - What GitHub has no place for -- the icons, the colours it does not keep ([`aBoard::keepsColor`](https://mmoframework.fr/en/documentation/mmo.git/php/classes/aBoard.md#aboard-keepscolor)), a status's type set in the board's settings -- is kept in [`$looks`](https://mmoframework.fr/en/documentation/mmo.git/php/helpers/GitHubRepository.md#githubrepository-looks). - A project's draft has no comments: [`toIssue`](https://mmoframework.fr/en/documentation/mmo.git/php/helpers/GitHubRepository.md#githubrepository-toissue) makes an issue of it, in [`$repository`](https://mmoframework.fr/en/documentation/mmo.git/php/helpers/GitHubRepository.md#githubrepository-repository). - It needs mmo.client, whose entities it holds, and a token for anything but a public repository's issues.

$repository = \MMO\get('kanban'); $ticket = $repository->getCollectionByClass(KanbanTicket::class)->getById('12'); $ticket->set('statusId', 'done'); \MMO\commit($this); // closes the issue #12

Index

	LOOKS
	api
	board
	cacheTtl
	discussed
	github
	looks
	made
	project
	repository
	snapshot
	source
	unlisted
	unremoved
	applyLooks($data)
	cacheFile()
	collectionOf($class)
	commentData($ticket, $comment)
	createEntity($class, $data, $collection)	Same as `Repository::createEntity`, but a new entity's id is a placeholder until GitHub gives it its own: a number could be an issue's already.
	discuss($ticket)	Read a ticket's comments, once.
	discussion($ticket)
	dropCache()	Forget what GitHub answered: the next request reads it again.
	executeQuery($query, $opts)	Same as `Repository::executeQuery`, reading first the comments of the tickets a query of comments names.
	fetch()	Read the board from GitHub, and keep what it answered for the next requests.
	fromCache()
	getApi()
	getCollection($name)
	getCollectionByClass($entityClass, $allowChildClass)
	getCollections()
	getSource()
	getViewer()
	isGone($ticket, $locator)
	isWritable()
	keepLooks($data)	Keep what the board's data gives that GitHub does not keep: the icons, the colours of `aBoard::keepsColor`, and a status's type when it is not the one the board works out.
	locator($ticket)
	made($entity)	an entity read from GitHub is not a new one
	makesIssues()
	onCommit($commit)	Write to GitHub the changes of its entities: the board's and the tickets' first, then the comments'.
	read()	Read the board from GitHub into its collections, once.
	readLooks()
	ref($ticket, $url)	What a ticket is called on GitHub, and where it is: what mmo.git's BoardSync writes on the local ticket it is paired with, for a person holding GitHub's number to find it (the local and the remote …
	reload()	Forget the board as it was read, and what GitHub answered: what is asked next is read from GitHub again (what it kept of a change, the ids it gave).
	remember($after)
	renamed($draft, $issue)	A draft is an issue now: its ticket takes the issue's number, in what was read and in its collection.
	saveBoard()	Save the board and its tickets as they are now: the board's `save()` compares them with `$snapshot`.
	saveComment($comment, $removed)	Add, change or delete a comment on GitHub.
	setApi($api)	Talk to GitHub through another client than `GitHubAPI::Shared()`: before anything is read.
	toIssue($ticket)	Make an issue of a project's draft, in `$repository`, for it to have a discussion.
	uid()
	__construct($collections, $project, $repository, $board, $looks, $cacheTtl)

Constants1

LOOKS

const LOOKS = […3 items]

Properties13

api

#[MMO\core\attributes\Serialize(false)] protected ?MMO\git\GitHubAPI $api = null

Type: null | GitHubAPI

board

string $board = 'main'

Type: string

cacheTtl

int $cacheTtl = 60

Type: int

discussed

#[MMO\core\attributes\Serialize(false)] protected array $discussed = []

Type: array

github

#[MMO\core\attributes\Serialize(false)] protected ?array $github = null

Type: null | array

looks

?string $looks = null

Type: null | string

made

#[MMO\core\attributes\Serialize(false)] protected int $made = 0

Type: int

project

?string $project = null

Type: null | string

repository

?string $repository = null

Type: null | string

snapshot

#[MMO\core\attributes\Serialize(false)] protected ?array $snapshot = null

Type: null | array

source

#[MMO\core\attributes\Serialize(false)] protected ?MMO\git\classes\aBoard $source = null

Type: null | aBoard

unlisted

#[MMO\core\attributes\Serialize(false)] protected array $unlisted = []

Type: array

unremoved

#[MMO\core\attributes\Serialize(false)] protected array $unremoved = []

Type: array

Methods36

applyLooks($data)

GitHubRepository.php:588

protected function applyLooks(array $data): array

$data	array	the board's data, as GitHub has it
returns	array	it, with the looks kept for it

cacheFile()

GitHubRepository.php:482

protected function cacheFile(): ?string

returns

null | string

the file keeping it: by board and by token, which may not see the same things; null without

collectionOf($class)

GitHubRepository.php:252

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

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

commentData($ticket, $comment)

GitHubRepository.php:232

protected function commentData(string $ticket, array $comment): array

$ticket	string
$comment	array	as `IssueDiscussion::toComment` gives it
returns	array	the properties of a KanbanComment

createEntity($class, $data, $collection)

GitHubRepository.php:260

Same as Repository::createEntity, but a new entity's id is a placeholder until GitHub gives it its own: a number could be an issue's already.

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

discuss($ticket)

GitHubRepository.php:215

Read a ticket's comments, once.

protected function discuss(string $ticket): void

$ticket	string	its id
returns	void

discussion($ticket)

GitHubRepository.php:475

protected function discussion(string $ticket): MMO\git\helpers\IssueDiscussion

$ticket	string
returns	IssueDiscussion	its discussion
throws		when it has none (a draft)

dropCache()

GitHubRepository.php:538

Forget what GitHub answered: the next request reads it again.

function dropCache(): void

returns

void

executeQuery($query, $opts)

GitHubRepository.php:180

Same as Repository::executeQuery, reading first the comments of the tickets a query of comments names.

function executeQuery(MMO\core\entities\Query $query, array $opts = []): Generator

$query	Query
$opts = []	array
returns	Generator

fetch()

GitHubRepository.php:501

Read the board from GitHub, and keep what it answered for the next requests.

protected function fetch(): array

returns

array

the board's data, as GitHub has it

fromCache()

GitHubRepository.php:488

protected function fromCache(): ?array

returns

null | array

the board's data GitHub answered last, when it is recent enough; the board's state set back

getApi()

GitHubRepository.php:127

function getApi(): MMO\git\GitHubAPI

returns

GitHubAPI

getCollection($name)

GitHubRepository.php:159

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

$name	string
returns	iCollection

getCollectionByClass($entityClass, $allowChildClass)

GitHubRepository.php:169

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

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

getCollections()

GitHubRepository.php:164

function getCollections(): array

returns

array

getSource()

GitHubRepository.php:139

function getSource(): MMO\git\classes\aBoard

returns

aBoard

the board GitHub has: a project's, or a repository's issues

getViewer()

GitHubRepository.php:150

function getViewer(): ?array

returns

null | array

string, name: string, avatar: string, url: string}|null the token's owner, who writes

isGone($ticket, $locator)

GitHubRepository.php:404

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

$ticket	string	a ticket the board read from GitHub leaves out
$locator	null \| string	what `locator` gave for it
returns	null \| bool	whether GitHub confirms it is gone (`aBoard::isGone`): true gone, false there still, null unknown

isWritable()

GitHubRepository.php:145

function isWritable(): bool

returns

bool

whether it can write: with a token

keepLooks($data)

GitHubRepository.php:560

Keep what the board's data gives that GitHub does not keep: the icons, the colours of aBoard::keepsColor, and a status's type when it is not the one the board works out.

protected function keepLooks(array $data): void

$data	array	the board's data
returns	void

locator($ticket)

GitHubRepository.php:394

function locator(string $ticket): ?string

$ticket	string	a ticket's id
returns	null \| string	what finds it on GitHub without listing the board (`aBoard::locator`): to keep while it is listed, for `isGone` to ask once it is not

made($entity)

GitHubRepository.php:241

an entity read from GitHub is not a new one

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

$entity	iEntity
returns	void

makesIssues()

GitHubRepository.php:425

function makesIssues(): bool

returns bool whether drafts can become issues (toIssue): a project's, given a $repository

onCommit($commit)

GitHubRepository.php:273

Write to GitHub the changes of its entities: the board's and the tickets' first, then the comments'.

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

$commit	Commit
returns	void
throws		when GitHub refuses a change: the ones made before it are made

read()

GitHubRepository.php:196

Read the board from GitHub into its collections, once.

protected function read(): void

returns	void
throws		when GitHub refuses

readLooks()

GitHubRepository.php:548

protected function readLooks(): array

returns array every board's looks, as $looks keeps them

ref($ticket, $url)

GitHubRepository.php:417

What a ticket is called on GitHub, and where it is: what mmo.git's BoardSync writes on the local ticket it is paired with, for a person holding GitHub's number to find it (the local and the remote ids differ).

function ref(string $ticket, ?string $url = null): array

$ticket	string	a ticket's id: an issue's number, or a project's draft (`d<n>`)
$url = null	null \| string	its page, when the board read gives one
returns	array	string, url: ?string} `gh#255` and the issue's page, or `gh draft` and the project's

$github->ref('255'); // ['ref' => 'gh#255', 'url' => 'https://github.com/oviepro/dev.oviepro/issues/255']

reload()

GitHubRepository.php:528

Forget the board as it was read, and what GitHub answered: what is asked next is read from GitHub again (what it kept of a change, the ids it gave). The entities held are dropped from their collections, unsaved changes with them.

function reload(): void

returns

void

remember($after)

GitHubRepository.php:353

protected function remember(array $after): array

$after	array	the data just saved
returns	array	it, with what GitHub had of each ticket and the data does not tell (a project's item and content)

renamed($draft, $issue)

GitHubRepository.php:453

A draft is an issue now: its ticket takes the issue's number, in what was read and in its collection. Not read again: GitHub lists the drafts made a moment before late, and a board read without them says they were removed.

protected function renamed(string $draft, string $issue): void

The tickets naming the draft (`parent`, `constraint`) are the caller's to write again ([`BoardSync::issues`](https://mmoframework.fr/en/documentation/mmo.git/php/helpers/BoardSync.md#boardsync-issues)).

$draft	string	the draft's id (`d<n>`)
$issue	string	the issue's number
returns	void

saveBoard()

GitHubRepository.php:292

Save the board and its tickets as they are now: the board's save() compares them with $snapshot.

protected function saveBoard(): array

returns

array

true> the tickets removed

saveComment($comment, $removed)

GitHubRepository.php:367

Add, change or delete a comment on GitHub.

protected function saveComment(MMO\client\entities\KanbanComment $comment, array $removed): void

$comment	KanbanComment
$removed	array
returns	void

setApi($api)

GitHubRepository.php:132

Talk to GitHub through another client than GitHubAPI::Shared(): before anything is read.

function setApi(?MMO\git\GitHubAPI $api): static

$api	null \| GitHubAPI
returns	static

toIssue($ticket)

GitHubRepository.php:436

Make an issue of a project's draft, in $repository, for it to have a discussion. Its entities are read again the next time they are asked for (reload): changes not committed are lost.

function toIssue(string $ticket): string

$ticket	string	the draft's id (`d<n>`); a ticket already an issue keeps its id
returns	string	the ticket's id now: its issue's number
throws		when it cannot (`makesIssues`), the ticket is not the board's, or GitHub refuses

uid()

GitHubRepository.php:123

function uid(): string

returns

string

__construct($collections, $project, $repository, $board, $looks, $cacheTtl)

GitHubRepository.php:114

function __construct( array $collections = [], ?string $project = null, ?string $repository = null, string $board = 'main', ?string $looks = null, int $cacheTtl = 60 )

$collections = []	array	see `aRepository::setCollections`
$project = null	null \| string
$repository = null	null \| string
$board = 'main'	string
$looks = null	null \| string
$cacheTtl = 60	int

Inherited members (26)

	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`.
`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 (`?search[type]=$text` of `RepositoryController::routeGet`), on top of the query's own filters, its sort and its page.
`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