Viewing file:  ibase.php (15.03 KB) -rw-rw-rw-
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
/**
*
* Index, constraint and alter methods for DB_Table usage with
* PEAR::DB as backend. (Code adopted from PEAR::MDB2)
*
* @category DB
*
* @package DB_Table
*
* @author Mark Wiesemann <wiesemann@php.net>
*
* @license http://www.gnu.org/copyleft/lesser.html LGPL
*
* @version $Id: ibase.php,v 1.2 2006/02/26 15:54:56 wiesemann Exp $
*
*/
require_once 'DB/Table.php';
/**
*
* Index, constraint and alter methods for DB_Table usage with
* PEAR::DB as backend. (Code adopted from PEAR::MDB2)
*
* @category DB
*
* @package DB_Table
*
* @author Mark Wiesemann <wiesemann@php.net>
*
*/
class DB_Table_Manager_ibase {
/**
*
* The PEAR DB object that connects to the database.
*
* @access private
*
* @var object
*
*/
var $_db = null;
/**
* list all indexes in a table
*
* @param string $table name of table that should be used in method
* @return mixed data array on success, a PEAR error on failure
* @access public
*/
function listTableIndexes($table)
{
$table = strtoupper($table);
$query = "SELECT RDB\$INDEX_NAME
FROM RDB\$INDICES
WHERE UPPER(RDB\$RELATION_NAME)='$table'
AND RDB\$UNIQUE_FLAG IS NULL
AND RDB\$FOREIGN_KEY IS NULL";
$indexes = $this->_db->getCol($query);
if (PEAR::isError($indexes)) {
return $indexes;
}
$result = array();
foreach ($indexes as $index) {
$result[trim($index)] = true;
}
$result = array_change_key_case($result, CASE_LOWER);
return array_keys($result);
}
/**
* list all constraints in a table
*
* @param string $table name of table that should be used in method
* @return mixed data array on success, a PEAR error on failure
* @access public
*/
function listTableConstraints($table)
{
$table = strtoupper($table);
$query = "SELECT RDB\$INDEX_NAME
FROM RDB\$INDICES
WHERE UPPER(RDB\$RELATION_NAME)='$table'
AND (
RDB\$UNIQUE_FLAG IS NOT NULL
OR RDB\$FOREIGN_KEY IS NOT NULL
)";
$constraints = $this->_db->getCol($query);
if (PEAR::isError($constraints)) {
return $constraints;
}
$result = array();
foreach ($constraints as $constraint) {
$result[trim($constraint)] = true;
}
$result = array_change_key_case($result, CASE_LOWER);
return array_keys($result);
}
/**
* get the structure of an index into an array
*
* @param string $table name of table that should be used in method
* @param string $index_name name of index that should be used in method
* @return mixed data array on success, a PEAR error on failure
* @access public
*/
function getTableIndexDefinition($table, $index_name)
{
$table = strtoupper($table);
$index_name = strtoupper($index_name);
$query = "SELECT RDB\$INDEX_SEGMENTS.RDB\$FIELD_NAME AS field_name,
RDB\$INDICES.RDB\$UNIQUE_FLAG AS unique_flag,
RDB\$INDICES.RDB\$FOREIGN_KEY AS foreign_key,
RDB\$INDICES.RDB\$DESCRIPTION AS description
FROM RDB\$INDEX_SEGMENTS
LEFT JOIN RDB\$INDICES ON RDB\$INDICES.RDB\$INDEX_NAME = RDB\$INDEX_SEGMENTS.RDB\$INDEX_NAME
LEFT JOIN RDB\$RELATION_CONSTRAINTS ON RDB\$RELATION_CONSTRAINTS.RDB\$INDEX_NAME = RDB\$INDEX_SEGMENTS.RDB\$INDEX_NAME
WHERE UPPER(RDB\$INDICES.RDB\$RELATION_NAME)='$table'
AND UPPER(RDB\$INDICES.RDB\$INDEX_NAME)='$index_name'
AND RDB\$RELATION_CONSTRAINTS.RDB\$CONSTRAINT_TYPE IS NULL
ORDER BY RDB\$INDEX_SEGMENTS.RDB\$FIELD_POSITION;";
$result = $this->_db->query($query);
if (PEAR::isError($result)) {
return $result;
}
$index = $row = $result->fetchRow(DB_FETCHMODE_ASSOC);
$fields = array();
do {
$row = array_change_key_case($row, CASE_LOWER);
$fields[] = $row['field_name'];
} while (is_array($row = $result->fetchRow(DB_FETCHMODE_ASSOC)));
$result->free();
$fields = array_map('strtolower', $fields);
$definition = array();
$index = array_change_key_case($index, CASE_LOWER);
foreach ($fields as $field) {
$definition['fields'][$field] = array();
}
return $definition;
}
/**
* get the structure of a constraint into an array
*
* @param string $table name of table that should be used in method
* @param string $index_name name of index that should be used in method
* @return mixed data array on success, a PEAR error on failure
* @access public
*/
function getTableConstraintDefinition($table, $index_name)
{
$table = strtoupper($table);
$index_name = strtoupper($index_name);
$query = "SELECT RDB\$INDEX_SEGMENTS.RDB\$FIELD_NAME AS field_name,
RDB\$INDICES.RDB\$UNIQUE_FLAG AS unique_flag,
RDB\$INDICES.RDB\$FOREIGN_KEY AS foreign_key,
RDB\$INDICES.RDB\$DESCRIPTION AS description,
RDB\$RELATION_CONSTRAINTS.RDB\$CONSTRAINT_TYPE AS constraint_type
FROM RDB\$INDEX_SEGMENTS
LEFT JOIN RDB\$INDICES ON RDB\$INDICES.RDB\$INDEX_NAME = RDB\$INDEX_SEGMENTS.RDB\$INDEX_NAME
LEFT JOIN RDB\$RELATION_CONSTRAINTS ON RDB\$RELATION_CONSTRAINTS.RDB\$INDEX_NAME = RDB\$INDEX_SEGMENTS.RDB\$INDEX_NAME
WHERE UPPER(RDB\$INDICES.RDB\$RELATION_NAME)='$table'
AND UPPER(RDB\$INDICES.RDB\$INDEX_NAME)='$index_name'
ORDER BY RDB\$INDEX_SEGMENTS.RDB\$FIELD_POSITION;";
$result = $this->_db->query($query);
if (PEAR::isError($result)) {
return $result;
}
$index = $row = $result->fetchRow(DB_FETCHMODE_ASSOC);
$fields = array();
do {
$row = array_change_key_case($row, CASE_LOWER);
$fields[] = $row['field_name'];
} while (is_array($row = $result->fetchRow(DB_FETCHMODE_ASSOC)));
$result->free();
$fields = array_map('strtolower', $fields);
$definition = array();
$index = array_change_key_case($index, CASE_LOWER);
if ($index['constraint_type'] == 'PRIMARY KEY') {
$definition['primary'] = true;
}
if ($index['unique_flag']) {
$definition['unique'] = true;
}
foreach ($fields as $field) {
$definition['fields'][$field] = array();
}
return $definition;
}
/**
* drop existing index
*
* @param string $table name of table that should be used in method
* @param string $name name of the index to be dropped
* @return mixed DB_OK on success, a PEAR error on failure
* @access public
*/
function dropIndex($table, $name)
{
$name = $this->_db->quoteIdentifier($name);
return $this->_db->query("DROP INDEX $name");
}
/**
* drop existing constraint
*
* @param string $table name of table that should be used in method
* @param string $name name of the constraint to be dropped
* @return mixed DB_OK on success, a PEAR error on failure
* @access public
*/
function dropConstraint($table, $name)
{
$table = $this->_db->quoteIdentifier($table);
$name = $this->_db->quoteIdentifier($name);
return $this->_db->query("ALTER TABLE $table DROP CONSTRAINT $name");
}
/**
* alter an existing table
*
* @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:
*
* name
*
* New name for the table.
*
* add
*
* 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.
*
*
* remove
*
* 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.
*
* rename
*
* 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.
*
* change
*
* 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 change 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.
*
* Example
* array(
* 'name' => 'userlist',
* 'add' => array(
* 'quota' => array(
* 'type' => 'integer',
* 'unsigned' => 1
* )
* ),
* 'remove' => array(
* 'file_limit' => array(),
* 'time_limit' => array()
* ),
* 'change' => array(
* 'name' => array(
* 'length' => '20',
* 'definition' => array(
* 'type' => 'text',
* 'length' => 20,
* ),
* )
* ),
* 'rename' => array(
* 'sex' => array(
* 'name' => 'gender',
* 'definition' => array(
* 'type' => 'text',
* 'length' => 1,
* 'default' => 'M',
* ),
* )
* )
* )
*
* @param boolean $check (ignored in DB_Table)
* @access public
*
* @return mixed DB_OK on success, a PEAR error on failure
*/
function alterTable($name, $changes, $check)
{
foreach ($changes as $change_name => $change) {
switch ($change_name) {
case 'add':
case 'remove':
case 'rename':
case 'change':
break;
default:
return DB_Table::throwError(DB_TABLE_ERR_ALTER_TABLE_IMPOS);
}
}
$query = '';
if (array_key_exists('add', $changes)) {
foreach ($changes['add'] as $field_name => $field) {
if ($query) {
$query.= ', ';
}
$query.= 'ADD ' . $field_name . ' ' . $field;
}
}
if (array_key_exists('remove', $changes)) {
foreach ($changes['remove'] as $field_name => $field) {
if ($query) {
$query.= ', ';
}
$field_name = $this->_db->quoteIdentifier($field_name);
$query.= 'DROP ' . $field_name;
}
}
if (array_key_exists('rename', $changes)) {
foreach ($changes['rename'] as $field_name => $field) {
if ($query) {
$query.= ', ';
}
$field_name = $this->_db->quoteIdentifier($field_name);
$query.= 'ALTER ' . $field_name . ' TO ' . $this->_db->quoteIdentifier($field['name']);
}
}
if (array_key_exists('change', $changes)) {
// missing support to change DEFAULT and NULLability
foreach ($changes['change'] as $field_name => $field) {
if ($query) {
$query.= ', ';
}
$field_name = $this->_db->quoteIdentifier($field_name);
$query.= 'ALTER ' . $field_name.' TYPE ' . $field['definition'];
}
}
if (!strlen($query)) {
return DB_OK;
}
$name = $this->_db->quoteIdentifier($name);
$result = $this->_db->query("ALTER TABLE $name $query");
return $result;
}
}
?>
|