<?php
|
// +----------------------------------------------------------------------+
|
// | PHP versions 4 and 5 |
|
// +----------------------------------------------------------------------+
|
// | Copyright (c) 1998-2004 Manuel Lemos, Tomas V.V.Cox, |
|
// | Stig. S. Bakken, Lukas Smith |
|
// | All rights reserved. |
|
// +----------------------------------------------------------------------+
|
// | MDB2 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 |
|
// | are met: |
|
// | |
|
// | 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: Lukas Smith <smith@pooteeweet.org> |
|
// +----------------------------------------------------------------------+
|
|
// $Id$
|
|
require_once 'MDB2/Driver/Datatype/Common.php';
|
|
/**
|
* MDB2 OCI8 driver
|
*
|
* @package MDB2
|
* @category Database
|
* @author Lukas Smith <smith@pooteeweet.org>
|
*/
|
class MDB2_Driver_Datatype_oci8 extends MDB2_Driver_Datatype_Common
|
{
|
// {{{ convertResult()
|
|
/**
|
* convert a value to a RDBMS indepdenant MDB2 type
|
*
|
* @param mixed $value value to be converted
|
* @param int $type constant that specifies which type to convert to
|
* @return mixed converted value
|
* @access public
|
*/
|
function convertResult($value, $type)
|
{
|
if (is_null($value)) {
|
return null;
|
}
|
switch ($type) {
|
case 'date':
|
return substr($value, 0, strlen('YYYY-MM-DD'));
|
case 'time':
|
return substr($value, strlen('YYYY-MM-DD '), strlen('HH:MI:SS'));
|
default:
|
return $this->_baseConvertResult($value, $type);
|
}
|
}
|
|
// }}}
|
// {{{ getTypeDeclaration()
|
|
/**
|
* Obtain DBMS specific SQL code portion needed to declare an text type
|
* field to be used in statements like CREATE TABLE.
|
*
|
* @param array $field associative array with the name of the properties
|
* of the field being declared as array indexes. Currently, the types
|
* of supported field properties are as follows:
|
*
|
* length
|
* Integer value that determines the maximum length of the text
|
* field. If this argument is missing the field should be
|
* declared to have the longest length allowed by the DBMS.
|
*
|
* default
|
* Text value to be used as default for this field.
|
*
|
* notnull
|
* Boolean flag that indicates whether this field is constrained
|
* to not be set to null.
|
* @return string DBMS specific SQL code portion that should be used to
|
* declare the specified field.
|
* @access public
|
*/
|
function getTypeDeclaration($field)
|
{
|
$db =& $this->getDBInstance();
|
if (PEAR::isError($db)) {
|
return $db;
|
}
|
|
switch ($field['type']) {
|
case 'text':
|
$length = (array_key_exists('length', $field) ? $field['length'] : (($length = $db->options['default_text_field_length']) ? $length : 4000));
|
return 'VARCHAR ('.$length.')';
|
case 'clob':
|
return 'CLOB';
|
case 'blob':
|
return 'BLOB';
|
case 'integer':
|
return 'INT';
|
case 'boolean':
|
return 'CHAR (1)';
|
case 'date':
|
case 'time':
|
case 'timestamp':
|
return 'DATE';
|
case 'float':
|
return 'NUMBER';
|
case 'decimal':
|
return 'NUMBER(*,'.$db->options['decimal_places'].')';
|
}
|
}
|
|
// }}}
|
// {{{ _getIntegerDeclaration()
|
|
/**
|
* Obtain DBMS specific SQL code portion needed to declare an integer type
|
* field to be used in statements like CREATE TABLE.
|
*
|
* @param string $name name the field to be declared.
|
* @param array $field associative array with the name of the properties
|
* of the field being declared as array indexes. Currently, the types
|
* of supported field properties are as follows:
|
*
|
* unsigned
|
* Boolean flag that indicates whether the field should be
|
* declared as unsigned integer if possible.
|
*
|
* default
|
* Integer value to be used as default for this field.
|
*
|
* notnull
|
* Boolean flag that indicates whether this field is constrained
|
* to not be set to null.
|
* @param string $table name of the current table being processed
|
* by alterTable(), used for autoincrement emulation
|
* @return string DBMS specific SQL code portion that should be used to
|
* declare the specified field.
|
* @access protected
|
*/
|
function _getIntegerDeclaration($name, $field, $table = null)
|
{
|
if (array_key_exists('unsigned', $field) && $field['unsigned']) {
|
$db =& $this->getDBInstance();
|
if (PEAR::isError($db)) {
|
return $db;
|
}
|
$db->warning[] = "unsigned integer field \"$name\" is being declared as signed integer";
|
}
|
|
$default = array_key_exists('default', $field) ? ' DEFAULT '.
|
$this->quote($field['default'], 'integer') : '';
|
$notnull = (array_key_exists('notnull', $field) && $field['notnull']) ? ' NOT NULL' : '';
|
return $name.' '.$this->getTypeDeclaration($field).$default.$notnull;
|
}
|
|
// }}}
|
// {{{ _getTextDeclaration()
|
|
/**
|
* Obtain DBMS specific SQL code portion needed to declare an text type
|
* field to be used in statements like CREATE TABLE.
|
*
|
* @param string $name name the field to be declared.
|
* @param array $field associative array with the name of the properties
|
* of the field being declared as array indexes. Currently, the types
|
* of supported field properties are as follows:
|
*
|
* length
|
* Integer value that determines the maximum length of the text
|
* field. If this argument is missing the field should be
|
* declared to have the longest length allowed by the DBMS.
|
*
|
* default
|
* Text value to be used as default for this field.
|
*
|
* notnull
|
* Boolean flag that indicates whether this field is constrained
|
* to not be set to null.
|
* @return string DBMS specific SQL code portion that should be used to
|
* declare the specified field.
|
* @access protected
|
*/
|
function _getTextDeclaration($name, $field)
|
{
|
$type = $this->getTypeDeclaration($field);
|
$default = array_key_exists('default', $field) ? ' DEFAULT '.
|
$this->quote($field['default'], 'text') : '';
|
$notnull = (array_key_exists('notnull', $field) && $field['notnull']) ? ' NOT NULL' : '';
|
return $name.' '.$type.$default.$notnull;
|
}
|
|
// }}}
|
// {{{ _getCLOBDeclaration()
|
|
/**
|
* Obtain DBMS specific SQL code portion needed to declare an character
|
* large object type field to be used in statements like CREATE TABLE.
|
*
|
* @param string $name name the field to be declared.
|
* @param array $field associative array with the name of the properties
|
* of the field being declared as array indexes. Currently, the types
|
* of supported field properties are as follows:
|
*
|
* length
|
* Integer value that determines the maximum length of the large
|
* object field. If this argument is missing the field should be
|
* declared to have the longest length allowed by the DBMS.
|
*
|
* notnull
|
* Boolean flag that indicates whether this field is constrained
|
* to not be set to null.
|
* @return string DBMS specific SQL code portion that should be used to
|
* declare the specified field.
|
* @access public
|
*/
|
function _getCLOBDeclaration($name, $field)
|
{
|
$notnull = (array_key_exists('notnull', $field) && $field['notnull']) ? ' NOT NULL' : '';
|
return $name.' '.$this->getTypeDeclaration($field).$notnull;
|
}
|
|
// }}}
|
// {{{ _getBLOBDeclaration()
|
|
/**
|
* Obtain DBMS specific SQL code portion needed to declare an binary large
|
* object type field to be used in statements like CREATE TABLE.
|
*
|
* @param string $name name the field to be declared.
|
* @param array $field associative array with the name of the properties
|
* of the field being declared as array indexes. Currently, the types
|
* of supported field properties are as follows:
|
*
|
* length
|
* Integer value that determines the maximum length of the large
|
* object field. If this argument is missing the field should be
|
* declared to have the longest length allowed by the DBMS.
|
*
|
* notnull
|
* Boolean flag that indicates whether this field is constrained
|
* to not be set to null.
|
* @return string DBMS specific SQL code portion that should be used to
|
* declare the specified field.
|
* @access protected
|
*/
|
function _getBLOBDeclaration($name, $field)
|
{
|
$notnull = (array_key_exists('notnull', $field) && $field['notnull']) ? ' NOT NULL' : '';
|
return $name.' '.$this->getTypeDeclaration($field).$notnull;
|
}
|
|
// }}}
|
// {{{ _getDateDeclaration()
|
|
/**
|
* Obtain DBMS specific SQL code portion needed to declare a date type
|
* field to be used in statements like CREATE TABLE.
|
*
|
* @param string $name name the field to be declared.
|
* @param array $field associative array with the name of the properties
|
* of the field being declared as array indexes. Currently, the types
|
* of supported field properties are as follows:
|
*
|
* default
|
* Date value to be used as default for this field.
|
*
|
* notnull
|
* Boolean flag that indicates whether this field is constrained
|
* to not be set to null.
|
* @return string DBMS specific SQL code portion that should be used to
|
* declare the specified field.
|
* @access protected
|
*/
|
function _getDateDeclaration($name, $field)
|
{
|
$default = array_key_exists('default', $field) ? ' DEFAULT '.
|
$this->quote($field['default'], 'date') : '';
|
$notnull = (array_key_exists('notnull', $field) && $field['notnull']) ? ' NOT NULL' : '';
|
return $name.' '.$this->getTypeDeclaration($field).$default.$notnull;
|
}
|
|
// }}}
|
// {{{ _getTimestampDeclaration()
|
|
/**
|
* Obtain DBMS specific SQL code portion needed to declare a timestamp
|
* field to be used in statements like CREATE TABLE.
|
*
|
* @param string $name name the field to be declared.
|
* @param array $field associative array with the name of the properties
|
* of the field being declared as array indexes. Currently, the types
|
* of supported field properties are as follows:
|
*
|
* default
|
* Timestamp value to be used as default for this field.
|
*
|
* notnull
|
* Boolean flag that indicates whether this field is constrained
|
* to not be set to null.
|
* @return string DBMS specific SQL code portion that should be used to
|
* declare the specified field.
|
* @access protected
|
*/
|
function _getTimestampDeclaration($name, $field)
|
{
|
$default = array_key_exists('default', $field) ? ' DEFAULT '.
|
$this->quote($field['default'], 'timestamp') : '';
|
$notnull = (array_key_exists('notnull', $field) && $field['notnull']) ? ' NOT NULL' : '';
|
return $name.' '.$this->getTypeDeclaration($field).$default.$notnull; }
|
|
// }}}
|
// {{{ _getTimeDeclaration()
|
|
/**
|
* Obtain DBMS specific SQL code portion needed to declare a time
|
* field to be used in statements like CREATE TABLE.
|
*
|
* @param string $name name the field to be declared.
|
* @param array $field associative array with the name of the properties
|
* of the field being declared as array indexes. Currently, the types
|
* of supported field properties are as follows:
|
*
|
* default
|
* Time value to be used as default for this field.
|
*
|
* notnull
|
* Boolean flag that indicates whether this field is constrained
|
* to not be set to null.
|
* @return string DBMS specific SQL code portion that should be used to
|
* declare the specified field.
|
* @access protected
|
*/
|
function _getTimeDeclaration($name, $field)
|
{
|
$default = array_key_exists('default', $field) ? ' DEFAULT '.
|
$this->quote($field['default'], 'time') : '';
|
$notnull = (array_key_exists('notnull', $field) && $field['notnull']) ? ' NOT NULL' : '';
|
return $name.' '.$this->getTypeDeclaration($field).$default.$notnull;
|
}
|
|
// }}}
|
// {{{ _getFloatDeclaration()
|
|
/**
|
* Obtain DBMS specific SQL code portion needed to declare a float type
|
* field to be used in statements like CREATE TABLE.
|
*
|
* @param string $name name the field to be declared.
|
* @param array $field associative array with the name of the properties
|
* of the field being declared as array indexes. Currently, the types
|
* of supported field properties are as follows:
|
*
|
* default
|
* Float value to be used as default for this field.
|
*
|
* notnull
|
* Boolean flag that indicates whether this field is constrained
|
* to not be set to null.
|
* @return string DBMS specific SQL code portion that should be used to
|
* declare the specified field.
|
* @access protected
|
*/
|
function _getFloatDeclaration($name, $field)
|
{
|
$default = array_key_exists('default', $field) ? ' DEFAULT '.
|
$this->quote($field['default'], 'float') : '';
|
$notnull = (array_key_exists('notnull', $field) && $field['notnull']) ? ' NOT NULL' : '';
|
return $name.' '.$this->getTypeDeclaration($field).$default.$notnull;
|
}
|
|
// }}}
|
// {{{ _getDecimalDeclaration()
|
|
/**
|
* Obtain DBMS specific SQL code portion needed to declare a decimal type
|
* field to be used in statements like CREATE TABLE.
|
*
|
* @param string $name name the field to be declared.
|
* @param array $field associative array with the name of the properties
|
* of the field being declared as array indexes. Currently, the types
|
* of supported field properties are as follows:
|
*
|
* default
|
* Decimal value to be used as default for this field.
|
*
|
* notnull
|
* Boolean flag that indicates whether this field is constrained
|
* to not be set to null.
|
* @return string DBMS specific SQL code portion that should be used to
|
* declare the specified field.
|
* @access protected
|
*/
|
function _getDecimalDeclaration($name, $field)
|
{
|
$default = array_key_exists('default', $field) ? ' DEFAULT '.
|
$this->quote($field['default'], 'decimal') : '';
|
$notnull = (array_key_exists('notnull', $field) && $field['notnull']) ? ' NOT NULL' : '';
|
return $name.' '.$this->getTypeDeclaration($field).$default.$notnull;
|
}
|
|
// }}}
|
// {{{ _quoteCLOB()
|
|
/**
|
* Convert a text value into a DBMS specific format that is suitable to
|
* compose query statements.
|
*
|
* @param $value
|
* @return string text string that represents the given argument value in
|
* a DBMS specific format.
|
* @access protected
|
*/
|
function _quoteCLOB($value)
|
{
|
return 'EMPTY_CLOB()';
|
}
|
|
// }}}
|
// {{{ _quoteBLOB()
|
|
/**
|
* Convert a text value into a DBMS specific format that is suitable to
|
* compose query statements.
|
*
|
* @param $value
|
* @return string text string that represents the given argument value in
|
* a DBMS specific format.
|
* @access protected
|
*/
|
function _quoteBLOB($value)
|
{
|
return 'EMPTY_BLOB()';
|
}
|
|
// }}}
|
// {{{ _quoteDate()
|
|
/**
|
* Convert a text value into a DBMS specific format that is suitable to
|
* compose query statements.
|
*
|
* @param string $value text string value that is intended to be converted.
|
* @return string text string that represents the given argument value in
|
* a DBMS specific format.
|
* @access protected
|
*/
|
function _quoteDate($value)
|
{
|
return $this->_quoteText("$value 00:00:00");
|
}
|
|
// }}}
|
// {{{ _quoteTimestamp()
|
|
/**
|
* Convert a text value into a DBMS specific format that is suitable to
|
* compose query statements.
|
*
|
* @param string $value text string value that is intended to be converted.
|
* @return string text string that represents the given argument value in
|
* a DBMS specific format.
|
* @access protected
|
*/
|
function _quoteTimestamp($value)
|
{
|
return $this->_quoteText($value);
|
}
|
|
// }}}
|
// {{{ _quoteTime()
|
|
/**
|
* Convert a text value into a DBMS specific format that is suitable to
|
* compose query statements.
|
*
|
* @param string $value text string value that is intended to be converted.
|
* @return string text string that represents the given argument value in
|
* a DBMS specific format.
|
* @access protected
|
*/
|
function _quoteTime($value)
|
{
|
return $this->_quoteText("0001-01-01 $value");
|
}
|
|
// }}}
|
// {{{ _quoteFloat()
|
|
/**
|
* Convert a text value into a DBMS specific format that is suitable to
|
* compose query statements.
|
*
|
* @param string $value text string value that is intended to be converted.
|
* @return string text string that represents the given argument value in
|
* a DBMS specific format.
|
* @access protected
|
*/
|
function _quoteFloat($value)
|
{
|
return (float)$value;
|
}
|
|
// }}}
|
// {{{ _quoteDecimal()
|
|
/**
|
* Convert a text value into a DBMS specific format that is suitable to
|
* compose query statements.
|
*
|
* @param string $value text string value that is intended to be converted.
|
* @return string text string that represents the given argument value in
|
* a DBMS specific format.
|
* @access protected
|
*/
|
function _quoteDecimal($value)
|
{
|
$db =& $this->getDBInstance();
|
if (PEAR::isError($db)) {
|
return $db;
|
}
|
|
return $db->escape($value);
|
}
|
|
// }}}
|
// {{{ writeLOBToFile()
|
|
/**
|
* retrieve LOB from the database
|
*
|
* @param resource $lob stream handle
|
* @param string $file name of the file into which the LOb should be fetched
|
* @return mixed MDB2_OK on success, a MDB2 error on failure
|
* @access protected
|
*/
|
function writeLOBToFile($lob, $file)
|
{
|
$lob_data = stream_get_meta_data($lob);
|
$lob_index = $lob_data['wrapper_data']->lob_index;
|
if (!@$this->lobs[$lob_index]['value']->writelobtofile($file)) {
|
$db =& $this->getDBInstance();
|
if (PEAR::isError($db)) {
|
return $db;
|
}
|
|
return $db->raiseError();
|
}
|
return MDB2_OK;
|
}
|
|
// }}}
|
// {{{ _retrieveLOB()
|
|
/**
|
* retrieve LOB from the database
|
*
|
* @param int $lob_index from the lob array
|
* @return mixed MDB2_OK on success, a MDB2 error on failure
|
* @access protected
|
*/
|
function _retrieveLOB(&$lob)
|
{
|
if (!array_key_exists('loaded', $lob)) {
|
if (!is_object($lob['ressource'])) {
|
$db =& $this->getDBInstance();
|
if (PEAR::isError($db)) {
|
return $db;
|
}
|
|
return $db->raiseError(MDB2_ERROR, null, null,
|
'attemped to retrieve LOB from non existing or NULL column');
|
}
|
$lob['value'] = $lob['ressource']->load();
|
$lob['loaded'] = true;
|
}
|
return MDB2_OK;
|
}
|
}
|
|
?>
|
