class IdentityGenerator extends AbstractIdGenerator (View source)

Id generator that obtains IDs from special "identity" columns. These are columns that automatically get a database-generated, auto-incremented identifier on INSERT.

This generator obtains the last insert id after such an insert.

Methods

mixed
generate(EntityManager $em, Entity $entity)

Generates an identifier for an entity.

boolean
isPostInsertGenerator()

Gets whether this generator is a post-insert generator which means that {@link generate()} must be called after the entity has been inserted into the database.

__construct(string|null $sequenceName = null)

Constructor.

Details

mixed generate(EntityManager $em, Entity $entity)

Generates an identifier for an entity.

Parameters

EntityManager $em
Entity $entity

Return Value

mixed

boolean isPostInsertGenerator()

Gets whether this generator is a post-insert generator which means that {@link generate()} must be called after the entity has been inserted into the database.

By default, this method returns FALSE. Generators that have this requirement must override this method and return TRUE.

Return Value

boolean

__construct(string|null $sequenceName = null)

Constructor.

Parameters

string|null $sequenceName The name of the sequence to pass to lastInsertId() to obtain the last generated identifier within the current database session/connection, if any.