mirror of
https://github.com/moodle/moodle.git
synced 2025-01-19 06:18:28 +01:00
156 lines
3.6 KiB
PHP
156 lines
3.6 KiB
PHP
<?php
|
|
|
|
// This file is part of Moodle - http://moodle.org/
|
|
//
|
|
// Moodle is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// Moodle is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
|
|
/**
|
|
* Database column information.
|
|
*
|
|
* @package core
|
|
* @subpackage dml
|
|
* @copyright 2008 Petr Skoda (http://skodak.org)
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
/**
|
|
* Detail database field information.
|
|
* Based on ADOFieldObject.
|
|
*/
|
|
class database_column_info {
|
|
/**
|
|
* Name of column - lowercase
|
|
*/
|
|
public $name;
|
|
|
|
/**
|
|
* Driver dependent native data type
|
|
* Not standardised - used to find meta_type
|
|
*/
|
|
public $type;
|
|
|
|
/**
|
|
* Max length:
|
|
* character type - number of characters
|
|
* blob - number of bytes
|
|
* integer - number of digits
|
|
* float - digits left from floating point
|
|
* boolean - 1
|
|
* enums - null
|
|
*/
|
|
public $max_length;
|
|
|
|
/**
|
|
* Scale
|
|
* float - decimal points
|
|
* other - null
|
|
*/
|
|
public $scale;
|
|
|
|
/**
|
|
* Enumerated field options,
|
|
* null if not enum type
|
|
*
|
|
* For performance reasons this field is optional!
|
|
* You can use DDL sql_generator::getCheckConstraintsFromDB() if needed.
|
|
*/
|
|
public $enums;
|
|
|
|
/**
|
|
* True if not null, false otherwise
|
|
*/
|
|
public $not_null;
|
|
|
|
/**
|
|
* True if column is primary key.
|
|
* (usually 'id').
|
|
*/
|
|
public $primary_key;
|
|
|
|
/**
|
|
* True if filed autoincrementing
|
|
* (usually 'id' only)
|
|
*/
|
|
public $auto_increment;
|
|
|
|
/**
|
|
* True if binary
|
|
*/
|
|
public $binary;
|
|
|
|
/**
|
|
* True if integer unsigned, false if signed.
|
|
* Null for other types
|
|
*/
|
|
public $unsigned;
|
|
|
|
/**
|
|
* True if default value defined
|
|
*/
|
|
public $has_default;
|
|
|
|
/**
|
|
* Default value if defined
|
|
*/
|
|
public $default_value;
|
|
|
|
/**
|
|
* True if field values unique, false if not
|
|
*/
|
|
public $unique;
|
|
|
|
/**
|
|
* Standardised one character column type, uppercase
|
|
* R - counter (integer primary key)
|
|
* I - integers
|
|
* N - numbers (floats)
|
|
* C - characters and strings
|
|
* X - texts
|
|
* B - binary blobs
|
|
* L - boolean (1 bit)
|
|
* T - timestamp - unsupported
|
|
* D - date - unsupported
|
|
*/
|
|
public $meta_type;
|
|
|
|
/**
|
|
* Constructor
|
|
* @param $data mixed object or array with properties
|
|
*/
|
|
public function __construct($data) {
|
|
foreach ($data as $key=>$value) {
|
|
if (property_exists($this, $key)) {
|
|
$this->$key = $value;
|
|
}
|
|
}
|
|
|
|
switch ($this->meta_type) {
|
|
case 'R': // normalise counters (usually 'id')
|
|
$this->auto_increment = true;
|
|
$this->binary = false;
|
|
$this->has_default = false;
|
|
$this->default_value = null;
|
|
$this->unique = true;
|
|
break;
|
|
case 'C':
|
|
$this->auto_increment = false;
|
|
$this->binary = false;
|
|
break;
|
|
}
|
|
}
|
|
}
|