Index

EmbeddedEntity

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

class

EmbeddedEntity

EmbeddedEntity.php:24

An entity that lives embedded inside another entity's property ($parent/$key) instead of its own collection -- has no collection/repository of its own (getCollection/getRepository delegate to the parent), and any change to it also marks the parent's own property changed (markChanged), since that's where it's actually persisted.

#[MMO\core\attributes\ArrayProperty(name: 'parentIndex', getter: 'getParentIndex', setter: 'setParentIndex', schema: […4 items])] class MMO\core\entities\EmbeddedEntity extends MMO\core\classes\aEntity
Namespace
MMO\core\entities
Extends
aEntity
NOTE: the position-tracking methods here ([`getParentIndex`](https://mcp.mmoframework.fr/documentation/mmo.core/php/entities/EmbeddedEntity.md#embeddedentity-getparentindex)/[`setParentIndex`](https://mcp.mmoframework.fr/documentation/mmo.core/php/entities/EmbeddedEntity.md#embeddedentity-setparentindex), and everything built on them: [`getPath`](https://mcp.mmoframework.fr/documentation/mmo.core/php/entities/EmbeddedEntity.md#embeddedentity-getpath)/[`getId`](https://mcp.mmoframework.fr/documentation/mmo.core/php/entities/EmbeddedEntity.md#embeddedentity-getid)/[`uid`](https://mcp.mmoframework.fr/documentation/mmo.core/php/entities/EmbeddedEntity.md#embeddedentity-uid)/[`localName`](https://mcp.mmoframework.fr/documentation/mmo.core/php/entities/EmbeddedEntity.md#embeddedentity-localname)) only work correctly when $parent's #[ArrayProperty] for $key uses a direct-property getter (e.g. `getter: '$items'`) -- PHP can only return a true write-through reference through a chain of `function &` methods when the innermost one returns an actual object property, not a computed/method-based one ([`tArrayProperties::getArrayProperty`](https://mcp.mmoframework.fr/documentation/mmo.core/php/classes/tArrayProperties.md#tarrayproperties-getarrayproperty)'s own "reference cannot work" fallback for that case). This is how every #[ArrayProperty] holding embedded entities is expected to be declared in practice.

Index

key readonly
parent readonlyThe entity this one is embedded within.
Copy($entity, $parent, $key, $properties) staticBuild a copy of $entity, re-parented under a (possibly different) $parent/$key.
getCollection()
getId()
getParentIndex()
getPath()
getRepository()
localName()
markChanged($keys)Same as aEntity::markChanged, also marking the parent's own $key property changed (since that's where this entity is actually stored).
setParentIndex($index)Move this entity to a different position within $parent[$key] (removing it from its current position first, if any), and mark the parent changed.
uid()
__construct($parent, $key, $data)

Properties2

key

readonly
readonly string $key
Type
string

parent

readonly

The entity this one is embedded within.

readonly MMO\core\interfaces\iEntity $parent
Type
iEntity

Methods11

Copy($entity, $parent, $key, $properties)

staticEmbeddedEntity.php:49

Build a copy of $entity, re-parented under a (possibly different) $parent/$key.

static function Copy( self $entity, MMO\core\interfaces\iEntity $parent, string $key, ?array $properties = null ): static
$entityself
$parentiEntity
$keystring
$properties = nullnull | arrayif given, only copy these properties.
returnsstatic

getParentIndex()

EmbeddedEntity.php:66
function getParentIndex(): string|int|null
returnsstring | int | nullthis entity's position within $parent[$key] if that's a list (its numeric index or array key), or null if $parent[$key] isn't an array or doesn't (yet) contain this entity.

setParentIndex($index)

EmbeddedEntity.php:79

Move this entity to a different position within $parent[$key] (removing it from its current position first, if any), and mark the parent changed.

function setParentIndex(string|int|null $index): bool
$indexstring | int | nulla numeric index (inserted there, shifting later items), a string key (assoc-array style), or null to append.
returnsboolfalse if $parent[$key] isn't an array, or $index is unchanged.

__construct($parent, $key, $data)

EmbeddedEntity.php:35
function __construct(MMO\core\interfaces\iEntity $parent, string $key, array $data = [])
$parentiEntity
$keystringthe parent's property this entity is stored under.
$data = []arrayinitial property values.
Inherited members (86)
ConstantsDeclared byDescription
FLAG_CHANGEDiEntity
FLAG_CREATEDiEntity
FLAG_IGNORE_CHANGEiEntity
FLAG_IGNORE_ENTITYiEntity
FLAG_OPACIFYiEntity
FLAG_REMOVEDiEntity
PropertiesDeclared byDescription
ArrayPropertiesaEntity
changesaEntity
errorsaEntity
flagsaEntity
linksaEntity
SearchPropertiesaEntity
statusaEntity
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.
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
getErrors()aEntity
getFlags()aEntity
getLabel()aEntity
getLinks()aEntity
getLinksByRel($rels, $all)aEntityGet a list of Reference that have a specific relationship.
getMetadata()aEntity
getStatus()aEntity
getTitle()aEntity
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…
ignoreChanges($value)aEntityTemporarily suppress markChanged (used e.g.
isActive()aEntity
isArchive()aEntity
isArrayPropertySet($key, $store)aEntity
isChanged()aEntity
isCreated()aEntity
isDraft()aEntity
isEmpty()aEntity
isFinal()aEntity
isHiddenPath($path)aEntity
isOpacified()aEntity
isPending()aEntity
isRemoved()aEntity
isSimilar($value)aEntityCompare entities using unique fields (@unique), to find if they represent the same 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)aEntitySet every entry of $data as an array property, through setArrayProperty (so each value is coerced by its property's schema).
loadFromStore($data)aEntityLoad $data as this entity's initial state (e.g.
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.
removeFlags($flags)aEntity
removeLink($link)aEntityRemove a link (by identity).
removePermanently()aEntityRemove this entity from the repository once MMO\commit() is called WARNING: This will permanently remove the entity.
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…
setLinks($links)aEntityReplace every link with $links.
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.
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