Source for file ibase.php
Documentation is available at ibase.php
// +----------------------------------------------------------------------+
// +----------------------------------------------------------------------+
// | Copyright (c) 1998-2004 Manuel Lemos, Tomas V.V.Cox, |
// | Stig. S. Bakken, Lukas Smith |
// | All rights reserved. |
// +----------------------------------------------------------------------+
// | MDB is a merge of PEAR DB and Metabases that provides a unified DB |
// | API as well as database abstraction for PHP applications. |
// | This LICENSE is in the BSD license style. |
// | Redistribution and use in source and binary forms, with or without |
// | modification, are permitted provided that the following conditions |
// | Redistributions of source code must retain the above copyright |
// | notice, this list of conditions and the following disclaimer. |
// | Redistributions in binary form must reproduce the above copyright |
// | notice, this list of conditions and the following disclaimer in the |
// | documentation and/or other materials provided with the distribution. |
// | Neither the name of Manuel Lemos, Tomas V.V.Cox, Stig. S. Bakken, |
// | Lukas Smith nor the names of his contributors may be used to endorse |
// | or promote products derived from this software without specific prior|
// | written permission. |
// | 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 |
// | REGENTS 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. |
// +----------------------------------------------------------------------+
// | Author: Lorenzo Alberton <l.alberton@quipo.it> |
// +----------------------------------------------------------------------+
// $Id: ibase.php,v 1.2.4.3 2004/02/15 16:23:09 lsmith Exp $
if(!defined('MDB_MANAGER_IBASE_INCLUDED'))
define('MDB_MANAGER_IBASE_INCLUDED', 1 );
require_once('MDB/Modules/Manager/Common.php');
* MDB FireBird/InterBase driver for the management modules
* @author Lorenzo Alberton <l.alberton@quipo.it>
class MDB_Manager_ibase extends MDB_Manager_common
* @param object $db database object that is extended by this class
* @param string $name name of the database that should be created
* @return mixed MDB_OK on success, a MDB error on failure
function createDatabase (&$db, $name)
'PHP Interbase API does not support direct queries. You have to '
. 'create the db manually by using isql command or a similar program'));
* drop an existing database
* @param object $db database object that is extended by this class
* @param string $name name of the database that should be dropped
* @return mixed MDB_OK on success, a MDB error on failure
function dropDatabase (&$db, $name)
'PHP Interbase API does not support direct queries. You have '
. 'to drop the db manually by using isql command or a similar program'));
// {{{ checkSupportedChanges()
* check if planned changes are supported
* @param object $db database object that is extended by this class
* @param string $name name of the database that should be dropped
* @return mixed MDB_OK on success, a MDB error on failure
function checkSupportedChanges (&$db, &$changes)
for($change=0 , reset($changes);
next($changes), $change++ )
'Check supported changes: it is not supported changes to field not null constraint'));
'Check supported changes: it is not supported changes to field default value'));
'Check supported changes: it is not supported changes to field default length'));
'Check supported changes: it is not supported change of type' . key($changes)));
* alter an existing table
* @param object $db database object that is extended by this class
* @param string $name name of the table that is intended to be changed.
* @param array $changes associative array that contains the details of each type
* of change that is intended to be performed. The types of
* changes that are currently supported are defined as follows:
* New name for the table.
* Associative array with the names of fields to be added as
* indexes of the array. The value of each entry of the array
* should be set to another associative array with the properties
* of the fields to be added. The properties of the fields should
* be the same as defined by the Metabase parser.
* Additionally, there should be an entry named Declaration that
* is expected to contain the portion of the field declaration already
* in DBMS specific SQL code as it is used in the CREATE TABLE statement.
* Associative array with the names of fields to be removed as indexes
* of the array. Currently the values assigned to each entry are ignored.
* An empty array should be used for future compatibility.
* Associative array with the names of fields to be renamed as indexes
* of the array. The value of each entry of the array should be set to
* another associative array with the entry named name with the new
* field name and the entry named Declaration that is expected to contain
* the portion of the field declaration already in DBMS specific SQL code
* as it is used in the CREATE TABLE statement.
* Associative array with the names of the fields to be changed as indexes
* of the array. Keep in mind that if it is intended to change either the
* name of a field and any other properties, the ChangedFields array entries
* should have the new names of the fields as array indexes.
* The value of each entry of the array should be set to another associative
* array with the properties of the fields to that are meant to be changed as
* array entries. These entries should be assigned to the new values of the
* respective properties. The properties of the fields should be the same
* as defined by the Metabase parser.
* If the default property is meant to be added, removed or changed, there
* should also be an entry with index ChangedDefault assigned to 1. Similarly,
* if the notnull constraint is to be added or removed, there should also be
* an entry with index ChangedNotNull assigned to 1.
* Additionally, there should be an entry named Declaration that is expected
* to contain the portion of the field changed declaration already in DBMS
* specific SQL code as it is used in the CREATE TABLE statement.
* 'AddedFields' => array(
* 'Declaration' => 'quota INT'
* 'RemovedFields' => array(
* 'file_limit' => array(),
* 'time_limit' => array()
* 'ChangedFields' => array(
* 'Declaration' => "gender CHAR(1) DEFAULT 'M'"
* 'RenamedFields' => array(
* 'Declaration' => "gender CHAR(1) DEFAULT 'M'"
* @param boolean $check indicates whether the function should just check if the DBMS driver
* can perform the requested table alterations if the value is TRUE or
* actually perform them otherwise.
* @return mixed MDB_OK on success, a MDB error on failure
function alterTable (&$db, $name, &$changes, $check)
for($change=0 , reset($changes);
next($changes), $change++ )
$fields = $changes['ChangedFields'];
for($field=0 , reset($fields);
if(MDB::isError($err = $this->checkSupportedChanges ($fields[Key ($fields)]))) {
'Alter table: change type ' . key($changes) . ' not yet supported'));
if(isset ($changes['AddedFields'])) {
$fields = $changes['AddedFields'];
for($field=0 , reset($fields); $field< count($fields); next($fields), $field++ ) {
$query .= 'ADD ' . $fields[key($fields)]['Declaration'];
if(isset ($changes['RemovedFields'])) {
$fields = $changes['RemovedFields'];
for($field=0 , reset($fields); $field< count($fields); next($fields), $field++ ) {
$query .= 'DROP ' . key($fields);
if(isset ($changes['RenamedFields'])) {
$fields = $changes['RenamedFields'];
for($field=0 , reset($fields); $field< count($fields); next($fields), $field++ ) {
$query .= 'ALTER ' . key($fields) . ' TO ' . $fields[Key ($fields)]['name'];
if(isset ($changes['ChangedFields'])) {
$fields = $changes['ChangedFields'];
for($field=0 , reset($fields); $field< count($fields); next($fields), $field++ ) {
$field_name = key($fields);
if(MDB::isError($err = $this->CheckSupportedChanges ($fields[Key ($fields)]))) {
$query .= 'ALTER '. $field_name. ' TYPE '. $db->getFieldDeclaration ($fields[$field_name]['Definition']);
if(MDB::isError($err = $db->query (" ALTER TABLE $name $query" ))) {
* list all fields in a tables in the current database
* @param object $db database object that is extended by this class
* @param string $table name of table that should be used in method
* @return mixed data array on success, a MDB error on failure
function listTableFields (&$db, $table)
$result = $db->query (" SELECT RDB$FIELD_SOURCE FROM RDB$RELATION_FIELDS WHERE RDB$RELATION_NAME='$table'" );
$columns = $db->getColumnNames ($result);
$db->freeResult ($columns);
// {{{ getTableFieldDefinition()
* list the views in the database
* @param object $db database object that is extended by this class
* @return mixed MDB_OK on success, a MDB error on failure
//return($db->queryCol('SELECT RDB$VIEW_NAME'));
* get the stucture of a field into an array
* @param object $dbs database object that is extended by this class
* @param string $table name of the table on which the index is to be created
* @param string $name name of the index to be created
* @param array $definition associative array that defines properties of the index to be created.
* Currently, only one property named FIELDS is supported. This property
* is also an associative with the names of the index fields as array
* indexes. Each entry of this array is set to another type of associative
* array that specifies properties of the index that are specific to
* Currently, only the sorting property is supported. It should be used
* to define the sorting direction of the index. It may be set to either
* ascending or descending.
* Not all DBMS support index sorting direction configuration. The DBMS
* drivers of those that do not support it ignore this property. Use the
* function support() to determine whether the DBMS driver can manage indexes.
* 'sorting' => 'ascending'
* 'last_login' => array()
* @return mixed MDB_OK on success, a MDB error on failure
function createIndex (&$db, $table, $name, $definition)
for($query_sort= '', $query_fields= '', $field=0 , reset($definition['FIELDS']);
$field< count($definition['FIELDS']);
$field++ , next($definition['FIELDS']))
$field_name = key($definition['FIELDS']);
$query_fields .= $field_name;
&& $db->support ('IndexSorting')
&& isset ($definition['FIELDS'][$field_name]['sorting']))
switch($definition['FIELDS'][$field_name]['sorting']) {
return($db->query ('CREATE'. (isset ($definition['unique']) ? ' UNIQUE' : '') . $query_sort
." INDEX $name ON $table ($query_fields)" ));
* @param object $db database object that is extended by this class
* @param string $seq_name name of the sequence to be created
* @param string $start start value of the sequence; default is 1
* @return mixed MDB_OK on success, a MDB error on failure
function createSequence (&$db, $seq_name, $start)
$seqname = $db->getSequenceName ($seq_name);
if (MDB::isError($result = $db->query (" CREATE GENERATOR $seqname" ))) {
if (MDB::isError($result = $db->query (" SET GENERATOR $seqname TO ". ($start-1 )))) {
if (MDB::isError($err = $db->dropSequence ($seq_name))) {
'Could not setup sequence start value and then it was not possible to drop it: '
. $err->getMessage (). ' - ' . $err->getUserInfo ()));
* @param object $db database object that is extended by this class
* @param string $seq_name name of the sequence to be dropped
* @return mixed MDB_OK on success, a MDB error on failure
function dropSequence (&$db, $seq_name)
$seqname = $db->getSequenceName ($seq_name);
return($db->query ("DELETE FROM RDB\$GENERATORS WHERE RDB\$GENERATOR_NAME='". strtoupper($seqname). "'"));
* list all sequences in the current database
* @param object $db database object that is extended by this class
* @return mixed data array on success, a MDB error on failure
function listSequences (&$db)
return($db->queryCol ("SELECT RDB\$GENERATOR_NAME FROM RDB\$GENERATORS"));
Documentation generated on Mon, 11 Mar 2019 10:15:24 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|