Index

KanbanTicket

MMO\client\entities · 1 symbol · generated 5 Oct 2026

class

KanbanTicket

KanbanTicket.php:19

A ticket of a <mmo-kanban> board (KanbanBoard, named by board).

class MMO\client\entities\KanbanTicket extends MMO\core\entities\Entity
Namespace
MMO\client\entities
Extends
Entity
Its properties are the kanban's ticket's but one: the ticket's `status` (the id of one of its board's statuses) is `statusId` here, `status` being every entity's lifecycle. [`FromKanban`](https://mcp.mmoframework.fr/documentation/mmo.client/php/entities/KanbanTicket.md#kanbanticket-fromkanban) and [`toKanban`](https://mcp.mmoframework.fr/documentation/mmo.client/php/entities/KanbanTicket.md#kanbanticket-tokanban) convert one into the other. Its id is the ticket's: the one its repository gives it (a number, or a GitHub issue's).
$ticket = $tickets->createEntity(['board' => 'main'] + KanbanTicket::FromKanban(['title' => 'Ship', 'status' => 'todo'])); $ticket->toKanban()['status']; // 'todo'

Index

FIELDSthe kanban's fields a ticket is made of, besides its id
assigneeWho it is assigned to: the id of one of its board's people, or anyone.
boardThe name of its board.
categoryThe id of one of its board's categories.
commentsHow many comments its discussion has.
constraint
descriptionMarkdown.
doneAtWhen it was done ('': it was, nobody knows when), null while it is not.
endWhen it is planned to end: YYYY-MM-DD.
labels
parentThe id of the ticket it is a sub-ticket of.
positionIts place on its board: the tickets are in this order.
startWhen it is planned to start: YYYY-MM-DD.
startedAtWhen it started ('': it did, nobody knows when), null while it has not.
statusIdThe id of one of its board's statuses: the kanban ticket's status.
urlWhere it is, elsewhere: a GitHub issue's page, say.
FromKanban($ticket) static
toKanban()

Constants1

FIELDS

the kanban's fields a ticket is made of, besides its id

const FIELDS = […13 items]

Properties15

assignee

Who it is assigned to: the id of one of its board's people, or anyone.

#[MMO\core\attributes\ArrayProperty()] protected string $assignee = ''
Type
string

board

The name of its board.

#[MMO\core\attributes\ArrayProperty()] protected string $board = ''
Type
string

category

The id of one of its board's categories.

#[MMO\core\attributes\ArrayProperty()] protected ?string $category = null
Type
null | string

comments

How many comments its discussion has.

#[MMO\core\attributes\ArrayProperty()] protected int $comments = 0
Type
int

constraint

#[MMO\core\attributes\ArrayProperty()] protected ?array $constraint = null
Type
null | array

description

Markdown.

#[MMO\core\attributes\ArrayProperty()] protected string $description = ''
Type
string

doneAt

When it was done ('': it was, nobody knows when), null while it is not.

#[MMO\core\attributes\ArrayProperty()] protected ?string $doneAt = null
Type
null | string

end

When it is planned to end: YYYY-MM-DD.

#[MMO\core\attributes\ArrayProperty()] protected ?string $end = null
Type
null | string

labels

#[MMO\core\attributes\ArrayProperty()] protected array $labels = []
Type
array

parent

The id of the ticket it is a sub-ticket of.

#[MMO\core\attributes\ArrayProperty()] protected ?string $parent = null
Type
null | string

position

Its place on its board: the tickets are in this order.

#[MMO\core\attributes\ArrayProperty()] protected int $position = 0
Type
int

start

When it is planned to start: YYYY-MM-DD.

#[MMO\core\attributes\ArrayProperty()] protected ?string $start = null
Type
null | string

startedAt

When it started ('': it did, nobody knows when), null while it has not.

#[MMO\core\attributes\ArrayProperty()] protected ?string $startedAt = null
Type
null | string

statusId

The id of one of its board's statuses: the kanban ticket's status.

#[MMO\core\attributes\ArrayProperty()] protected string $statusId = ''
Type
string

url

Where it is, elsewhere: a GitHub issue's page, say.

#[MMO\core\attributes\ArrayProperty()] protected ?string $url = null
Type
null | string

Methods2

FromKanban($ticket)

staticKanbanTicket.php:99
static function FromKanban(array $ticket): array
$ticketarraya ticket, as <mmo-kanban>'s data holds it (its id is not read)
returnsarrayits properties: only the fields it has
Inherited members (111)
ConstantsDeclared byDescription
FLAG_CHANGEDiEntity
FLAG_CREATEDiEntity
FLAG_IGNORE_CHANGEiEntity
FLAG_IGNORE_ENTITYiEntity
FLAG_OPACIFYiEntity
FLAG_REMOVEDiEntity
PropertiesDeclared byDescription
ArrayPropertiesaEntity
changesaEntity
collectionEntity
ctimeEntity
errorsaEntity
flagsaEntity
idEntityidentifier in collection
labelEntityshort name
linksaEntity
mtimeEntity
SearchPropertiesaEntity
statusaEntity
titleEntitylong name
MethodsDeclared byDescription
addFlags($flags)aEntity
addLink($link)aEntityAppend a link.
archive()aEntityThis function is called to 'delete' the entity.
ArrayProperties()aEntityBuild (once per class, then cached in the static $ArrayProperties array) the list of every #[ArrayProperty] declared on this class, its parent classes, and the traits they use -- by reflection…
ArrayProperty($name)aEntity
CheckData($data, $errors)aEntityCheck data before it touches any entity: would an entity made from $data be valid?
clearChanges()aEntityReset change tracking: clears iEntity::FLAG_CHANGED and forgets every recorded change.
compareTo($value)aEntityCompare value
conversionError($key, $e)aEntityThe error recorded for a value that could not be set at all (usually: it could not be converted to its property's type), in the same form as a validation error.
Copy($entity, $properties)EntityBuild a new entity from $entity's own stored data (a duplicate, minus its id -- so saving it creates a genuinely new record -- in the same collection).
debugName()aEntity
get($path, $default)aEntityRead a (possibly nested) value by json-path, e.g.
getArrayProperty($key, $isRef, $store)aEntityRead a single array property's current value, through its getter (a direct property, a path alias, or a method).
getChanges($asArray, $store)aEntity
getCollection()Entity
getCtime()Entity
getErrors()aEntity
getFlags()aEntity
getId()Entity
getLabel()Entity
getLinks()aEntity
getLinksByRel($rels, $all)aEntityGet a list of Reference that have a specific relationship.
getMetadata()aEntity
getMtime()Entity
getRepository()Entity
getStatus()aEntity
getTitle()Entity
getView()aEntity
hasChanged($keys)aEntity
hasFlags($flags, $strict)aEntity
hasStatusChanged()aEntity
HiddenPath($path)aEntityThe hidden property (ArrayProperty::isHidden) a json-path goes through, known from the declared types alone: of this class, or of a class a property on the way may hold -- every class of its t…
ignore()EntityIgnore everything about this entity: discard its pending changes and flag it so it's skipped by future commits (aRepository::onCommit).
ignoreChanges($value)aEntityTemporarily suppress markChanged (used e.g.
isActive()aEntity
isArchive()aEntity
isArrayPropertySet($key, $store)EntitySame as aEntity::isArrayPropertySet, but 'ctime'/'mtime' are never reported as "set" (they're always present, so listing them adds no information), and neither is 'id' once the entity is alrea…
isChanged()aEntity
isCreated()aEntity
isDraft()aEntity
isEmpty()aEntity
isFinal()aEntity
isHiddenPath($path)aEntity
isIgnored()Entity
isOpacified()aEntity
isPending()aEntity
isRemoved()aEntity
isSimilar($value)Entity
isUnique()aEntityTells if an entity has enough information to be unique (at least one unique group has no null)
isValid()aEntity
isValidated()aEntity
ListClassReferences($onlyStorable)aEntityGet a list of all the classes and their properties that are using references to this class.
loadArray($data, $coerceOptions, $fromStore)EntitySame as aEntity::loadArray, but 'ctime'/'mtime' are never taken from $data: they belong to the server (set when the entity is created, bumped by markChanged), and a client sending back th…
loadFromStore($data)EntityRestore from stored data, setting 'ctime'/'mtime' directly (bypassing their normal setters -- see setCtime/setMtime, which are read-only via #[ArrayProperty]).
localName()Entity
loopReferences()EntityYield all the entities in the repository that have a reference on this one.
markChanged($keys)EntitySame as aEntity::markChanged, also bumping $mtime to now -- unless the change itself was to 'ctime'/'mtime' (avoiding infinite recursion via setMtime's own markChanged call).
mutate($type, $path, $value, $oldValue)aEntity\MMO\core\interfaces\iMutationObserver::mutate -- besides the normal tArrayProperties::mutate behavior, walks up $path to find the nearest enclosing aEntity (the mutation may have happened dee…
offsetExists($key)aEntity\ArrayAccess::offsetExists -- tells whether $key is a *declared* #[ArrayProperty], not whether it currently holds a non-default value (use isArrayPropertySet for that).
offsetGet($key)aEntity\ArrayAccess::offsetGet
offsetSet($key, $value)aEntity\ArrayAccess::offsetSet
offsetUnset($key)aEntity\ArrayAccess::offsetUnset -- equivalent to setting the property to null (its coerced value depends on the property's schema: e.g.
opacify($value)aEntityHide this entity's properties from toArray output (typically used to redact an entity the current viewer isn't allowed to see the details of, while still letting it be referenced by uid/metadata).
push($path, $value)aEntityAppend a value to a (possibly nested) list property by json-path.
reload()EntityReload entity from its repository
removeFlags($flags)aEntity
removeLink($link)aEntityRemove a link (by identity).
removePermanently($force)EntityRemove entity from database
replaceBy($replace, $mergeData)EntityReplace this entity by another one, trying to change all references to this entity to the new one.
Schema()aEntityThe JSON-Schema describing every #[ArrayProperty] of this class (built once and cached by ArrayProperties).
SearchProperty($name)aEntity
set($path, $value)aEntityWrite a (possibly nested) value by json-path, creating intermediate structure as needed.
setArrayProperty($key, $value, $coerceOptions, $ignoreReadonly)aEntitySame as tArrayProperties::setArrayProperty, plus: any coercion/validation failure is caught and recorded in getErrors (making the entity isValid()-false) instead of propagating as an…
setArrayPropertyOffset($key, $offset, $value, $coerceOptions)aEntitySame as tArrayProperties::setArrayPropertyOffset, plus: when pushing (offset === null) a new entity onto a list property, if an existing item is isSimilar to the new value, that item's of…
setCollection($collection, $removeFromCollection)EntityMove this entity to (or out of, if null) a collection.
setCtime($date, $force)EntitySet creation time
setId($id)EntitySet the id, re-registering this entity in its $collection under the new id (Collection's entities are keyed by id).
setLinks($links)aEntityReplace every link with $links.
setMtime($date, $force)EntitySet modification time
setStatus($status)aEntity
store()aEntityExport all array properties with store set to true.
test($filter)aEntity
toArray($fields, $flatten, $recursive)aEntitySame as tArrayProperties::toArray, except an isOpacified entity always exports only its 'uid' and 'metadata' (its other properties are hidden from output).
toLink($attributes)aEntity
traitMutate($type, $path, $value, $oldValue)aEntity\MMO\core\interfaces\iMutationObserver::mutate -- reacts to a mutation that happened deep inside one of this object's array properties (e.g.
traitSetArrayProperty($key, $value, $coerceOptions, $fromStore)aEntitySet array property
traitSetArrayPropertyOffset($key, $offset, $value, $coerceOptions)aEntitySet/push a value into an array property
traitToArray($fields, $flatten, $recursive)aEntityExport fields to an array.
uid()Entity
validate($errors)aEntityValidate this entity: its current values against its own tArrayProperties::Schema, plus every value that could not even be set -- one that could not be converted to its property's type never r…
View()aEntity
__construct($data, $collection)Entity