Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
  • Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.
<?php
<
/**
< @version v5.20.16 12-Jan-2020 < @copyright (c) 2000-2013 John Lim (jlim#natsoft.com). All rights reserved. < @copyright (c) 2014 Damien Regad, Mark Newnham and the ADOdb community < Released under both BSD license and Lesser GPL library license. < Whenever there is any discrepancy between the two licenses, < the BSD license will take precedence. < < Set tabs to 4 for best viewing.
> * Data Dictionary for Microsoft SQL Server native (mssqlnative)
> * FileDescription */ > * > * This file is part of ADOdb, a Database Abstraction Layer library for PHP. /* > * In ADOdb, named quotes for MS SQL Server use ". From the MSSQL Docs: > * @package ADOdb > * @link https://adodb.org Project's web site and documentation Note Delimiters are for identifiers only. Delimiters cannot be used for keywords, > * @link https://github.com/ADOdb/ADOdb Source code and issue tracker whether or not they are marked as reserved in SQL Server. > * > * The ADOdb Library is dual-licensed, released under both the BSD 3-Clause Quoted identifiers are delimited by double quotation marks ("): > * and the GNU Lesser General Public Licence (LGPL) v2.1 or, at your option, SELECT * FROM "Blanks in Table Name" > * any later version. This means you can use it in proprietary products. > * See the LICENSE.md file distributed with this source code for details. Bracketed identifiers are delimited by brackets ([ ]): > * @license BSD-3-Clause SELECT * FROM [Blanks In Table Name] > * @license LGPL-2.1-or-later > * Quoted identifiers are valid only when the QUOTED_IDENTIFIER option is set to ON. By default, > * @copyright 2000-2013 John Lim the Microsoft OLE DB Provider for SQL Server and SQL Server ODBC driver set QUOTED_IDENTIFIER ON > * @copyright 2014 Damien Regad, Mark Newnham and the ADOdb community
when they connect. In Transact-SQL, the option can be set at various levels using SET QUOTED_IDENTIFIER, the quoted identifier option of sp_dboption, or the user options option of sp_configure. When SET ANSI_DEFAULTS is ON, SET QUOTED_IDENTIFIER is enabled. Syntax SET QUOTED_IDENTIFIER { ON | OFF } */ // security - hide paths if (!defined('ADODB_DIR')) die(); class ADODB2_mssqlnative extends ADODB_DataDict { var $databaseType = 'mssqlnative';
< var $dropIndex = 'DROP INDEX %1$s ON %2$s';
> var $dropIndex = /** @lang text */ 'DROP INDEX %1$s ON %2$s';
var $renameTable = "EXEC sp_rename '%s','%s'"; var $renameColumn = "EXEC sp_rename '%s.%s','%s'"; var $typeX = 'TEXT'; ## Alternatively, set it to VARCHAR(4000) var $typeXL = 'TEXT'; //var $alterCol = ' ALTER COLUMN ';
> public $blobAllowsDefaultValue = true; function MetaType($t,$len=-1,$fieldobj=false) > public $blobAllowsNotNull = true; { >
if (is_object($t)) { $fieldobj = $t; $t = $fieldobj->type;
< $len = $fieldobj->max_length;
}
> $_typeConversion = array( > $t = strtoupper($t); -155 => 'D', > 93 => 'D', > if (array_key_exists($t,$this->connection->customActualTypes)) -154 => 'D', > return $this->connection->customActualTypes[$t]; -2 => 'D', >
91 => 'D', 12 => 'C', 1 => 'C', -9 => 'C', -8 => 'C', -7 => 'L', -6 => 'I2', -5 => 'I8', -11 => 'I', 4 => 'I', 5 => 'I4', -1 => 'X', -10 => 'X', 2 => 'N', 3 => 'N', 6 => 'N', 7 => 'N', -152 => 'X', -151 => 'X', -4 => 'X', -3 => 'X' );
< return $_typeConversion($t);
> if (isset($_typeConversion[$t])) { > return $_typeConversion[$t]; > }
> return ADODB_DEFAULT_METATYPE;
} function ActualType($meta) { $DATE_TYPE = 'DATETIME';
> $meta = strtoupper($meta); > switch(strtoupper($meta)) { > /* > * Add support for custom meta types. We do this case 'C': return 'VARCHAR'; > * first, that allows us to override existing types case 'XL': return (isset($this)) ? $this->typeXL : 'TEXT'; > */ case 'X': return (isset($this)) ? $this->typeX : 'TEXT'; ## could be varchar(8000), but we want compat with oracle > if (isset($this->connection->customMetaTypes[$meta])) case 'C2': return 'NVARCHAR'; > return $this->connection->customMetaTypes[$meta]['actual'];
case 'X2': return 'NTEXT'; case 'B': return 'IMAGE'; case 'D': return $DATE_TYPE; case 'T': return 'TIME'; case 'L': return 'BIT'; case 'R': case 'I': return 'INT'; case 'I1': return 'TINYINT'; case 'I2': return 'SMALLINT'; case 'I4': return 'INT'; case 'I8': return 'BIGINT'; case 'F': return 'REAL'; case 'N': return 'NUMERIC'; default:
< print "RETURN $meta";
return $meta; } } function AddColumnSQL($tabname, $flds) { $tabname = $this->TableName ($tabname); $f = array();
< list($lines,$pkey) = $this->_GenFields($flds);
> list($lines,) = $this->_GenFields($flds);
$s = "ALTER TABLE $tabname $this->addCol"; foreach($lines as $v) { $f[] = "\n $v"; } $s .= implode(', ',$f); $sql[] = $s; return $sql; }
< function DefaultConstraintname($tabname, $colname)
> /** > * Get a column's default constraint. > * > * @param string $tabname > * @param string $colname > * @return string|null The Constraint's name, or null if there is none. > */ > function defaultConstraintName($tabname, $colname)
{
< $constraintname = false; < $rs = $this->connection->Execute( < "SELECT name FROM sys.default_constraints < WHERE object_name(parent_object_id) = '$tabname' < AND col_name(parent_object_id, parent_column_id) = '$colname'" < ); < if ( is_object($rs) ) { < $row = $rs->FetchRow(); < $constraintname = $row['name']; < } < return $constraintname;
> $sql = "SELECT name FROM sys.default_constraints > WHERE object_name(parent_object_id) = ? > AND col_name(parent_object_id, parent_column_id) = ?"; > return $this->connection->getOne($sql, [$tabname, $colname]);
} function AlterColumnSQL($tabname, $flds, $tableflds='',$tableoptions='') { $tabname = $this->TableName ($tabname); $sql = array();
< list($lines,$pkey,$idxs) = $this->_GenFields($flds);
> list($lines,,$idxs) = $this->_GenFields($flds);
$alter = 'ALTER TABLE ' . $tabname . $this->alterCol . ' '; foreach($lines as $v) {
< $not_null = false;
if ($not_null = preg_match('/NOT NULL/i',$v)) { $v = preg_replace('/NOT NULL/i','',$v); } if (preg_match('/^([^ ]+) .*DEFAULT (\'[^\']+\'|\"[^\"]+\"|[^ ]+)/',$v,$matches)) { list(,$colname,$default) = $matches; $v = preg_replace('/^' . preg_quote($colname) . '\s/', '', $v); $t = trim(str_replace('DEFAULT '.$default,'',$v));
< if ( $constraintname = $this->DefaultConstraintname($tabname,$colname) ) {
> if ( $constraintname = $this->defaultConstraintName($tabname,$colname) ) {
$sql[] = 'ALTER TABLE '.$tabname.' DROP CONSTRAINT '. $constraintname; } if ($not_null) { $sql[] = $alter . $colname . ' ' . $t . ' NOT NULL'; } else { $sql[] = $alter . $colname . ' ' . $t ; } $sql[] = 'ALTER TABLE ' . $tabname . ' ADD CONSTRAINT DF__' . $tabname . '__' . $colname . '__' . dechex(rand()) . ' DEFAULT ' . $default . ' FOR ' . $colname; } else { $colname = strtok($v," ");
< if ( $constraintname = $this->DefaultConstraintname($tabname,$colname) ) {
> if ( $constraintname = $this->defaultConstraintName($tabname,$colname) ) {
$sql[] = 'ALTER TABLE '.$tabname.' DROP CONSTRAINT '. $constraintname; } if ($not_null) { $sql[] = $alter . $v . ' NOT NULL'; } else { $sql[] = $alter . $v; } } } if (is_array($idxs)) { foreach($idxs as $idx => $idxdef) { $sql_idxs = $this->CreateIndexSql($idx, $tabname, $idxdef['cols'], $idxdef['opts']); $sql = array_merge($sql, $sql_idxs); } } return $sql; } /** * Drop a column, syntax is ALTER TABLE table DROP COLUMN column,column * * @param string $tabname Table Name * @param string[] $flds One, or an array of Fields To Drop * @param string $tableflds Throwaway value to make the function match the parent * @param string $tableoptions Throway value to make the function match the parent *
< * @return string The SQL necessary to drop the column
> * @return string[] The SQL necessary to drop the column
*/ function DropColumnSQL($tabname, $flds, $tableflds='',$tableoptions='') { $tabname = $this->TableName ($tabname);
< if (!is_array($flds))
> if (!is_array($flds)) { > /** @noinspection PhpParamsInspection */
$flds = explode(',',$flds);
> }
$f = array(); $s = 'ALTER TABLE ' . $tabname; foreach($flds as $v) {
< if ( $constraintname = $this->DefaultConstraintname($tabname,$v) ) {
> if ( $constraintname = $this->defaultConstraintName($tabname,$v) ) {
$sql[] = 'ALTER TABLE ' . $tabname . ' DROP CONSTRAINT ' . $constraintname; } $f[] = ' DROP COLUMN ' . $this->NameQuote($v); } $s .= implode(', ',$f); $sql[] = $s; return $sql; } // return string must begin with space
> function _CreateSuffix($fname,&$ftype,$fnotnull,$fdefault,$fautoinc,$fconstraint,$funsigned) > /** @noinspection DuplicatedCode */
{ $suffix = ''; if (strlen($fdefault)) $suffix .= " DEFAULT $fdefault"; if ($fautoinc) $suffix .= ' IDENTITY(1,1)'; if ($fnotnull) $suffix .= ' NOT NULL'; else if ($suffix == '') $suffix .= ' NULL'; if ($fconstraint) $suffix .= ' '.$fconstraint; return $suffix; }
< /* < CREATE TABLE < [ database_name.[ owner ] . | owner. ] table_name < ( { < column_definition > < | column_name AS computed_column_expression < | < table_constraint > ::= [ CONSTRAINT constraint_name ] } < < | [ { PRIMARY KEY | UNIQUE } [ ,...n ] < ) < < [ ON { filegroup | DEFAULT } ] < [ TEXTIMAGE_ON { filegroup | DEFAULT } ] < < < column_definition > ::= { column_name data_type } < [ COLLATE < collation_name > ] < [ [ DEFAULT constant_expression ] < | [ IDENTITY [ ( seed , increment ) [ NOT FOR REPLICATION ] ] ] < ] < [ ROWGUIDCOL] < [ < column_constraint > ] [ ...n ] < < < column_constraint > ::= [ CONSTRAINT constraint_name ] < { [ NULL | NOT NULL ] < | [ { PRIMARY KEY | UNIQUE } < [ CLUSTERED | NONCLUSTERED ] < [ WITH FILLFACTOR = fillfactor ] < [ON {filegroup | DEFAULT} ] ] < ] < | [ [ FOREIGN KEY ] < REFERENCES ref_table [ ( ref_column ) ] < [ ON DELETE { CASCADE | NO ACTION } ] < [ ON UPDATE { CASCADE | NO ACTION } ] < [ NOT FOR REPLICATION ] < ] < | CHECK [ NOT FOR REPLICATION ] < ( logical_expression ) < } < < < table_constraint > ::= [ CONSTRAINT constraint_name ] < { [ { PRIMARY KEY | UNIQUE } < [ CLUSTERED | NONCLUSTERED ] < { ( column [ ASC | DESC ] [ ,...n ] ) } < [ WITH FILLFACTOR = fillfactor ] < [ ON { filegroup | DEFAULT } ] < ] < | FOREIGN KEY < [ ( column [ ,...n ] ) ] < REFERENCES ref_table [ ( ref_column [ ,...n ] ) ] < [ ON DELETE { CASCADE | NO ACTION } ] < [ ON UPDATE { CASCADE | NO ACTION } ] < [ NOT FOR REPLICATION ] < | CHECK [ NOT FOR REPLICATION ] < ( search_conditions ) < } < < < */ < < /* < CREATE [ UNIQUE ] [ CLUSTERED | NONCLUSTERED ] INDEX index_name < ON { table | view } ( column [ ASC | DESC ] [ ,...n ] ) < [ WITH < index_option > [ ,...n] ] < [ ON filegroup ] < < index_option > :: = < { PAD_INDEX | < FILLFACTOR = fillfactor | < IGNORE_DUP_KEY | < DROP_EXISTING | < STATISTICS_NORECOMPUTE | < SORT_IN_TEMPDB < } < */
> /** @noinspection DuplicatedCode */
function _IndexSQL($idxname, $tabname, $flds, $idxoptions) { $sql = array(); if ( isset($idxoptions['REPLACE']) || isset($idxoptions['DROP']) ) { $sql[] = sprintf ($this->dropIndex, $idxname, $tabname); if ( isset($idxoptions['DROP']) ) return $sql; } if ( empty ($flds) ) { return $sql; } $unique = isset($idxoptions['UNIQUE']) ? ' UNIQUE' : ''; $clustered = isset($idxoptions['CLUSTERED']) ? ' CLUSTERED' : ''; if ( is_array($flds) ) $flds = implode(', ',$flds); $s = 'CREATE' . $unique . $clustered . ' INDEX ' . $idxname . ' ON ' . $tabname . ' (' . $flds . ')'; if ( isset($idxoptions[$this->upperName]) ) $s .= $idxoptions[$this->upperName]; $sql[] = $s; return $sql; }
< function _GetSize($ftype, $ty, $fsize, $fprec)
> function _GetSize($ftype, $ty, $fsize, $fprec, $options=false)
{ switch ($ftype) { case 'INT': case 'SMALLINT': case 'TINYINT': case 'BIGINT': return $ftype; }
< if ($ty == 'T') return $ftype; < return parent::_GetSize($ftype, $ty, $fsize, $fprec); <
> if ($ty == 'T') { > return $ftype; > } > return parent::_GetSize($ftype, $ty, $fsize, $fprec, $options);
} }