Interface Doctrine\ORM\Persisters\Entity\EntityPersister


					
	public

getClassMetadata(): ClassMetadata

#


					
	public

getResultSetMapping(): ResultSetMapping

Gets the ResultSetMapping used for hydration.

#


					
	public

getInserts(): object[]

Get all queued inserts.

#


					
	public

getInsertSQL(): string

Gets the INSERT SQL used by the persister to persist a new entity.

#


					
	public

getSelectSQL(
	mixed[]|Criteria $criteria,
	AssociationMapping|null $assoc = null,
	LockMode::*|null $lockMode = null,
	int|null $limit = null,
	int|null $offset = null,
	mixed[]|null $orderBy = null,
): string

Gets the SELECT SQL to select one or more entities by a set of field criteria.

#


					
	public

getCountSQL(mixed[]|Criteria $criteria = []): string

Get the COUNT SQL to count entities (optionally based on a criteria)

#


					
	public

expandParameters(string[] $criteria)

Expands the parameters from the given criteria and use the correct binding types if found.

#


					
	public

expandCriteriaParameters(Criteria $criteria)

Expands Criteria Parameters by walking the expressions and grabbing all parameters and types from it.

#


					
	public

getSelectConditionStatementSQL(
	string $field,
	mixed $value,
	AssociationMapping|null $assoc = null,
	string|null $comparison = null,
): string

Gets the SQL WHERE condition for matching a field with a given value.

#


					
	public

addInsert(object $entity): void

Adds an entity to the queued insertions. The entity remains queued until {@link executeInserts} is invoked.

Parameters

$entity

The entity to queue for insertion.

#


					
	public

executeInserts()

Executes all queued entity insertions.

If no inserts are queued, invoking this method is a NOOP.

#


					
	public

update(object $entity): void

Updates a managed entity. The entity is updated according to its current changeset in the running UnitOfWork. If there…

Updates a managed entity. The entity is updated according to its current changeset in the running UnitOfWork. If there is no changeset, nothing is updated.

Parameters

$entity

The entity to update.

#


					
	public

delete(object $entity): bool

Deletes a managed entity.

The entity to delete must be managed and have a persistent identifier. The deletion happens instantaneously.

Subclasses may override this method to customize the semantics of entity deletion.

Parameters

$entity

The entity to delete.

Returns

TRUE if the entity got deleted in the database, FALSE otherwise.

#


					
	public

count(mixed[]|Criteria $criteria = []): int

Count entities (optionally filtered by a criteria)

#


					
	public

getOwningTable(string $fieldName): string

Gets the name of the table that owns the column the given field is mapped to.

The default implementation in BasicEntityPersister always returns the name of the table the entity type of this persister is mapped to, since an entity is always persisted to a single table with a BasicEntityPersister.

Parameters

$fieldName

The field name.

Returns

The table name.

#


					
	public

load(
	array<string, mixed> $criteria,
	object|null $entity = null,
	AssociationMapping|null $assoc = null,
	array<string, mixed> $hints = [],
	LockMode::*|null $lockMode = null,
	int|null $limit = null,
	array<string, string>|null $orderBy = null,
): object|null

Loads an entity by a list of field criteria.

Parameters

`$entity`	The entity to load the data into. If not specified, a new entity is created.
`$assoc`	The association that connects the entity to load to another entity, if any.
`$limit`	Limit number of results.

Returns

The loaded and managed entity instance or NULL if the entity can not be found.

#


					
	public

loadById(array<string, mixed> $identifier, object|null $entity = null): object|null

Loads an entity by identifier.

Parameters

`$identifier`	The entity identifier.
`$entity`	The entity to load the data into. If not specified, a new entity is created.

Returns

The loaded and managed entity instance or NULL if the entity can not be found.

#


					
	public

loadOneToOneEntity(AssociationMapping $assoc, object $sourceEntity, array<string, mixed> $identifier = []): object

Loads an entity of this persister's mapped class as part of a single-valued association from another entity.

Parameters

`$assoc`	The association to load.
`$sourceEntity`	The entity that owns the association (not necessarily the "owning side").
`$identifier`	The identifier of the entity to load. Must be provided if the association to load represents the owning side, otherwise the identifier is derived from the $sourceEntity.

Returns

The loaded and managed entity instance or NULL if the entity can not be found.

Throws

Doctrine\ORM\Mapping\MappingException

#


					
	public

refresh(array<string, mixed> $id, object $entity, LockMode::*|null $lockMode = null): void

Refreshes a managed entity.

Parameters

`$id`	The identifier of the entity as an associative array from column or field names to values.
`$entity`	The entity to refresh.

#


					
	public

loadCriteria(Criteria $criteria): mixed[]

Loads Entities matching the given Criteria object.

#


					
	public

loadAll(
	array<string, mixed> $criteria = [],
	array<string, string>|null $orderBy = null,
	int|null $limit = null,
	int|null $offset = null,
)

Loads a list of entities by a list of field criteria.

#


					
	public

getManyToManyCollection(
	AssociationMapping $assoc,
	object $sourceEntity,
	int|null $offset = null,
	int|null $limit = null,
): mixed[]

Gets (sliced or full) elements of the given collection.

#


					
	public

loadManyToManyCollection(AssociationMapping $assoc, object $sourceEntity, PersistentCollection $collection): mixed[]

Loads a collection of entities of a many-to-many association.

Parameters

`$assoc`	The association mapping of the association being loaded.
`$sourceEntity`	The entity that owns the collection.
`$collection`	The collection to fill.

#


					
	public

loadOneToManyCollection(AssociationMapping $assoc, object $sourceEntity, PersistentCollection $collection): mixed

Loads a collection of entities in a one-to-many association.

Parameters

$collection

The collection to load/fill.

#


					
	public

lock(array<string, mixed> $criteria, LockMode::* $lockMode): void

Locks all rows of this entity matching the given criteria with the specified pessimistic lock mode.

#


					
	public

getOneToManyCollection(
	AssociationMapping $assoc,
	object $sourceEntity,
	int|null $offset = null,
	int|null $limit = null,
): mixed[]

Returns an array with (sliced or full list) of elements in the specified collection.

#


					
	public

exists(object $entity, ?Criteria $extraConditions = null): bool

Checks whether the given managed entity exists in the database.

Returns

TRUE if the entity exists in the database, FALSE otherwise.

#

Namespaces

Interfaces

Interface Doctrine\ORM\Persisters\Entity\EntityPersister

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Parameters

Parameters

Returns