ProjectBoard

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

class

ProjectBoard

A GitHub project (Projects v2: github.com/users/<login>/projects/<n>, or orgs/<login>/...) seen as the data of a kanban board (mmo.client's <mmo-kanban>), and the changes made on the board written back to the project.

class MMO\git\helpers\ProjectBoard extends MMO\git\classes\aBoard

Namespace: MMO\git\helpers
Extends: aBoard

Through the GraphQL API: it needs a token that can read projects, and write them to save (README.md says which). ### What an item becomes | ticket | project item | |---------------|-------------------------------------------------------------------------------------------| | statuses | the options of the `Status` field, in the project's order | | `id` | the issue's or pull request's number; `d<n>` for a draft | | `title`, `description`, `assignee`, `labels` | the issue's, pull request's or draft's (a draft has no label) | | `status` | its `Status`; an item without one has the first | | `category` | its value of [`$categoryField`](https://mcp.mmoframework.fr/documentation/mmo.git/php/helpers/ProjectBoard.md#projectboard-categoryfield): the project's first iteration field unless told | | `start`, `end`| its values of the date fields [`$startField`](https://mcp.mmoframework.fr/documentation/mmo.git/php/helpers/ProjectBoard.md#projectboard-startfield) and [`$endField`](https://mcp.mmoframework.fr/documentation/mmo.git/php/helpers/ProjectBoard.md#projectboard-endfield) | | `parent`, `constraint`, `startedAt` | a text field of the project, [`$metaField`](https://mcp.mmoframework.fr/documentation/mmo.git/php/helpers/ProjectBoard.md#projectboard-metafield), made the first time it is needed | A status is "done" when its name says so ([`$done`](https://mcp.mmoframework.fr/documentation/mmo.git/php/helpers/ProjectBoard.md#projectboard-done)), "not started" when it says that ([`$backlog`](https://mcp.mmoframework.fr/documentation/mmo.git/php/helpers/ProjectBoard.md#projectboard-backlog)), started otherwise. A new ticket is a draft issue of the project. A ticket removed from the board leaves the project: its issue, if it has one, stays as it is. The issues' state is not changed: the project's own workflows close an issue whose item is done, when they are set up to.

GitHubAPI::Configure(['token' => $token]); $board = ProjectBoard::FromUrl(GitHubAPI::Shared(), 'https://github.com/users/MarcMouret/projects/1'); $data = $board->load();

Index

	FIELD_NAME
	api
	backlog
	categoryField
	contents
	done
	endField
	metaField
	number
	organization
	owner
	project
	startField
	statusField
	users
	categories()
	discussion($ticketId)
	field($role)
	FromUrl($api, $url) static
	getState()
	getTitle()
	getUrl()
	load()	Read the project's items as a board's data.
	metaFieldOrCreate()
	project()
	save($before, $after)	Write to the project what changed on the board: a new ticket is a draft, a removed one leaves the project.
	setState($state)
	statusType($name)
	toFields($ticket, $statuses)
	toTicket($item, $statuses)
	userId($login)
	write($ticket, $old, $new)	Make the changes from $old to $new on the item.
	__construct($api, $owner, $number, $organization)

Constants1

FIELD_NAME

const FIELD_NAME = 'field {... on ProjectV2FieldCommon {name}}'

Properties14

api

protected MMO\git\GitHubAPI $api

Type: GitHubAPI

backlog

Type: string

categoryField

?string $categoryField = null

Type: null | string

protected array $contents = []

Type: array

done

Type: string

endField

?string $endField = null

Type: null | string

metaField

string $metaField = 'mmo-kanban'

Type: string

number

protected int $number

Type: int

organization

protected bool $organization

Type: bool

owner

protected string $owner

Type: string

project

protected ?array $project = null

Type: null | array

startField

?string $startField = null

Type: null | string

statusField

string $statusField = 'Status'

Type: string

users

protected array $users = []

Type: array

Methods18

categories()

ProjectBoard.php:266

protected function categories(): array

returns

array

the board's categories: the options or iterations of the category field

discussion($ticketId)

ProjectBoard.php:284

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

$ticketId	string
returns	null \| IssueDiscussion	the comments of its issue or pull request; null for a draft, which has none
throws		when the project cannot be read (it is, to know which repository the ticket's issue is in)

field($role)

ProjectBoard.php:245

protected function field(string $role): ?array

$role	string	`status`, `category`, `start`, `end` or `meta`
returns	null \| array	the project's field playing that role: `{id, name, dataType, options?, configuration?}`

FromUrl($api, $url)

staticProjectBoard.php:83

static function FromUrl(MMO\git\GitHubAPI $api, string $url): self

$api	GitHubAPI
$url	string	the project's page, `https://github.com/users/<login>/projects/<n>` or `.../orgs/...`
returns	self
throws		when it is not a project's url

ProjectBoard::FromUrl(GitHubAPI::Shared(), 'https://github.com/orgs/acme/projects/3/views/1');

getState()

ProjectBoard.php:404

function getState(): array

returns array ?array, contents: array} the project's ids and fields, and each item's (aBoard::getState)

getTitle()

ProjectBoard.php:96

function getTitle(): ?string

returns

null | string

the project's title, once read

getUrl()

ProjectBoard.php:91

function getUrl(): string

returns

string

the project's page

load()

ProjectBoard.php:109

Read the project's items as a board's data.

function load(): array

returns	array	array, labels: array, categories: array, tickets: array}
throws		when GitHub refuses, or there is no such project

metaFieldOrCreate()

ProjectBoard.php:423

protected function metaFieldOrCreate(): array

returns

array

the text field holding what the project has no field for, made the first time it is needed

project()

ProjectBoard.php:417

protected function project(): array

returns	array	the project as last read, read now if it was not: `{id, title, url, fields}`
throws		when it cannot be read

save($before, $after)

ProjectBoard.php:299

Write to the project what changed on the board: a new ticket is a draft, a removed one leaves the project.

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

$before	array	the board's data as `load` gave it: its tickets carry their `item` and `content`
$after	array	the board's data now
returns	array	array<string, string>} the id each new ticket got (`d<n>`), by the id the board gave it
throws		when GitHub refuses a change: the ones made before it are made

setState($state)

ProjectBoard.php:408

function setState(array $state): void

$state	array
returns	void

statusType($name)

ProjectBoard.php:274

protected function statusType(string $name): string

$name	string
returns	string	`backlog`, `active` or `done`, by the status's name

toFields($ticket, $statuses)

ProjectBoard.php:336

function toFields(array $ticket, array $statuses): array

$ticket	array
$statuses	array	the board's
returns	array	the values the ticket gives its item, compared by `save` to know what changed

toTicket($item, $statuses)

ProjectBoard.php:208

function toTicket(array $item, array $statuses): array

$item	array	as the GraphQL query of `load` gives it
$statuses	array	the board's
returns	array	the ticket. Beyond the board's fields, it carries what saving needs: `item` (the item's node id), `content` (the draft's node id, or the issue's `{repository, number}`) and `url`

userId($login)

ProjectBoard.php:435

protected function userId(string $login): string

$login	string
returns	string	the user's node id, which a draft's assignees are given as

write($ticket, $old, $new)

ProjectBoard.php:363

Make the changes from $old to $new on the item.

protected function write(array $ticket, array $old, array $new): void

$ticket	array	the ticket as it was read: its `item` and `content`
$old	array	`toFields`
$new	array	`toFields`
returns	void

__construct($api, $owner, $number, $organization)

ProjectBoard.php:73

function __construct( MMO\git\GitHubAPI $api, string $owner, int $number, bool $organization = false )

$api	GitHubAPI
$owner	string	the login owning the project
$number	int	the project's number, in its url
$organization = false	bool	whether the owner is an organization rather than a user

Inherited members (7)

	Constants	Declared by	Description
	`COLORS`	aBoard	the colours mmo-kanban names, as GitHub's label colours: a colour read from GitHub is named when it is one

Methods	Declared by	Description
`ColorHex($color)`	aBoard
`ColorName($color)`	aBoard
`keepsColor($kind)`	aBoard
`meta($ticket, $type)`	aBoard
`remap($ticket, $ids, $categories)`	aBoard	Give the board's ids of new tickets and categories the ones GitHub gave them.
`remapCondition($node, $ids)`	aBoard