1
0
mirror of synced 2024-12-14 23:26:04 +03:00
doctrine2/lib/Doctrine/Sequence.php

74 lines
2.8 KiB
PHP
Raw Normal View History

2007-01-06 02:16:50 +03:00
<?php
/*
* $Id$
*
* 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.phpdoctrine.org>.
2007-01-06 02:16:50 +03:00
*/
2007-01-08 03:13:41 +03:00
Doctrine::autoload('Doctrine_Connection_Module');
2007-01-06 02:16:50 +03:00
/**
* Doctrine_Sequence
* The base class for sequence handling drivers.
*
* @package Doctrine
* @subpackage Sequence
2007-01-06 02:16:50 +03:00
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
*/
class Doctrine_Sequence extends Doctrine_Connection_Module
{
2007-01-06 02:25:25 +03:00
/**
* Returns the next free id of a sequence
*
* @param string $seqName name of the sequence
* @param bool when true missing sequences are automatic created
*
* @return integer next id in the given sequence
*/
2007-02-01 12:58:53 +03:00
public function nextId($seqName, $ondemand = true)
2007-01-06 02:25:25 +03:00
{
throw new Doctrine_Sequence_Exception('method not implemented');
}
2007-01-06 02:25:25 +03:00
/**
* Returns the autoincrement ID if supported or $id or fetches the current
* ID in a sequence called: $table.(empty($field) ? '' : '_'.$field)
*
* @param string name of the table into which a new row was inserted
* @param string name of the field into which a new row was inserted
*/
2007-02-01 12:58:53 +03:00
public function lastInsertId($table = null, $field = null)
2007-01-06 02:25:25 +03:00
{
throw new Doctrine_Sequence_Exception('method not implemented');
}
2007-01-06 02:25:25 +03:00
/**
* Returns the current id of a sequence
*
* @param string $seqName name of the sequence
*
* @return integer current id in the given sequence
*/
2007-02-01 12:58:53 +03:00
public function currId($seqName)
2007-01-06 02:25:25 +03:00
{
$this->warnings[] = 'database does not support getting current
sequence value, the sequence value was incremented';
2007-02-01 12:58:53 +03:00
return $this->nextId($seqName);
2007-01-06 02:25:25 +03:00
}
}