Table

MMO\pdo\helpers · 1 symbol · generated 5 Oct 2026

class

Table

Helper to create PDO query on Table

class MMO\pdo\helpers\Table

Namespace: MMO\pdo\helpers

Index

	ENTITY_NAMESPACE	Namespace the generated entity classes (`generateEntityClass`) are declared in.
	autoId	The name of the primary column carrying AUTO_INCREMENT, or null if there is none.
	entityClass
	extra
	fields
	handler
	ids
	liaisons
	name	Table name
	addFields($fields)
	clearFields()
	count($filter)
	create($ifNotExists)
	createCollection($repo)
	createStatement($ifNotExists)	Create a CREATE TABLE query
	delete($filter, $limit, $allowAll)	Delete the rows matching $filter.
	deleteStatement($filter, $limit)
	drop($ifExists)
	dropStatement($ifExists)
	exists()
	generateEntityClass()
	getAutoId()
	getEntityClass()
	getExtra()
	getFields()
	getHandler()
	getIds()
	getName($withPrefix)
	hasField($name)
	insert($models)	Insert one or more rows.
	insertStatement($models)	Build an `INSERT` for one or more rows.
	query($repo, $filter, $fields, $sort, $limit, $offset)	Build a core `Query` against this table's collection.
	reservedProperties()
	search($model, $limit, $offset)
	select($fields, $filter)
	selectFirst($fields, $filter)
	selectStatement($fields, $filter)
	selectValue($field, $filter)
	selectValues($field, $filter)
	setEntityClass($class)	Use a hand-written entity class for this table's rows instead of a generated one -- the normal case as soon as the entity needs any behaviour of its own.
	setName($name)
	store($models)	Insert or update one or more rows (`storeStatement`), in a single transaction.
	storeStatement($models)	Build an upsert: insert the rows, and on a key conflict update their non-key columns instead of failing.
	toPHP()
	update($values, $filter)	Update the rows matching $filter, warning when the statement turns out to change nothing.
	updateById($values)	Update one row, identified by its primary key -- which must be present in $values and is not itself updated.
	updateStatement($values, $filter)
	__construct($handler, $name, $register)	Constructor

Constants1

ENTITY_NAMESPACE

Namespace the generated entity classes (generateEntityClass) are declared in.

const ENTITY_NAMESPACE = 'MMO\\pdo\\entities'

Properties8

autoId

The name of the primary column carrying AUTO_INCREMENT, or null if there is none.

protected ?string $autoId = null

Type: null | string

NOTE: this used to be typed `bool` while being assigned the column's NAME, which PHP silently coerced to `true` -- so the name (the one thing callers need, to write back the id the database generated on INSERT) was never actually retrievable. Verified directly.

entityClass

protected ?string $entityClass = null

Type: null | string

extra

protected array $extra = []

Type: array

fields

protected array $fields = []

Type: array

handler

#[MMO\core\attributes\Serialize(false)] protected MMO\pdo\interfaces\iHandler $handler

Type: iHandler

ids

protected array $ids = []

Type: array

liaisons

protected array $liaisons = []

Type: array

name

Table name

protected string $name = ''

Type: string

Methods39

addFields($fields)

Table.php:127

function addFields(array $fields): self

$fields	array
returns	self

clearFields()

Table.php:119

function clearFields(): self

returns

self

count($filter)

Table.php:331

function count(MMO\core\interfaces\iFilter|array|string|null $filter = null): int

$filter = null	iFilter \| array \| string \| null
returns	int	how many rows match $filter.

create($ifNotExists)

Table.php:300

function create(bool $ifNotExists = false): PDOStatement

$ifNotExists = false	bool
returns	PDOStatement

createCollection($repo)

Table.php:241

function createCollection(?MMO\core\interfaces\iRepository $repo = null): MMO\core\entities\Collection

$repo = null	null \| iRepository
returns	Collection

createStatement($ifNotExists)

Table.php:283

Create a CREATE TABLE query

function createStatement(bool $ifNotExists = false): MMO\pdo\statements\CreateStatement

$ifNotExists = false	bool
returns	CreateStatement

delete($filter, $limit, $allowAll)

Table.php:486

Delete the rows matching $filter.

function delete( MMO\core\interfaces\iFilter|array|string|null $filter = null, ?int $limit = null, bool $allowAll = false ): int

$filter = null	iFilter \| array \| string \| null
$limit = null	null \| int
$allowAll = false	bool	deleting with no filter empties the table, so it has to be asked for explicitly
returns	int	the number of rows deleted
throws		if $filter is empty and $allowAll is false

deleteStatement($filter, $limit)

Table.php:472

function deleteStatement( MMO\core\interfaces\iFilter|array|string|null $filter = null, ?int $limit = null ): MMO\pdo\statements\DeleteStatement

$filter = null	iFilter \| array \| string \| null
$limit = null	null \| int
returns	DeleteStatement

drop($ifExists)

Table.php:507

function drop(bool $ifExists = true): bool

$ifExists = true	bool
returns	bool	true if the table was actually dropped

dropStatement($ifExists)

Table.php:499

function dropStatement(bool $ifExists = false): MMO\pdo\statements\DropStatement

$ifExists = false	bool
returns	DropStatement

exists()

Table.php:138

function exists(): bool

returns

bool

generateEntityClass()

Table.php:152

function generateEntityClass(): string

NOTE: this used to be built from `$handler->getHref()`, i.e. the DSN -- which for SQLite is an absolute filename, so the class was named after wherever the database happened to sit (`sqlite__home_someone_project_data_sqlite_user`). That is machine-specific, and the name ends up in serialized entity references, so it could not survive being moved between machines. It is now derived from the table name plus a digest of its column SHAPE: stable everywhere, and still distinct for two same-named tables whose columns differ.

returns string the fully-qualified name of the PDOEntity subclass generated for this table.

getAutoId()

Table.php:97

function getAutoId(): ?string

returns

null | string

the name of the AUTO_INCREMENT primary column, if the table has one.

getEntityClass()

Table.php:166

function getEntityClass(): string

returns string the entity class for this table's rows: the one set with setEntityClass, or a class generated (once) from the columns themselves.

getExtra()

Table.php:88

function getExtra(): array

returns

array

getFields()

Table.php:111

function getFields(): array

returns

array

getHandler()

Table.php:84

function getHandler(): MMO\pdo\interfaces\iHandler

returns

iHandler

getIds()

Table.php:92

function getIds(): array

returns

array

getName($withPrefix)

Table.php:101

function getName(bool $withPrefix = true): string

$withPrefix = true	bool
returns	string

hasField($name)

Table.php:115

function hasField(string $name): bool

$name	string
returns	bool

insert($models)

Table.php:371

Insert one or more rows.

function insert(array ...$models): string|false

...$models	array
returns	string \| false	the id the database generated for the LAST row (`iHandler::lastId`), or false if the table has no AUTO_INCREMENT column

insertStatement($models)

Table.php:356

Build an INSERT for one or more rows.

function insertStatement(array ...$models): MMO\pdo\statements\InsertStatement

...$models	array
returns	InsertStatement

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

Table.php:262

Build a core Query against this table's collection.

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

WARNING for whoever implements the repository side: a Query's field list is schema-driven, not column-driven, so it asks for properties that are NOT columns of this table -- `status`, `uid` and `metadata` come with every entity, and [`Query::listOnly()`](https://mcp.mmoframework.fr/documentation/mmo.core/php/entities/Query.md#query-listonly) additionally requests `label` and filters on `status`. Whatever turns a Query into SQL must intersect its fields with [`getFields`](https://mcp.mmoframework.fr/documentation/mmo.pdo/php/helpers/Table.md#table-getfields) and decide what to do with the rest, or the database will be asked for columns that do not exist.

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

reservedProperties()

Table.php:193

protected function reservedProperties(): array

returns array every property PDOEntity already declares, mapped to whether it is an #[ArrayProperty] (i.e. part of the entity's data) rather than internal bookkeeping.

search($model, $limit, $offset)

Table.php:341

function search(array $model, ?int $limit = 1, ?int $offset = null): array

$model	array	the values to look for
$limit = 1	null \| int
$offset = null	null \| int
returns	array	the primary key of each match, as column => value maps

select($fields, $filter)

Table.php:308

$fields = null	array \| string \| null
$filter = null	iFilter \| array \| string \| null
returns	array

selectFirst($fields, $filter)

Table.php:313

$fields = null	array \| string \| null
$filter = null	iFilter \| array \| string \| null
returns	array \| false	the first matching row, or false if there is none.

selectStatement($fields, $filter)

Table.php:304

$fields = null	array \| string \| null
$filter = null	iFilter \| array \| string \| null
returns	SelectStatement

selectValue($field, $filter)

Table.php:321

function selectValue( string $field, MMO\core\interfaces\iFilter|array|string|null $filter = null ): mixed

$field	string
$filter = null	iFilter \| array \| string \| null
returns	mixed	one column of the first matching row (null for a SQL NULL), or false if there is none.

$users->selectValue('email', ['name' => 'ada']); // null if ada has no email, false if there is no ada

selectValues($field, $filter)

Table.php:326

function selectValues( string $field, MMO\core\interfaces\iFilter|array|string|null $filter = null ): array

$field	string
$filter = null	iFilter \| array \| string \| null
returns	array	one column of every matching row.

setEntityClass($class)

Table.php:181

Use a hand-written entity class for this table's rows instead of a generated one -- the normal case as soon as the entity needs any behaviour of its own.

function setEntityClass(string $class): self

$class	string	an `iEntity` implementation (`PDOEntity` is the intended base)
returns	self
throws		if $class is not an entity

setName($name)

Table.php:106

function setName(string $name): self

$name	string
returns	self

store($models)

Table.php:416

Insert or update one or more rows (storeStatement), in a single transaction.

function store(array ...$models): string|false

...$models	array
returns	string \| false	`insert` -- but note this is only meaningful when a row was actually INSERTED: after a conflict resolved as an update, the driver still reports the last id it ever generated

storeStatement($models)

Table.php:383

Build an upsert: insert the rows, and on a key conflict update their non-key columns instead of failing.

function storeStatement(array ...$models): MMO\pdo\statements\InsertStatement

...$models	array
returns	InsertStatement

toPHP()

Table.php:206

function toPHP(): string

See: getEntityClass which evaluates it

returns	string	the PHP source of this table's generated entity class, ready for `eval()`.
throws		if a column's name is one the entity base class reserves for its own internals

update($values, $filter)

Table.php:442

Update the rows matching $filter, warning when the statement turns out to change nothing.

function update( array $values, MMO\core\interfaces\iFilter|array|string|null $filter = null ): int

$values	array
$filter = null	iFilter \| array \| string \| null
returns	int	the number of rows changed

updateById($values)

Table.php:455

Update one row, identified by its primary key -- which must be present in $values and is not itself updated.

function updateById(array $values): int

$values	array
returns	int	the number of rows changed
throws		if a primary key column is missing from $values

updateStatement($values, $filter)

Table.php:432

function updateStatement( array $values, MMO\core\interfaces\iFilter|array|string|null $filter = null ): MMO\pdo\statements\UpdateStatement

$values	array	column => value (a key may carry a bind type; `:raw` renders a SQL expression)
$filter = null	iFilter \| array \| string \| null
returns	UpdateStatement

__construct($handler, $name, $register)

Table.php:76

Constructor

function __construct( MMO\pdo\interfaces\iHandler $handler, ?string $name = null, bool $register = true )

$handler	iHandler	[description]
$name = null	null \| string	used to set manually the table name (in case you use another table definition)
$register = true	bool	if true, add the table to the handler