iEntity

MMO\core\interfaces · 1 symbol · generated 30 Sep 2026

interface

iEntity

An entity: one record, its values read and written by property name, its changes tracked until a commit.

interface MMO\core\interfaces\iEntity extends MMO\core\interfaces\iArrayProperties, MMO\core\interfaces\iIdentifiable, MMO\core\interfaces\iComparable

Namespace: MMO\core\interfaces
Implements: iArrayProperties, iIdentifiable, iComparable
See: aEntity implements all of it (every entity extends it, through Entity or EmbeddedEntity): this interface declares what the framework itself relies on, so code typed against it works with any entity.

Index

	FLAG_CHANGED
	FLAG_CREATED
	FLAG_IGNORE_CHANGE
	FLAG_IGNORE_ENTITY
	FLAG_OPACIFY
	FLAG_REMOVED
	addFlags($flags) abstract
	archive() abstract
	clearChanges() abstract
	debugName() abstract
	get($path, $default) abstract
	getChanges($asArray, $store) abstract
	getCollection() abstract
	getErrors() abstract
	getFlags() abstract
	getId() abstract
	getRepository() abstract
	getStatus() abstract
	getTitle() abstract
	hasStatusChanged() abstract
	isArchive() abstract
	isChanged() abstract
	isCreated() abstract
	isFinal() abstract
	isRemoved() abstract
	isValid() abstract
	loadArray($data, $coerceOptions, $fromStore) abstract
	loadFromStore($data) abstract	Load data as read from storage: not recorded as a change.
	localName() abstract	Get the local name (collection name and this id) in the current repository
	markChanged($keys) abstract
	removeFlags($flags) abstract
	removePermanently() abstract	Remove it for good: only an archived entity can be.
	setArrayPropertyOffset($key, $offset, $value, $coerceOptions) abstract
	setStatus($status) abstract
	store() abstract
	test($filter) abstract
	toLink($attributes) abstract

Constants6

FLAG_CHANGED

const FLAG_CHANGED = 1

FLAG_CREATED

const FLAG_CREATED = 2

FLAG_IGNORE_CHANGE

const FLAG_IGNORE_CHANGE = 8

FLAG_IGNORE_ENTITY

const FLAG_IGNORE_ENTITY = 24

FLAG_OPACIFY

const FLAG_OPACIFY = 32

FLAG_REMOVED

const FLAG_REMOVED = 4

Methods31

addFlags($flags)

abstractiEntity.php:58

abstract function addFlags(int $flags): bool

$flags	int
returns	bool

archive()

abstractiEntity.php:74

abstract function archive(): bool

returns

bool

false if it could not be archived

clearChanges()

abstractiEntity.php:62

abstract function clearChanges(): void

returns

void

debugName()

abstractiEntity.php:40

abstract function debugName(): string

returns

string

get($path, $default)

abstractiEntity.php:44

abstract function get(string $path, mixed $default = null): mixed

$path	string
$default = null	mixed
returns	mixed	the value at $path (a property name, or a `/`-separated path into it), or $default

getChanges($asArray, $store)

abstractiEntity.php:61

abstract function getChanges(bool $asArray = false, bool $store = true): array

$asArray = false	bool
$store = true	bool
returns	array	the properties changed since the last commit

getCollection()

abstractiEntity.php:34

abstract function getCollection(): ?MMO\core\interfaces\iCollection

returns

null | iCollection

getErrors()

abstractiEntity.php:31

abstract function getErrors(): array

returns

array

getFlags()

abstractiEntity.php:57

abstract function getFlags(): int

returns

int

the FLAG_* bitmask

getId()

abstractiEntity.php:25

abstract function getId(): mixed

returns

mixed

getRepository()

abstractiEntity.php:35

abstract function getRepository(): ?MMO\core\interfaces\iRepository

returns

null | iRepository

getStatus()

abstractiEntity.php:67

abstract function getStatus(): MMO\core\entities\cStatus

returns

cStatus

getTitle()

abstractiEntity.php:51

abstract function getTitle(): string

returns

string

hasStatusChanged()

abstractiEntity.php:70

abstract function hasStatusChanged(): bool

returns

bool

isArchive()

abstractiEntity.php:71

abstract function isArchive(): bool

returns

bool

isChanged()

abstractiEntity.php:27

abstract function isChanged(): bool

returns

bool

isCreated()

abstractiEntity.php:28

abstract function isCreated(): bool

returns

bool

isFinal()

abstractiEntity.php:72

abstract function isFinal(): bool

returns

bool

isRemoved()

abstractiEntity.php:29

abstract function isRemoved(): bool

returns

bool

isValid()

abstractiEntity.php:30

abstract function isValid(): bool

returns

bool

loadArray($data, $coerceOptions, $fromStore)

abstractiEntity.php:46

abstract function loadArray(array $data, array $coerceOptions = [], bool $fromStore = false): static

$data	array
$coerceOptions = []	array
$fromStore = false	bool
returns	static	itself, $data loaded into its properties

loadFromStore($data)

abstractiEntity.php:48

Load data as read from storage: not recorded as a change.

abstract function loadFromStore(array $data): void

$data	array
returns	void

localName()

abstractiEntity.php:38

Get the local name (collection name and this id) in the current repository

abstract function localName(): string

returns

string

markChanged($keys)

abstractiEntity.php:64

abstract function markChanged(string ...$keys): bool

...$keys	string
returns	bool	false while changes are ignored

removeFlags($flags)

abstractiEntity.php:59

abstract function removeFlags(int $flags): bool

$flags	int
returns	bool

removePermanently()

abstractiEntity.php:76

Remove it for good: only an archived entity can be.

abstract function removePermanently(): void

returns

void

setArrayPropertyOffset($key, $offset, $value, $coerceOptions)

abstractiEntity.php:50

abstract function setArrayPropertyOffset( string $key, string|int|null $offset, mixed $value, array $coerceOptions = [] ): bool

$key	string
$offset	string \| int \| null
$value	mixed
$coerceOptions = []	array
returns	bool	false if the value could not be set (`getErrors`)

setStatus($status)

abstractiEntity.php:69

abstract function setStatus(MMO\core\entities\cStatus $status): bool

$status	cStatus
returns	bool	false if the transition was refused

store()

abstractiEntity.php:23

abstract function store(): array

returns

array

test($filter)

abstractiEntity.php:53

abstract function test(MMO\core\interfaces\iFilter $filter): bool

$filter	iFilter
returns	bool	whether it matches $filter

toLink($attributes)

abstractiEntity.php:32

abstract function toLink(array $attributes = []): MMO\core\server\Link

$attributes = []	array
returns	Link

Inherited members (12)

Methods	Declared by	Description
`ArrayProperties()`	iArrayProperties
`ArrayProperty($name)`	iArrayProperties
`compareTo($value)`	iComparable
`HiddenPath($path)`	iArrayProperties
`mutate($type, $path, $value, $oldValue)`	iMutationObserver
`offsetExists($offset)`	ArrayAccess
`offsetGet($offset)`	ArrayAccess
`offsetSet($offset, $value)`	ArrayAccess
`offsetUnset($offset)`	ArrayAccess
`Schema()`	iSchemaProvider
`toArray($fields)`	iArrayProperties
`uid()`	iIdentifiable	Get the unique identifier