Label

MMO\edms\entities · 1 symbole · générée le 27 Oct 2026

class

Label

A node of the label tree: the tree is at the same time the folders of the files (under _FILESYSTEM) and their tags (under _TAGS, a client's own ones under {client}/_TAGS, FileManager).

#[MMO\core\attributes\ArrayProperty(name: 'path', getter: 'getPath', schema: ['description' => 'Label path'])] class MMO\edms\entities\Label extends MMO\core\entities\Entity implements MMO\oauth\interfaces\iWithScope, MMO\oauth\interfaces\iGuarded, Stringable

Espace de noms: MMO\edms\entities
Étend: Entity
Implémente: iWithScope, iGuarded, Stringable

A label is in a client's space when it has an [`$owner`](https://mmoframework.fr/documentation/mmo.edms/php/entities/Label.md#label-owner), the client that can do anything with it; a label of nobody is everyone's, and its scope says who can use it ([`scopeID`](https://mmoframework.fr/documentation/mmo.edms/php/entities/Label.md#label-scopeid), [`Access`](https://mmoframework.fr/documentation/mmo.edms/php/helpers/Access.md#access)). edms guards its labels itself (iGuarded): mmo.oauth's AccessController asks for no `data.*` scope but in the generic data api.

Index

	MAX_DEPTH	the depth `getChildren` goes to at most
	color	Label color
	description	Label description
	owner	The client whose space the label is in, null for everyone's: a label takes its parent's
	parent	Label parent: moving a label is edms's to do (`FileManager`)
	properties	The custom fields of the files carrying the label: a json schema's `properties`
	contains($label)
	getChildByName($name, $create)
	getChildren($recursive)
	getOwner()
	getParent()
	getPath()
	isOwnedBy($client)
	loopParents()	This label, then its parent, up to its root: each label once, should the parents make a loop (a client writing the labels' collection could make one) -- a warning says so, and the loop can be undon…
	scopeID($action)
	__toString()

Constantes1

MAX_DEPTH

the depth getChildren goes to at most

const MAX_DEPTH = 64

Propriétés5

color

Label color

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

Type: string

description

Label description

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

Type: string

owner

The client whose space the label is in, null for everyone's: a label takes its parent's

#[MMO\core\attributes\ArrayProperty(setter: false, store: true)] protected ?MMO\oauth\interfaces\iClient $owner = null

Type: null | iClient

parent

Label parent: moving a label is edms's to do (FileManager)

#[MMO\core\attributes\ArrayProperty(setter: false, store: true)] protected ?MMO\edms\entities\Label $parent = null

Type: null | Label

properties

The custom fields of the files carrying the label: a json schema's properties

#[MMO\core\attributes\ArrayProperty(schema: '{object}')] protected array $properties = []

Type: array

Méthodes10

contains($label)

Label.php:82

function contains(MMO\edms\entities\Label $label): bool

$label	Label
retourne	bool	true if $label is this one, or under it

getChildByName($name, $create)

Label.php:121

function getChildByName(string $name, bool $create = false): ?self

$name	string
$create = false	bool
retourne	null \| self

getChildren($recursive)

Label.php:107

function getChildren(bool $recursive = false): array

$recursive = false	bool
retourne	array	the labels under this one: its children, or all its descendants if $recursive

getOwner()

Label.php:72

function getOwner(): ?MMO\oauth\interfaces\iClient

retourne

null | iClient

getParent()

Label.php:68

function getParent(): ?MMO\edms\entities\Label

retourne

null | Label

getPath()

Label.php:130

function getPath(): string

retourne

string

isOwnedBy($client)

Label.php:77

function isOwnedBy(MMO\oauth\interfaces\iClient $client): bool

$client	iClient
retourne	bool	true if the label is in the space of $client

loopParents()

Label.php:94

This label, then its parent, up to its root: each label once, should the parents make a loop (a client writing the labels' collection could make one) -- a warning says so, and the loop can be undone, as nothing throws

function loopParents(): Generator

retourne

Generator

scopeID($action)

Label.php:64

function scopeID(string $action = ''): string

$action = ''	string	`show`, `edit`, `delete` or `create` (`Access`)
retourne	string	the scope granting $action on the label, and on every label under it

$user->allow($label->scopeID('show')); // edms.labels.12#show

__toString()

Label.php:55

function __toString(): string

retourne

string

Membres hérités (112)

	Constantes	Déclaré par	Description
	`FLAG_CHANGED`	iEntity
	`FLAG_CREATED`	iEntity
	`FLAG_IGNORE_CHANGE`	iEntity
	`FLAG_IGNORE_ENTITY`	iEntity
	`FLAG_OPACIFY`	iEntity
	`FLAG_REMOVED`	iEntity

Propriétés	Déclaré par	Description
`ArrayProperties`	aEntity
`changes`	aEntity
`collection`	Entity
`ctime`	Entity
`errors`	aEntity
`flags`	aEntity
`id`	Entity	identifier in collection
`label`	Entity	short name
`links`	aEntity
`mtime`	Entity
`SearchProperties`	aEntity
`status`	aEntity
`title`	Entity	long name

Méthodes	Déclaré par	Description
`addFlags($flags)`	aEntity
`addLink($link)`	aEntity	Append a link.
`archive()`	aEntity	This function is called to 'delete' the entity.
`ArrayProperties()`	aEntity	Build (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)`	aEntity	Check data before it touches any entity: would an entity made from $data be valid?
`clearChanges()`	aEntity	Reset change tracking: clears `iEntity::FLAG_CHANGED` and forgets every recorded change.
`compareTo($value)`	aEntity	Compare value
`conversionError($key, $e)`	aEntity	The 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)`	Entity	Build 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)`	aEntity	Read a (possibly nested) value by json-path, e.g.
`getArrayProperty($key, $isRef, $store)`	aEntity	Read 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
`getInvalidItems($keys)`	aEntity	The items of the values set that could not be converted: a list or an object was given, one of its items was not valid (an unknown uid), so the property kept its previous value.
`getLabel()`	Entity
`getLinks()`	aEntity
`getLinksByRel($rels, $all)`	aEntity	Get 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)`	aEntity	The 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()`	Entity	Ignore everything about this entity: discard its pending changes and flag it so it's skipped by future commits (`aRepository::onCommit`).
`ignoreChanges($value)`	aEntity	Temporarily suppress `markChanged` (used e.g.
`isActive()`	aEntity
`isArchive()`	aEntity
`isArrayPropertySet($key, $store)`	Entity	Same 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()`	aEntity	Tells if an entity has enough information to be unique (at least one unique group has no null)
`isValid()`	aEntity
`isValidated()`	aEntity
`ListClassReferences($onlyStorable)`	aEntity	Get a list of all the classes and their properties that are using references to this class.
`loadArray($data, $coerceOptions, $fromStore)`	Entity	Same 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)`	Entity	Restore from stored data, setting 'ctime'/'mtime' directly (bypassing their normal setters -- see `setCtime`/`setMtime`, which are read-only via #[ArrayProperty]).
`localName()`	Entity
`loopReferences()`	Entity	Yield all the entities in the repository that have a reference on this one.
`markChanged($keys)`	Entity	Same 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)`	aEntity	Hide 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)`	aEntity	Append a value to a (possibly nested) list property by json-path.
`reload()`	Entity	Reload entity from its repository
`removeFlags($flags)`	aEntity
`removeLink($link)`	aEntity	Remove a link (by identity).
`removePermanently($force)`	Entity	Remove entity from database
`replaceBy($replace, $mergeData)`	Entity	Replace this entity by another one, trying to change all references to this entity to the new one.
`Schema()`	aEntity	The JSON-Schema describing every #[ArrayProperty] of this class (built once and cached by `ArrayProperties`).
`SearchProperty($name)`	aEntity
`set($path, $value)`	aEntity	Write a (possibly nested) value by json-path, creating intermediate structure as needed.
`setArrayProperty($key, $value, $coerceOptions, $ignoreReadonly)`	aEntity	Same 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)`	aEntity	Same 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)`	Entity	Move this entity to (or out of, if null) a collection.
`setCtime($date, $force)`	Entity	Set creation time
`setId($id)`	Entity	Set the id, re-registering this entity in its `$collection` under the new id (`Collection`'s entities are keyed by id).
`setLinks($links)`	aEntity	Replace every link with $links.
`setMtime($date, $force)`	Entity	Set modification time
`setStatus($status)`	aEntity
`store()`	aEntity	Export all array properties with `store` set to true.
`test($filter)`	aEntity
`toArray($fields, $flatten, $recursive)`	aEntity	Same 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)`	aEntity	Set array property
`traitSetArrayPropertyOffset($key, $offset, $value, $coerceOptions)`	aEntity	Set/push a value into an array property
`traitToArray($fields, $flatten, $recursive)`	aEntity	Export fields to an array.
`uid()`	Entity
`validate($errors)`	aEntity	Validate 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