pgsqlSequence.php

Go to the documentation of this file.

<?php

/**
 * Postgres sequence class
 *
 * @package objSQL
 * @version 2.1.0
 * @author MT Jordan <mtjo62@gmail.com>
 * @link http://objsql.sourceforge.net
 * @copyright 2004-2010 openSource Partners
 * @license LGPL
 * @revision $Id: pgsqlSequence.php,v 1.4 2008-01-19 10:31:23-05 mt_jordan Exp $
 */

class pgsqlSequence
{
    /**********************************************
     * Internal variables
     *********************************************/

    /**
     * Database connection object
     *
     * @access private
     * @var    mixed
     */
    private $objConnection;

    /**
     * Sequence maximum value
     *
     * @access private
     * @var    int
     */
    private $objMax;

    /**
     * Sequence name
     *
     * @access private
     * @var    str
     */
    private $objSequence;

    /**********************************************
     * Class methods
     *********************************************/

    /**
     * Constructor
     *
     * @access public
     * @param  str   $sequence
     * @param  int   $max
     * @param  mixed $connection
     */
    public function __construct( $sequence, $max, $connection )
    {
        $this->objConnection = $connection;
        $this->objMax        = $max;
        $this->objSequence   = $sequence;
    }

    /**
     * Return property for named sequence
     *
     * @access public
     * @return mixed
     */
    public function getSequence()
    {
         return "NEXTVAL('" . $this->objSequence . "')";
    }

    /**
     * Create sequence object
     *
     * @access public
     * @return mixed
     */
    public function setSequence()
    {
        //make sure $this->objMax is an unsigned int > 0
        $objMax = ( is_numeric( $this->objMax ) && $this->objMax > 0 ) ? ' MAXVALUE ' . ( int )$this->objMax : '';
        $objSeq = 'CREATE SEQUENCE ' . $this->objSequence . ' INCREMENT 1 MINVALUE 1' . $objMax . ' START 1';

        return pg_query( $this->objConnection, $objSeq )
        or trigger_error( pg_last_error( $this->objConnection ), E_USER_WARNING );
    }
}

?>