Paul Holden
398 lines
11 KiB
PHP
398 lines
11 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/>.
|
|
|
|
/**
|
|
* Abstract database driver test class providing some moodle database interface
|
|
*
|
|
* @package core
|
|
* @category dml
|
|
* @copyright 2018 Srdjan Janković, Catalyst IT
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
require_once(__DIR__.'/../../moodle_database.php');
|
|
require_once(__DIR__.'/../../moodle_temptables.php');
|
|
require_once(__DIR__.'/../../../ddl/database_manager.php');
|
|
require_once(__DIR__.'/test_sql_generator.php');
|
|
|
|
/**
|
|
* Abstract database driver test class
|
|
*
|
|
* @package core
|
|
* @category dml
|
|
* @copyright 2018 Catalyst IT
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
abstract class test_moodle_database extends moodle_database {
|
|
|
|
/** @var string */
|
|
private $error;
|
|
|
|
/** @var array */
|
|
private $_tables = [];
|
|
|
|
/**
|
|
* Constructor - Instantiates the database
|
|
* @param bool $external True means that an external database is used.
|
|
*/
|
|
public function __construct($external = false) {
|
|
parent::__construct($external);
|
|
|
|
$this->temptables = new moodle_temptables($this);
|
|
}
|
|
|
|
/**
|
|
* Default implementation
|
|
* @return boolean true
|
|
*/
|
|
public function driver_installed() {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Default implementation
|
|
* @return string 'test'
|
|
*/
|
|
public function get_dbfamily() {
|
|
return 'test';
|
|
}
|
|
|
|
/**
|
|
* Default implementation
|
|
* @return string 'test'
|
|
*/
|
|
protected function get_dbtype() {
|
|
return 'test';
|
|
}
|
|
|
|
/**
|
|
* Default implementation
|
|
* @return string 'test'
|
|
*/
|
|
protected function get_dblibrary() {
|
|
return 'test';
|
|
}
|
|
|
|
/**
|
|
* Default implementation
|
|
* @return string 'test'
|
|
*/
|
|
public function get_name() {
|
|
return 'test';
|
|
}
|
|
|
|
/**
|
|
* Default implementation
|
|
* @return string
|
|
*/
|
|
public function get_configuration_help() {
|
|
return 'test database driver';
|
|
}
|
|
|
|
/**
|
|
* Default implementation
|
|
* @return array
|
|
*/
|
|
public function get_server_info() {
|
|
return ['description' => $this->name(), 'version' => '0'];
|
|
}
|
|
|
|
/**
|
|
* Default implementation
|
|
* @return int 0
|
|
*/
|
|
protected function allowed_param_types() {
|
|
return 0;
|
|
}
|
|
|
|
/**
|
|
* Returns error property
|
|
* @return string $error
|
|
*/
|
|
public function get_last_error() {
|
|
return $this->error;
|
|
}
|
|
|
|
/**
|
|
* Sets tables property
|
|
* @param array $tables
|
|
* @return void
|
|
*/
|
|
public function set_tables($tables) {
|
|
$this->_tables = $tables;
|
|
}
|
|
|
|
/**
|
|
* Returns keys of tables property
|
|
* @param bool $usecache
|
|
* @return array $tablenames
|
|
*/
|
|
public function get_tables($usecache = true) {
|
|
return array_keys($this->_tables);
|
|
}
|
|
|
|
/**
|
|
* Return table indexes
|
|
* @param string $table
|
|
* @return array $indexes
|
|
*/
|
|
public function get_indexes($table) {
|
|
return isset($this->_tables[$table]['indexes']) ? $this->_tables[$table]['indexes'] : [];
|
|
}
|
|
|
|
/**
|
|
* Return table columns
|
|
* @param string $table
|
|
* @return array database_column_info[] of database_column_info objects indexed with column names
|
|
*/
|
|
public function fetch_columns($table) : array {
|
|
return $this->_tables[$table]['columns'];
|
|
}
|
|
|
|
/**
|
|
* Default implementation
|
|
* @param StdClass $column metadata
|
|
* @param mixed $value
|
|
* @return mixed $value
|
|
*/
|
|
protected function normalise_value($column, $value) {
|
|
return $value;
|
|
}
|
|
|
|
/**
|
|
* Default implementation
|
|
* @param string|array $sql
|
|
* @param array|null $tablenames
|
|
* @return bool true
|
|
*/
|
|
public function change_database_structure($sql, $tablenames = null) {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Default implementation, throws Exception
|
|
* @param string $sql
|
|
* @param array $params
|
|
* @return bool true
|
|
* @throws Exception
|
|
*/
|
|
public function execute($sql, array $params = null) {
|
|
throw new Exception("execute() not implemented");
|
|
}
|
|
|
|
/**
|
|
* Default implementation, throws Exception
|
|
* @param string $sql
|
|
* @param array $params
|
|
* @param int $limitfrom
|
|
* @param int $limitnum
|
|
* @return bool true
|
|
* @throws Exception
|
|
*/
|
|
public function get_recordset_sql($sql, array $params = null, $limitfrom = 0, $limitnum = 0) {
|
|
throw new Exception("get_recordset_sql() not implemented");
|
|
}
|
|
|
|
/**
|
|
* Default implementation, throws Exception
|
|
* @param string $sql
|
|
* @param array $params
|
|
* @param int $limitfrom
|
|
* @param int $limitnum
|
|
* @return bool true
|
|
* @throws Exception
|
|
*/
|
|
public function get_records_sql($sql, array $params = null, $limitfrom = 0, $limitnum = 0) {
|
|
throw new Exception("get_records_sql() not implemented");
|
|
}
|
|
|
|
/**
|
|
* Default implementation, throws Exception
|
|
* @param string $sql
|
|
* @param array $params
|
|
* @return bool true
|
|
* @throws Exception
|
|
*/
|
|
public function get_fieldset_sql($sql, array $params = null) {
|
|
throw new Exception("get_fieldset_sql() not implemented");
|
|
}
|
|
|
|
/**
|
|
* Default implementation, throws Exception
|
|
* @param string $table
|
|
* @param array $params
|
|
* @param bool $returnid
|
|
* @param bool $bulk
|
|
* @param bool $customsequence
|
|
* @return bool|int true or new id
|
|
* @throws Exception
|
|
*/
|
|
public function insert_record_raw($table, $params, $returnid = true, $bulk = false, $customsequence = false) {
|
|
throw new Exception("insert_record_raw() not implemented");
|
|
}
|
|
|
|
/**
|
|
* Default implementation, throws Exception
|
|
* @param string $table
|
|
* @param object|array $dataobject
|
|
* @param bool $returnid
|
|
* @param bool $bulk
|
|
* @return bool|int true or new id
|
|
* @throws Exception
|
|
*/
|
|
public function insert_record($table, $dataobject, $returnid = true, $bulk = false) {
|
|
return $this->insert_record_raw($table, (array)$dataobject, $returnid, $bulk);
|
|
}
|
|
|
|
/**
|
|
* Default implementation, throws Exception
|
|
* @param string $table
|
|
* @param StdObject $dataobject
|
|
* @return bool true
|
|
* @throws Exception
|
|
*/
|
|
public function import_record($table, $dataobject) {
|
|
throw new Exception("import_record() not implemented");
|
|
}
|
|
|
|
/**
|
|
* Default implementation, throws Exception
|
|
* @param string $table
|
|
* @param array $params
|
|
* @param bool $bulk
|
|
* @return bool true
|
|
* @throws Exception
|
|
*/
|
|
public function update_record_raw($table, $params, $bulk = false) {
|
|
throw new Exception("update_record_raw() not implemented");
|
|
}
|
|
|
|
/**
|
|
* Default implementation, throws Exception
|
|
* @param string $table
|
|
* @param StdObject $dataobject
|
|
* @param bool $bulk
|
|
* @return bool true
|
|
* @throws Exception
|
|
*/
|
|
public function update_record($table, $dataobject, $bulk = false) {
|
|
throw new Exception("update_record() not implemented");
|
|
}
|
|
|
|
/**
|
|
* Default implementation, throws Exception
|
|
* @param string $table
|
|
* @param string $newfield
|
|
* @param string $newvalue
|
|
* @param string $select
|
|
* @param array $params
|
|
* @return bool true
|
|
* @throws Exception
|
|
*/
|
|
public function set_field_select($table, $newfield, $newvalue, $select, array $params = null) {
|
|
throw new Exception("set_field_select() not implemented");
|
|
}
|
|
|
|
/**
|
|
* Default implementation, throws Exception
|
|
* @param string $table
|
|
* @param string $select
|
|
* @param array $params
|
|
* @return bool true
|
|
* @throws Exception
|
|
*/
|
|
public function delete_records_select($table, $select, array $params = null) {
|
|
throw new Exception("delete_records_select() not implemented");
|
|
}
|
|
|
|
/**
|
|
* Default implementation, throws Exception
|
|
* @return string $sql
|
|
* @throws Exception
|
|
*/
|
|
public function sql_concat() {
|
|
throw new Exception("sql_concat() not implemented");
|
|
}
|
|
|
|
/**
|
|
* Default implementation, throws Exception
|
|
* @param string $separator
|
|
* @param array $elements
|
|
* @return string $sql
|
|
* @throws Exception
|
|
*/
|
|
public function sql_concat_join($separator = "' '", $elements = []) {
|
|
throw new Exception("sql_concat_join() not implemented");
|
|
}
|
|
|
|
/**
|
|
* Default implementation, throws Exception
|
|
*
|
|
* @param string $field
|
|
* @param string $separator
|
|
* @param string $sort
|
|
* @return string
|
|
* @throws Exception
|
|
*/
|
|
public function sql_group_concat(string $field, string $separator = ', ', string $sort = ''): string {
|
|
throw new Exception('sql_group_concat() not implemented');
|
|
}
|
|
|
|
/**
|
|
* Default implementation, throws Exception
|
|
* @return void
|
|
* @throws Exception
|
|
*/
|
|
protected function begin_transaction() {
|
|
throw new Exception("begin_transaction() not implemented");
|
|
}
|
|
|
|
/**
|
|
* Default implementation, throws Exception
|
|
* @return void
|
|
* @throws Exception
|
|
*/
|
|
protected function commit_transaction() {
|
|
throw new Exception("commit_transaction() not implemented");
|
|
}
|
|
|
|
/**
|
|
* Default implementation, throws Exception
|
|
* @return void
|
|
* @throws Exception
|
|
*/
|
|
protected function rollback_transaction() {
|
|
throw new Exception("rollback_transaction() not implemented");
|
|
}
|
|
|
|
/**
|
|
* Returns the database manager used for db manipulation.
|
|
* Used mostly in upgrade.php scripts.
|
|
* @return database_manager The instance used to perform ddl operations.
|
|
* @see lib/ddl/database_manager.php
|
|
*/
|
|
public function get_manager() {
|
|
if (!$this->database_manager) {
|
|
$generator = new test_sql_generator($this, $this->temptables);
|
|
|
|
$this->database_manager = new database_manager($this, $generator);
|
|
}
|
|
return $this->database_manager;
|
|
}
|
|
}
|