interface/modules/zend_modules/library/Zend/Db/TableGateway/Feature/SequenceFeature.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Db\TableGateway\Feature;
  11
  12 use Zend\Db\Sql\Insert;
  13 use Zend\Db\Adapter\Driver\ResultInterface;
  14 use Zend\Db\Adapter\Driver\StatementInterface;
  15
  16 class SequenceFeature extends AbstractFeature
  17 {
  18     /**
  19      * @var string
  20      */
  21     protected $primaryKeyField;
  22
  23     /**
  24      * @var string
  25      */
  26     protected $sequenceName;
  27
  28     /**
  29      * @var int
  30      */
  31     protected $sequenceValue;
  32
  33
  34     /**
  35      * @param string $primaryKeyField
  36      * @param string $sequenceName
  37      */
  38     public function __construct($primaryKeyField, $sequenceName)
  39     {
  40         $this->primaryKeyField = $primaryKeyField;
  41         $this->sequenceName    = $sequenceName;
  42     }
  43
  44     /**
  45      * @param  Insert $insert
  46      */
  47     public function preInsert(Insert $insert)
  48     {
  49         $columns = $insert->getRawState('columns');
  50         $values = $insert->getRawState('values');
  51         $key = array_search($this->primaryKeyField, $columns);
  52         if ($key !== false) {
  53             $this->sequenceValue = $values[$key];
  54             return $insert;
  55         }
  56
  57         $this->sequenceValue = $this->nextSequenceId();
  58         if ($this->sequenceValue === null) {
  59             return $insert;
  60         }
  61
  62         $insert->values(array($this->primaryKeyField => $this->sequenceValue),  Insert::VALUES_MERGE);
  63         return $insert;
  64     }
  65
  66     public function postInsert(StatementInterface $statement, ResultInterface $result)
  67     {
  68         if ($this->sequenceValue !== null) {
  69             $this->tableGateway->lastInsertValue = $this->sequenceValue;
  70         }
  71     }
  72
  73     /**
  74      * Generate a new value from the specified sequence in the database, and return it.
  75      * @return int
  76      */
  77     public function nextSequenceId()
  78     {
  79         $platform = $this->tableGateway->adapter->getPlatform();
  80         $platformName = $platform->getName();
  81
  82         switch ($platformName) {
  83             case 'Oracle':
  84                 $sql = 'SELECT ' . $platform->quoteIdentifier($this->sequenceName) . '.NEXTVAL FROM dual';
  85                 break;
  86             case 'PostgreSQL':
  87                 $sql = 'SELECT NEXTVAL(\'' . $this->sequenceName . '\')';
  88                 break;
  89             default :
  90                 return null;
  91         }
  92
  93         $statement = $this->tableGateway->adapter->createStatement();
  94         $statement->prepare($sql);
  95         $result = $statement->execute();
  96         $sequence = $result->current();
  97         unset($statement, $result);
  98         return $sequence['nextval'];
  99     }
 100
 101     /**
 102      * Return the most recent value from the specified sequence in the database.
 103      * @return int
 104      */
 105     public function lastSequenceId()
 106     {
 107         $platform = $this->tableGateway->adapter->getPlatform();
 108         $platformName = $platform->getName();
 109
 110         switch ($platformName) {
 111             case 'Oracle':
 112                 $sql = 'SELECT ' . $platform->quoteIdentifier($this->sequenceName) . '.CURRVAL FROM dual';
 113                 break;
 114             case 'PostgreSQL':
 115                 $sql = 'SELECT CURRVAL(\'' . $this->sequenceName . '\')';
 116                 break;
 117             default :
 118                 return null;
 119         }
 120
 121         $statement = $this->tableGateway->adapter->createStatement();
 122         $statement->prepare($sql);
 123         $result = $statement->execute();
 124         $sequence = $result->current();
 125         unset($statement, $result);
 126         return $sequence['currval'];
 127     }
 128 }