Source for file Firebird.php

Documentation is available at Firebird.php

  1. <?php
  2. /*
  3.  *  $Id: Firebird.php 1619 2007-06-10 19:28:47Z zYne $
  4.  *
  5.  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  6.  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  7.  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  8.  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  9.  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  10.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  11.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  12.  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  13.  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  14.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  15.  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  16.  *
  17.  * This software consists of voluntary contributions made by many individuals
  18.  * and is licensed under the LGPL. For more information, see
  19.  * <http://www.phpdoctrine.com>.
  20.  */
  21. Doctrine::autoload('Doctrine_Sequence');
  22. /**
  23.  * Doctrine_Sequence_Firebird
  24.  *
  25.  * @package     Doctrine
  26.  * @author      Konsta Vesterinen <kvesteri@cc.hut.fi>
  27.  * @license     http://www.opensource.org/licenses/lgpl-license.php LGPL
  28.  * @category    Object Relational Mapping
  29.  * @link        www.phpdoctrine.com
  30.  * @since       1.0
  31.  * @version     $Revision: 1619 $
  32.  */
  33. class Doctrine_Sequence_Firebird extends Doctrine_Sequence
  34. {
  35.     /**
  36.      * Returns the next free id of a sequence
  37.      *
  38.      * @param string $seqName   name of the sequence
  39.      * @param bool              when true missing sequences are automatic created
  40.      *
  41.      * @return integer          next id in the given sequence
  42.      */
  43.     public function nextID($seqName, $onDemand = true)
  44.     {
  45.         $sequenceName = $this->conn->quoteIdentifier($this->conn->formatter->getSequenceName($seqName), true);
  46.  
  47.         $query = 'SELECT GEN_ID(' . $sequenceName . ', 1) as the_value FROM RDB$DATABASE';
  48.         try {
  49.         
  50.             $result = $this->conn->fetchOne($query);
  51.  
  52.         } catch(Doctrine_Connection_Exception $e) {
  53.             if ($onDemand && $e->getPortableCode() == Doctrine::ERR_NOSUCHTABLE) {
  54.                 // Since we are creating the sequence on demand
  55.                 // we know the first id = 1 so initialize the
  56.                 // sequence at 2
  57.                 try {
  58.                     $result = $this->conn->export->createSequence($seqName, 2);
  59.                 } catch(Doctrine_Exception $e) {
  60.                     throw new Doctrine_Sequence_Exception('on demand sequence ' . $seqName . ' could not be created');
  61.                 }
  62.                 // First ID of a newly created sequence is 1
  63.                 // return 1;
  64.                 // BUT generators are not always reset, so return the actual value
  65.                 return $this->currID($seqName);
  66.             }
  67.             throw $e;
  68.         }
  69.         return $result;
  70.     }
  71.     /**
  72.      * Returns the autoincrement ID if supported or $id or fetches the current
  73.      * ID in a sequence called: $table.(empty($field) ? '' : '_'.$field)
  74.      *
  75.      * @param   string  name of the table into which a new row was inserted
  76.      * @param   string  name of the field into which a new row was inserted
  77.      */
  78.     public function lastInsertId($table = null, $field = null)
  79.     {
  80.         return $this->conn->getDbh()->lastInsertId();
  81.     }
  82.     /**
  83.      * Returns the current id of a sequence
  84.      *
  85.      * @param string $seqName   name of the sequence
  86.      *
  87.      * @return integer          current id in the given sequence
  88.      */
  89.     public function currId($seqName)
  90.     {
  91.         $sequenceName = $this->conn->quoteIdentifier($this->conn->formatter->getSequenceName($seqName), true);
  92.         
  93.  
  94.         $query = 'SELECT GEN_ID(' . $sequenceName . ', 0) as the_value FROM RDB$DATABASE';
  95.         try {
  96.             $value = $this->conn->fetchOne($query);
  97.         } catch(Doctrine_Connection_Exception $e) {
  98.             throw new Doctrine_Sequence_Exception('Unable to select from ' . $seqName);
  99.         }
  100.         if ( ! is_numeric($value)) {
  101.             throw new Doctrine_Sequence_Exception('could not find value in sequence table');
  102.         }
  103.         return $value;
  104.     }
  105. }