summaryrefslogtreecommitdiff
path: root/vendor/doctrine/orm/src/Id/AbstractIdGenerator.php
blob: 6d981f8f5a82ffb337bd2863bcc5b05ebd3e2f57 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
<?php

declare(strict_types=1);

namespace Doctrine\ORM\Id;

use Doctrine\ORM\EntityManagerInterface;

abstract class AbstractIdGenerator
{
    /**
     * Generates an identifier for an entity.
     */
    abstract public function generateId(EntityManagerInterface $em, object|null $entity): mixed;

    /**
     * Gets whether this generator is a post-insert generator which means that
     * {@link generateId()} 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.
     */
    public function isPostInsertGenerator(): bool
    {
        return false;
    }
}