Source for file mysql.php
Documentation is available at mysql.php
// vim: set et ts=4 sw=4 fdm=marker:
// +----------------------------------------------------------------------+
// | PHP versions 4 and 5 |
// +----------------------------------------------------------------------+
// | Copyright (c) 1998-2008 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 |
// | 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: mysql.php 327310 2012-08-27 15:16:18Z danielc $
require_once 'MDB2/Driver/Datatype/Common.php';
* @author Lukas Smith <smith@pooteeweet.org>
// {{{ _getCharsetFieldDeclaration()
* Obtain DBMS specific SQL code portion needed to set the CHARACTER SET
* of a field declaration to be used in statements like CREATE TABLE.
* @param string $charset name of the charset
* @return string DBMS specific SQL code portion needed to set the CHARACTER SET
* of a field declaration.
function _getCharsetFieldDeclaration ($charset)
return 'CHARACTER SET '. $charset;
// {{{ _getCollationFieldDeclaration()
* Obtain DBMS specific SQL code portion needed to set the COLLATION
* of a field declaration to be used in statements like CREATE TABLE.
* @param string $collation name of the collation
* @return string DBMS specific SQL code portion needed to set the COLLATION
* of a field declaration.
function _getCollationFieldDeclaration ($collation)
return 'COLLATE '. $collation;
* Obtain DBMS specific SQL code portion needed to declare
* @param string $type type to which the value should be converted to
* @param string $name name the field to be declared.
* @param string $field definition of the field
* @return string DBMS-specific SQL code portion that should be used to
* declare the specified field.
// MySQL DDL syntax forbids combining NOT NULL with DEFAULT NULL.
// To get a default of NULL for NOT NULL columns, omit it.
if ( isset ($field['notnull'])
&& !empty ($field['notnull'])
&& null === $field['default']
unset ($field['default']);
return parent ::getDeclaration ($type, $name, $field);
// {{{ 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:
* 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.
* Text value to be used as default for this field.
* Boolean flag that indicates whether this field is constrained
* @return string DBMS specific SQL code portion that should be used to
* declare the specified field.
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
switch ($field['type']) {
$field['length'] = $db->varchar_max_length;
$length = !empty ($field['length']) ? $field['length'] : false;
$fixed = !empty ($field['fixed']) ? $field['fixed'] : false;
return $fixed ? ($length ? 'CHAR('. $length. ')' : 'CHAR(255)')
: ($length ? 'VARCHAR('. $length. ')' : 'TEXT');
if (!empty ($field['length'])) {
$length = $field['length'];
} elseif ($length <= 65532 ) {
} elseif ($length <= 16777215 ) {
if (!empty ($field['length'])) {
$length = $field['length'];
} elseif ($length <= 65532 ) {
} elseif ($length <= 16777215 ) {
if (!empty ($field['length'])) {
$length = $field['length'];
} elseif ($length == 2 ) {
} elseif ($length == 3 ) {
} elseif ($length == 4 ) {
if (!empty ($field['length'])) {
$l = '(' . $field['length'];
if (!empty ($field['scale'])) {
$l .= ',' . $field['scale'];
$length = !empty ($field['length']) ? $field['length'] : 18;
$scale = !empty ($field['scale']) ? $field['scale'] : $db->options ['decimal_places'];
return 'DECIMAL('. $length. ','. $scale. ')';
// {{{ _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 string $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:
* Boolean flag that indicates whether the field
* should be declared as unsigned integer if
* Integer value to be used as default for this
* 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.
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
$default = $autoinc = '';
if (!empty ($field['autoincrement'])) {
$autoinc = ' AUTO_INCREMENT PRIMARY KEY';
if ($field['default'] === '') {
$field['default'] = empty ($field['notnull']) ? null : 0;
$default = ' DEFAULT '. $this->quote ($field['default'], 'integer');
$notnull = empty ($field['notnull']) ? '' : ' NOT NULL';
$unsigned = empty ($field['unsigned']) ? '' : ' UNSIGNED';
if (empty ($default) && empty ($notnull)) {
$default = ' DEFAULT NULL';
$name = $db->quoteIdentifier ($name, true );
// {{{ _getFloatDeclaration()
* Obtain DBMS specific SQL code portion needed to declare an float type
* field to be used in statements like CREATE TABLE.
* @param string $name name the field to be declared.
* @param string $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:
* Boolean flag that indicates whether the field
* should be declared as unsigned float if
* float value to be used as default for this
* 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.
// Since AUTO_INCREMENT can be used for integer or floating-point types,
// reuse the INTEGER declaration
// @see http://bugs.mysql.com/bug.php?id=31032
// {{{ _getDecimalDeclaration()
* Obtain DBMS specific SQL code portion needed to declare an decimal type
* field to be used in statements like CREATE TABLE.
* @param string $name name the field to be declared.
* @param string $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:
* Boolean flag that indicates whether the field
* should be declared as unsigned integer if
* Decimal value to be used as default for this
* 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.
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
if ($field['default'] === '') {
$field['default'] = empty ($field['notnull']) ? null : 0;
$default = ' DEFAULT '. $this->quote ($field['default'], 'integer');
} elseif (empty ($field['notnull'])) {
$default = ' DEFAULT NULL';
$notnull = empty ($field['notnull']) ? '' : ' NOT NULL';
$unsigned = empty ($field['unsigned']) ? '' : ' UNSIGNED';
$name = $db->quoteIdentifier ($name, true );
* build a pattern matching string
* @param array $pattern even keys are strings, odd are patterns (% and _)
* @param string $operator optional pattern operator (LIKE, ILIKE and maybe others in the future)
* @param string $field optional field name that is being matched against
* (might be required when emulating ILIKE)
* @return string SQL pattern
function matchPattern($pattern, $operator = null , $field = null )
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
if (null !== $operator) {
$field = (null === $field) ? '' : $field. ' ';
$match = $field. 'NOT LIKE ';
$match = $field. 'LIKE BINARY ';
$match = $field. 'NOT LIKE BINARY ';
return $db->raiseError (MDB2_ERROR_UNSUPPORTED , null , null ,
'not a supported operator type:'. $operator, __FUNCTION__ );
foreach ($pattern as $key => $value) {
$match.= $db->escapePattern ($db->escape ($value));
$match.= $this->patternEscapeString ();
// {{{ _mapNativeDatatype()
* Maps a native array description of a field to a MDB2 datatype and length
* @param array $field native field description
* @return array containing the various possible types, length, sign, fixed
$db_type = strtok($db_type, '(), ');
if ($db_type == 'national') {
if (!empty ($field['length'])) {
$length = strtok($field['length'], ', ');
$unsigned = $fixed = null;
$unsigned = preg_match('/ unsigned/i', $field['type']);
$unsigned = preg_match('/ unsigned/i', $field['type']);
$unsigned = preg_match('/ unsigned/i', $field['type']);
$unsigned = preg_match('/ unsigned/i', $field['type']);
$unsigned = preg_match('/ unsigned/i', $field['type']);
} elseif (strstr($db_type, 'text')) {
if ($decimal == 'binary') {
foreach ($matches[0 ] as $value) {
if ($length == '1' && count($matches[0 ]) == 2 ) {
$unsigned = preg_match('/ unsigned/i', $field['type']);
if ($decimal !== false ) {
$length = $length. ','. $decimal;
$unsigned = preg_match('/ unsigned/i', $field['type']);
if ($decimal !== false ) {
$length = $length. ','. $decimal;
$db = $this->getDBInstance ();
if (MDB2 ::isError ($db)) {
return $db->raiseError (MDB2_ERROR_UNSUPPORTED , null , null ,
'unknown database attribute type: '. $db_type, __FUNCTION__ );
return array ($type, $length, $unsigned, $fixed);
Documentation generated on Mon, 11 Mar 2019 15:51:12 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|