moodle/lib/ddllib.php
2009-04-08 11:46:39 +00:00

106 lines
4.3 KiB
PHP

<?php // $Id$
///////////////////////////////////////////////////////////////////////////
// //
// NOTICE OF COPYRIGHT //
// //
// Moodle - Modular Object-Oriented Dynamic Learning Environment //
// http://moodle.com //
// //
// Copyright (C) 1999 onwards Martin Dougiamas http://dougiamas.com //
// (C) 2001-3001 Eloy Lafuente (stronk7) http://contiento.com //
// //
// This program 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 2 of the License, or //
// (at your option) any later version. //
// //
// This program 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: //
// //
// http://www.gnu.org/copyleft/gpl.html //
// //
///////////////////////////////////////////////////////////////////////////
// This library includes all the required functions used to handle the DB
// structure (DDL) independently of the underlying RDBMS in use. All the functions
// rely on the XMLDBDriver classes to be able to generate the correct SQL
// syntax needed by each DB.
//
// To define any structure to be created we'll use the schema defined
// by the XMLDB classes, for tables, fields, indexes, keys and other
// statements instead of direct handling of SQL sentences.
//
// This library should be used, exclusively, by the installation and
// upgrade process of Moodle.
//
// For further documentation, visit http://docs.moodle.org/en/DDL_functions
/// Add required library.
require_once($CFG->libdir.'/xmlize.php');
/// Add required XMLDB constants
require_once($CFG->libdir.'/xmldb/xmldb_constants.php');
/// Add required XMLDB DB classes
require_once($CFG->libdir.'/xmldb/xmldb_object.php');
require_once($CFG->libdir.'/xmldb/xmldb_file.php');
require_once($CFG->libdir.'/xmldb/xmldb_structure.php');
require_once($CFG->libdir.'/xmldb/xmldb_table.php');
require_once($CFG->libdir.'/xmldb/xmldb_field.php');
require_once($CFG->libdir.'/xmldb/xmldb_key.php');
require_once($CFG->libdir.'/xmldb/xmldb_index.php');
require_once($CFG->libdir.'/xmldb/xmldb_statement.php');
require_once($CFG->libdir.'/ddl/sql_generator.php');
require_once($CFG->libdir.'/ddl/database_manager.php');
/**
* DDL exception class, use instead of error() and "return false;" in ddl code.
*/
class ddl_exception extends moodle_exception {
function __construct($errorcode, $a=NULL, $debuginfo=null) {
parent::__construct($errorcode, '', '', $a, $debuginfo);
}
}
/**
* Table does not exist problem exception
*/
class ddl_table_missing_exception extends ddl_exception {
function __construct($tablename, $debuginfo=null) {
parent::__construct('ddltablenotexist', $tablename, $debuginfo);
}
}
/**
* Table does not exist problem exception
*/
class ddl_field_missing_exception extends ddl_exception {
function __construct($fieldname, $tablename, $debuginfo=null) {
$a = new object();
$a->fieldname = $fieldname;
$a->tablename = $tablename;
parent::__construct('ddlfieldnotexist', $a, $debuginfo);
}
}
/**
* Error during changing db structure
*/
class ddl_change_structure_exception extends ddl_exception {
public $error;
public $sql;
function __construct($error, $sql=null) {
$this->error = $error;
$this->sql = $sql;
$errorinfo = s($error).'<br /><br />'.s($sql);
parent::__construct('ddlexecuteerror', NULL, $errorinfo);
}
}