1 | <?php |
---|
2 | /* |
---|
3 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
---|
4 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
---|
5 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
---|
6 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
---|
7 | * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
---|
8 | * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
---|
9 | * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
---|
10 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
---|
11 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
---|
12 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
---|
13 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
---|
14 | * |
---|
15 | * This software consists of voluntary contributions made by many individuals |
---|
16 | * and is licensed under the LGPL. For more information, see |
---|
17 | * <http://www.doctrine-project.org>. |
---|
18 | */ |
---|
19 | |
---|
20 | namespace Doctrine\ORM\Id; |
---|
21 | |
---|
22 | use Doctrine\ORM\EntityManager; |
---|
23 | |
---|
24 | abstract class AbstractIdGenerator |
---|
25 | { |
---|
26 | /** |
---|
27 | * Generates an identifier for an entity. |
---|
28 | * |
---|
29 | * @param \Doctrine\ORM\Entity $entity |
---|
30 | * @return mixed |
---|
31 | */ |
---|
32 | abstract public function generate(EntityManager $em, $entity); |
---|
33 | |
---|
34 | /** |
---|
35 | * Gets whether this generator is a post-insert generator which means that |
---|
36 | * {@link generate()} must be called after the entity has been inserted |
---|
37 | * into the database. |
---|
38 | * |
---|
39 | * By default, this method returns FALSE. Generators that have this requirement |
---|
40 | * must override this method and return TRUE. |
---|
41 | * |
---|
42 | * @return boolean |
---|
43 | */ |
---|
44 | public function isPostInsertGenerator() |
---|
45 | { |
---|
46 | return false; |
---|
47 | } |
---|
48 | } |
---|