tflori/orm

» API Reference » ORM\Entity

ORM\Entity

Table of Contents

• Abstract
• Constants
• Methods
  • $entity->__construct - Constructor
  • $entity->__get -
  • $entity->__isset - Check if a column is defined
  • $entity->__serialize -
  • $entity->__set -
  • $entity->__unserialize -
  • $entity->addRelated - Add relations for $relation to $entities
  • Entity::bootIfNotBooted - Boot the class if it not already booted
  • $entity->delete - Delete the entity
  • $entity->deleteRelated - Delete relations for $relation to $entities
  • Entity::describe - Get a description for this table.
  • Entity::detachObserver - Stop observing the class by $observer
  • Entity::disableValidator - Disable validator
  • Entity::enableValidator - Enable validator
  • $entity->exists - Returns whether or not the entity exists in database
  • $entity->fetch - Fetches related objects
  • $entity->fill - Fill the entity with $data
  • $entity->getAttribute - Get the value from $attribute
  • Entity::getAttributeName - Get the column name of $attribute
  • Entity::getColumnName - Get the column name of $attribute
  • $entity->getDirty - Get an array of attributes that changed
  • Entity::getNamingSchemeColumn -
  • Entity::getNamingSchemeMethods -
  • Entity::getNamingSchemeTable -
  • $entity->getPrimaryKey - Get the primary key
  • Entity::getPrimaryKeyVars - Get the primary key vars
  • $entity->getRelated - Get related objects
  • Entity::getRelation - Get the definition for $relation
  • Entity::getTableName - Get the table name
  • Entity::getTableNameTemplate -
  • $entity->hasLoaded - Check if $relation got loaded already
  • $entity->hasPrimaryKey - Check if the entity has has a complete primary key
  • Entity::isAutoIncremented - Check if the table has a auto increment column
  • $entity->isDirty - Checks if entity or $attribute got changed
  • $entity->isValid - Check if the current data is valid
  • Entity::isValidatorEnabled - Check if the validator is enabled
  • $entity->load - Load the related objects of $relation
  • Entity::observeBy - Observe the class using $observer
  • $entity->onChange - Empty event handler
  • $entity->onInit - Empty event handler
  • $entity->postPersist - Empty event handler
  • $entity->postUpdate - Empty event handler
  • $entity->prePersist - Empty event handler
  • $entity->preUpdate - Empty event handler
  • Entity::query - Create an entityFetcher for this entity
  • Entity::registerGlobalFilter - Register a filter that is added to every fetcher for this entity
  • $entity->reset - Resets the entity or $attribute to original data
  • $entity->resetRelated - Resets all loaded relations or $relation
  • $entity->save - Save the entity to EntityManager
  • $entity->serialize - String representation of data
  • $entity->setAttribute - Set $attribute to $value
  • $entity->setEntityManager -
  • Entity::setNamingSchemeColumn -
  • Entity::setNamingSchemeMethods -
  • Entity::setNamingSchemeTable -
  • $entity->setRelated - Set $relation to $entity
  • Entity::setTableNameTemplate -
  • $entity->toArray - Get an array of the entity
  • $entity->unserialize - Constructs the object
  • Entity::validate - Validate $value for $attribute
  • Entity::validateArray - Validate $data

Abstract

Implements: Serializable

Definition of an entity

The instance of an entity represents a row of the table and the statics variables and methods describe the database table.

This is the main part where your configuration efforts go. The following properties and methods are well documented in the manual under https://tflori.github.io/orm/entityDefinition.html.

See Also:

• Entity Definition

Constants

Methods

ORM\Entity::__construct

final public function __construct(
    array $data = [], 
    \ORM\EntityManager $entityManager = null, 
    bool $fromDatabase = false, 
)

Constructor

It calls ::onInit() after initializing $data and $originalData.

Parameters

ORM\Entity::__construct

↑ top

ORM\Entity::__get

public function __get(string $attribute): mixed|null

Parameters

See Also:

• ORM\Entity::getAttribute

ORM\Entity::__get

↑ top

ORM\Entity::__isset

public function __isset(mixed $attribute): bool

Check if a column is defined

Parameters

ORM\Entity::__isset

↑ top

ORM\Entity::__serialize

public function __serialize(): mixed

ORM\Entity::__serialize

↑ top

ORM\Entity::__set

public function __set(string $attribute, mixed $value): mixed

Parameters

See Also:

• ORM\self::getAttribute

ORM\Entity::__set

↑ top

ORM\Entity::__unserialize

public function __unserialize(mixed $data): mixed

Parameters

ORM\Entity::__unserialize

↑ top

ORM\Entity::addRelated

public function addRelated(string $relation, \ORM\Entity[] $entities): mixed

Add relations for $relation to $entities

This method is only for many-to-many relations.

This method does not take care about already existing relations and will fail hard.

Parameters

ORM\Entity::addRelated

↑ top

ORM\Entity::bootIfNotBooted

public static function bootIfNotBooted(): mixed

Boot the class if it not already booted

ORM\Entity::bootIfNotBooted

↑ top

ORM\Entity::delete

public function delete(): $this

Delete the entity

You might want to implement soft deletes by overriding this method.

ORM\Entity::delete

↑ top

ORM\Entity::deleteRelated

public function deleteRelated(string $relation, \ORM\Entity[] $entities): mixed

Delete relations for $relation to $entities

This method is only for many-to-many relations.

Parameters

ORM\Entity::deleteRelated

↑ top

ORM\Entity::describe

public static function describe(): \ORM\Dbal\Table|\ORM\Dbal\Column[]

Get a description for this table.

ORM\Entity::describe

↑ top

ORM\Entity::detachObserver

public static function detachObserver(
    \ORM\Observer\AbstractObserver $observer, 
): mixed

Stop observing the class by $observer

Parameters

See Also:

• ORM\EntityManager::detach()

ORM\Entity::detachObserver

↑ top

ORM\Entity::disableValidator

public static function disableValidator(bool $disable = true): mixed

Disable validator

Parameters

ORM\Entity::disableValidator

↑ top

ORM\Entity::enableValidator

public static function enableValidator(bool $enable = true): mixed

Enable validator

Parameters

ORM\Entity::enableValidator

↑ top

ORM\Entity::exists

public function exists(): bool

Returns whether or not the entity exists in database

ORM\Entity::exists

↑ top

ORM\Entity::fetch

public function fetch(
    string $relation, 
    bool $getAll = false, 
): \ORM\Entity|\ORM\Entity[]|\ORM\EntityFetcher

Fetches related objects

For relations with cardinality many it returns an EntityFetcher. Otherwise it returns the entity.

It will throw an error for non owner when the key is incomplete.

Parameters

ORM\Entity::fetch

↑ top

ORM\Entity::fill

public function fill(
    array $data, 
    bool $ignoreUnknown = false, 
    bool $checkMissing = false, 
): mixed

Fill the entity with $data

When $checkMissing is set to true it also proves that the absent columns are nullable.

Parameters

ORM\Entity::fill

↑ top

ORM\Entity::getAttribute

public function getAttribute(string $attribute): mixed|null

Get the value from $attribute

If there is a custom getter this method get called instead.

Parameters

See Also:

• Working with entities

ORM\Entity::getAttribute

↑ top

ORM\Entity::getAttributeName

public static function getAttributeName(string $column): string

Get the column name of $attribute

The column names can not be specified by template. Instead they are constructed by $columnPrefix and enforced to $namingSchemeColumn.

ATTENTION: If your overwrite this method remember that getColumnName(getColumnName($name)) have to be exactly the same as getColumnName($name).

Parameters

ORM\Entity::getAttributeName

↑ top

ORM\Entity::getColumnName

public static function getColumnName(string $attribute): string

Get the column name of $attribute

The column names can not be specified by template. Instead they are constructed by $columnPrefix and enforced to $namingSchemeColumn.

ATTENTION: If your overwrite this method remember that getColumnName(getColumnName($name)) have to be exactly the same as getColumnName($name).

Parameters

ORM\Entity::getColumnName

↑ top

ORM\Entity::getDirty

public function getDirty(): array

Get an array of attributes that changed

This method works on application level. Meaning it is showing additional attributes defined in ::$includedAttributes and and hiding ::$excludedAttributes.

ORM\Entity::getDirty

↑ top

ORM\Entity::getNamingSchemeColumn

public static function getNamingSchemeColumn(): string

Warning: this method is deprecated. | Static | | This method is static. | | Returns | string | |

ORM\Entity::getNamingSchemeColumn

↑ top

ORM\Entity::getNamingSchemeMethods

public static function getNamingSchemeMethods(): string

Warning: this method is deprecated. | Static | | This method is static. | | Returns | string | |

ORM\Entity::getNamingSchemeMethods

↑ top

ORM\Entity::getNamingSchemeTable

public static function getNamingSchemeTable(): string

Warning: this method is deprecated. | Static | | This method is static. | | Returns | string | |

ORM\Entity::getNamingSchemeTable

↑ top

ORM\Entity::getPrimaryKey

public function getPrimaryKey(): array

Get the primary key

ORM\Entity::getPrimaryKey

↑ top

ORM\Entity::getPrimaryKeyVars

public static function getPrimaryKeyVars(): array

Get the primary key vars

The primary key can consist of multiple columns. You should configure the vars that are translated to these columns.

ORM\Entity::getPrimaryKeyVars

↑ top

ORM\Entity::getRelated

public function getRelated(string $relation, bool $refresh = false): mixed

Get related objects

The difference between getRelated and fetch is that getRelated stores the fetched entities. To refresh set $refresh to true.

Parameters

ORM\Entity::getRelated

↑ top

ORM\Entity::getRelation

public static function getRelation(string $name): \ORM\Relation

Get the definition for $relation

It normalize the short definition form and create a Relation object from it.

Parameters

ORM\Entity::getRelation

↑ top

ORM\Entity::getTableName

public static function getTableName(): string

Get the table name

The table name is constructed by $tableNameTemplate and $namingSchemeTable. It can be overwritten by $tableName.

ORM\Entity::getTableName

↑ top

ORM\Entity::getTableNameTemplate

public static function getTableNameTemplate(): string

Warning: this method is deprecated. | Static | | This method is static. | | Returns | string | |

ORM\Entity::getTableNameTemplate

↑ top

ORM\Entity::hasLoaded

public function hasLoaded(string $relation): bool

Check if $relation got loaded already

Parameters

ORM\Entity::hasLoaded

↑ top

ORM\Entity::hasPrimaryKey

public function hasPrimaryKey(): bool

Check if the entity has has a complete primary key

ORM\Entity::hasPrimaryKey

↑ top

ORM\Entity::isAutoIncremented

public static function isAutoIncremented(): bool

Check if the table has a auto increment column

ORM\Entity::isAutoIncremented

↑ top

ORM\Entity::isDirty

public function isDirty(string $attribute = null): bool

Checks if entity or $attribute got changed

Parameters

ORM\Entity::isDirty

↑ top

ORM\Entity::isValid

public function isValid(): bool|\ORM\Dbal\Error[]

Check if the current data is valid

Returns boolean true when valid otherwise an array of Errors.

ORM\Entity::isValid

↑ top

ORM\Entity::isValidatorEnabled

public static function isValidatorEnabled(): bool

Check if the validator is enabled

ORM\Entity::isValidatorEnabled

↑ top

ORM\Entity::load

public function load(string $relation): $this

Load the related objects of $relation

Nested relations can be loaded by separating them by “.” for example load all articles with comments from a user ($this): $user->load('articles.comments').

Parameters

ORM\Entity::load

↑ top

ORM\Entity::observeBy

public static function observeBy(
    \ORM\Observer\AbstractObserver|null $observer = null, 
): \ORM\Observer\CallbackObserver|null

Observe the class using $observer

If AbstractObserver is omitted it returns a new CallbackObserver. Usage example:

$em->observe(User::class)
    ->on('inserted', function (User $user) { ... })
    ->on('deleted', function (User $user) { ... });

For more information about model events please consult the [documentation](https://tflori.github.io/

Parameters

See Also:

• ORM\EntityManager::observe()

ORM\Entity::observeBy

↑ top

ORM\Entity::onChange

public function onChange(
    string $attribute, 
    mixed $oldValue, 
    mixed $value, 
): mixed

Empty event handler

Get called when something is changed with magic setter.

Parameters

ORM\Entity::onChange

↑ top

ORM\Entity::onInit

public function onInit(bool $new): mixed

Empty event handler

Get called when the entity get initialized.

Parameters

ORM\Entity::onInit

↑ top

ORM\Entity::postPersist

public function postPersist(): mixed

Empty event handler

Get called after the entity got inserted in database.

ORM\Entity::postPersist

↑ top

ORM\Entity::postUpdate

public function postUpdate(): mixed

Empty event handler

Get called after the entity got updated in database.

ORM\Entity::postUpdate

↑ top

ORM\Entity::prePersist

public function prePersist(): mixed

Empty event handler

Get called before the entity get inserted in database.

ORM\Entity::prePersist

↑ top

ORM\Entity::preUpdate

public function preUpdate(): mixed

Empty event handler

Get called before the entity get updated in database.

ORM\Entity::preUpdate

↑ top

ORM\Entity::query

public static function query(): \ORM\EntityFetcher

Create an entityFetcher for this entity

ORM\Entity::query

↑ top

ORM\Entity::registerGlobalFilter

public static function registerGlobalFilter(
    string|\ORM\EntityFetcher\FilterInterface|callable $filter, 
): mixed

Register a filter that is added to every fetcher for this entity

Parameters

ORM\Entity::registerGlobalFilter

↑ top

ORM\Entity::reset

public function reset(string $attribute = null): mixed

Resets the entity or $attribute to original data

Parameters

ORM\Entity::reset

↑ top

ORM\Entity::resetRelated

public function resetRelated(null $relation = null): mixed

Resets all loaded relations or $relation

Helpful to reduce the size of serializations of the object (for caching, or toArray method etc.)

Parameters

ORM\Entity::resetRelated

↑ top

ORM\Entity::save

public function save(): $this

Save the entity to EntityManager

ORM\Entity::save

↑ top

ORM\Entity::serialize

public function serialize(): string

String representation of data

See Also:

ORM\Entity::serialize

↑ top

ORM\Entity::setAttribute

public function setAttribute(string $attribute, mixed $value): $this

Set $attribute to $value

Tries to call custom setter before it stores the data directly. If there is a setter the setter needs to store data that should be updated in the database to $data. Do not store data in $originalData as it will not be written and give wrong results for dirty checking.

The onChange event is called after something got changed.

The method throws an error when the validation fails (also when the column does not exist).

Parameters

See Also:

• Working with entities

ORM\Entity::setAttribute

↑ top

ORM\Entity::setEntityManager

public function setEntityManager(\ORM\EntityManager $entityManager): $this

Parameters

ORM\Entity::setEntityManager

↑ top

ORM\Entity::setNamingSchemeColumn

public static function setNamingSchemeColumn(string $namingSchemeColumn): mixed

Warning: this method is deprecated. | Static | | This method is static. | | Returns | mixed | |

Parameters

ORM\Entity::setNamingSchemeColumn

↑ top

ORM\Entity::setNamingSchemeMethods

public static function setNamingSchemeMethods(
    string $namingSchemeMethods, 
): mixed

Warning: this method is deprecated. | Static | | This method is static. | | Returns | mixed | |

Parameters

ORM\Entity::setNamingSchemeMethods

↑ top

ORM\Entity::setNamingSchemeTable

public static function setNamingSchemeTable(string $namingSchemeTable): mixed

Warning: this method is deprecated. | Static | | This method is static. | | Returns | mixed | |

Parameters

ORM\Entity::setNamingSchemeTable

↑ top

ORM\Entity::setRelated

public function setRelated(string $relation, \ORM\Entity $entity = null): mixed

Set $relation to $entity

This method is only for the owner of a relation.

Parameters

ORM\Entity::setRelated

↑ top

ORM\Entity::setTableNameTemplate

public static function setTableNameTemplate(string $tableNameTemplate): mixed

Warning: this method is deprecated. | Static | | This method is static. | | Returns | mixed | |

Parameters

ORM\Entity::setTableNameTemplate

↑ top

ORM\Entity::toArray

public function toArray(
    array $attributes = [], 
    bool $includeRelations = true, 
    array $parents = [], 
): array

Get an array of the entity

Parameters

ORM\Entity::toArray

↑ top

ORM\Entity::unserialize

public function unserialize(string $serialized): mixed

Constructs the object

Parameters

See Also:

ORM\Entity::unserialize

↑ top

ORM\Entity::validate

public static function validate(
    string $attribute, 
    mixed $value, 
): bool|\ORM\Dbal\Error

Validate $value for $attribute

Parameters

ORM\Entity::validate

↑ top

ORM\Entity::validateArray

public static function validateArray(array $data): array

Validate $data

$data has to be an array of $attribute => $value

Parameters

ORM\Entity::validateArray

↑ top