iCollection

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

interface

iCollection

A set of entities of one class, usually belonging to a repository. Collection implements it: this interface declares everything the framework relies on, so code typed against it works with any collection.

interface MMO\core\interfaces\iCollection extends Countable, JsonSerializable, MMO\core\interfaces\iIdentifiable

Namespace: MMO\core\interfaces
Implements: Countable, JsonSerializable, iIdentifiable

It holds stored entities -- \MMO\core\entities\Entity, never an EmbeddedEntity.

Index

	addEntity($entity) abstract
	createEntity($data) abstract
	drop() abstract
	executeQuery($query, $opts) abstract
	find($filter, $fields, $sort, $limit, $offset, $options) abstract
	findOne($filter, $fields, $sort, $offset, $options) abstract
	getById($id, $find) abstract
	getEntities() abstract
	getEntityClass() abstract
	getId() abstract
	getName() abstract
	getOrCreateEntity($data, $local, $coerce) abstract
	getRepository() abstract
	getSchema() abstract
	getSearchProperty($name) abstract
	hasEntity($entity) abstract
	query($filter, $fields, $sort, $limit, $offset, $options) abstract
	removeEntity($entity) abstract

Methods18

addEntity($entity)

abstractiCollection.php:31

abstract function addEntity(MMO\core\interfaces\iEntity $entity): MMO\core\interfaces\iEntity

$entity	iEntity
returns	iEntity	$entity, now in this collection

createEntity($data)

abstractiCollection.php:40

abstract function createEntity(array $data = []): MMO\core\interfaces\iEntity

$data = []	array
returns	iEntity	a new entity (`aEntity::CheckData` to check the data first)

drop()

abstractiCollection.php:25

abstract function drop(): bool

returns

bool

executeQuery($query, $opts)

abstractiCollection.php:46

abstract function executeQuery(MMO\core\entities\Query $query, array $opts = []): Generator

$query	Query
$opts = []	array
returns	Generator

find($filter, $fields, $sort, $limit, $offset, $options)

abstractiCollection.php:48

abstract function find( MMO\core\interfaces\iFilter|array|string $filter, array $fields = [], array $sort = [], ?int $limit = null, ?int $offset = null, array $options = [] ): array

$filter	iFilter \| array \| string
$fields = []	array
$sort = []	array
$limit = null	null \| int
$offset = null	null \| int
$options = []	array
returns	array

findOne($filter, $fields, $sort, $offset, $options)

abstractiCollection.php:50

abstract function findOne( MMO\core\interfaces\iFilter|array|string $filter, array $fields = [], array $sort = [], ?int $offset = null, array $options = [] ): ?MMO\core\interfaces\iEntity

$filter	iFilter \| array \| string
$fields = []	array
$sort = []	array
$offset = null	null \| int
$options = []	array
returns	null \| iEntity

getById($id, $find)

abstractiCollection.php:38

abstract function getById(string $id, bool $find = true): ?MMO\core\interfaces\iEntity

$id	string
$find = true	bool	if it is not loaded yet, ask the repository
returns	null \| iEntity

getEntities()

abstractiCollection.php:28

abstract function getEntities(): array

returns

array

the entities loaded so far

getEntityClass()

abstractiCollection.php:20

abstract function getEntityClass(): string

returns

string

the class of its entities

getId()

abstractiCollection.php:16

abstract function getId(): mixed

returns

mixed

getName()

abstractiCollection.php:18

abstract function getName(): ?string

returns

null | string

its name in its repository

getOrCreateEntity($data, $local, $coerce)

abstractiCollection.php:42

abstract function getOrCreateEntity(array $data = [], bool $local = false, bool $coerce = true): MMO\core\interfaces\iEntity

$data = []	array
$local = false	bool
$coerce = true	bool
returns	iEntity	the entity matching $data on its @unique properties, or a new one

getRepository()

abstractiCollection.php:24

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

returns

null | iRepository

getSchema()

abstractiCollection.php:23

abstract function getSchema(): MMO\core\interfaces\iSchema

returns

iSchema

the schema of its entities

getSearchProperty($name)

abstractiCollection.php:21

abstract function getSearchProperty(string $name): MMO\core\attributes\SearchProperty

$name	string
returns	SearchProperty

hasEntity($entity)

abstractiCollection.php:29

abstract function hasEntity(MMO\core\interfaces\iEntity|string $entity): bool

$entity	iEntity \| string
returns	bool

query($filter, $fields, $sort, $limit, $offset, $options)

abstractiCollection.php:45

abstract function query( MMO\core\interfaces\iFilter|array|string $filter = [], array $fields = [], array $sort = [], ?int $limit = null, ?int $offset = null, array $options = [] ): MMO\core\entities\Query

$filter = []	iFilter \| array \| string
$fields = []	array
$sort = []	array
$limit = null	null \| int
$offset = null	null \| int
$options = []	array
returns	Query

removeEntity($entity)

abstractiCollection.php:33

abstract function removeEntity(MMO\core\interfaces\iEntity|string|int $entity): ?MMO\core\interfaces\iEntity

$entity	iEntity \| string \| int
returns	null \| iEntity	the entity removed, if it was there

Inherited members (3)

Methods	Declared by	Description
`count()`	Countable
`jsonSerialize()`	JsonSerializable
`uid()`	iIdentifiable	Get the unique identifier