<?php

/*

 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT

 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,

 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY

 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

 *

 * This software consists of voluntary contributions made by many individuals

 * and is licensed under the LGPL. For more information, see

 * <http://www.doctrine-project.org>.

 */

namespace Doctrine\ORM\Id;

use Doctrine\ORM\EntityManager;

/**

 * 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.

 */

class IdentityGenerator extends AbstractIdGenerator

{

    /** @var string The name of the sequence to pass to lastInsertId(), if any. */

    private $_seqName;

    /**

     * @param string $seqName The name of the sequence to pass to lastInsertId()

     *                        to obtain the last generated identifier within the current

     *                        database session/connection, if any.

     */

    public function __construct($seqName = null)

    {

        $this->_seqName = $seqName;

    }

    /**

     * {@inheritdoc}

     */

    public function generate(EntityManager $em, $entity)

    {

        return $em->getConnection()->lastInsertId($this->_seqName);

    }

    /**

     * {@inheritdoc}

     */

    public function isPostInsertGenerator()

    {

        return true;

    }

}