Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 3.9.x will end* 10 May 2021 (12 months).
  • Bug fixes for security issues in 3.9.x will end* 8 May 2023 (36 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
// 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/>.

< /** < * DML Table tests. < * < * @package core_dml < * @category phpunit < * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> < * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later < */ < < defined('MOODLE_INTERNAL') || die();
> namespace core;
< use \core\dml\table;
> use core\dml\table; > use xmldb_table;
/** * DML Table tests. *
> * @package core * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> > * @category test
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later * @coversDefaultClass \core\dml\table */
< class core_dml_table_testcase extends database_driver_testcase {
> class dml_table_test extends \database_driver_testcase {
/** * Data provider for various \core\dml\table method tests. * * @return array */ public function get_field_select_provider() : array { return [ 'single field' => [ 'tablename' => 'test_table_single', 'fieldlist' => [ 'id' => ['id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, XMLDB_SEQUENCE, null], ], 'primarykey' => 'id', 'fieldprefix' => 'ban', 'tablealias' => 'banana', 'banana.id AS banid', ], 'multiple fields' => [ 'tablename' => 'test_table_multiple', 'fieldlist' => [ 'id' => ['id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, XMLDB_SEQUENCE, null], 'course' => ['course', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, '0'], 'name' => ['name', XMLDB_TYPE_CHAR, '255', null, null, null, 'lala'], ], 'primarykey' => 'id', 'fieldprefix' => 'ban', 'tablealias' => 'banana', 'banana.id AS banid, banana.course AS bancourse, banana.name AS banname', ], ]; } /** * Ensure that \core\dml\table::get_field_select() works as expected. * * @dataProvider get_field_select_provider * @covers ::get_field_select * @param string $tablename The name of the table * @param array $fieldlist The list of fields * @param string $primarykey The name of the primary key * @param string $fieldprefix The prefix to use for each field * @param string $tablealias The table AS alias name * @param string $expected The expected SQL */ public function test_get_field_select( string $tablename, array $fieldlist, string $primarykey, string $fieldprefix, string $tablealias, string $expected ) { $dbman = $this->tdb->get_manager(); $xmldbtable = new xmldb_table($tablename); $xmldbtable->setComment("This is a test'n drop table. You can drop it safely"); foreach ($fieldlist as $args) { call_user_func_array([$xmldbtable, 'add_field'], $args); } $xmldbtable->add_key('primary', XMLDB_KEY_PRIMARY, [$primarykey]); $dbman->create_table($xmldbtable); $table = new table($tablename, $tablealias, $fieldprefix); $this->assertEquals($expected, $table->get_field_select()); } /** * Data provider for \core\dml\table::extract_from_result() tests. * * @return array */ public function extract_from_result_provider() : array { return [ 'single table' => [ 'fieldlist' => [ 'id' => ['id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, XMLDB_SEQUENCE, null], 'course' => ['course', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, '0'], 'flag' => ['flag', XMLDB_TYPE_CHAR, '255', null, null, null, 'lala'], ], 'primarykey' => 'id', 'prefix' => 's', 'result' => (object) [ 'sid' => 1, 'scourse' => 42, 'sflag' => 'foo', ], 'expectedrecord' => (object) [ 'id' => 1, 'course' => 42, 'flag' => 'foo', ], ], 'single table amongst others' => [ 'fieldlist' => [ 'id' => ['id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, XMLDB_SEQUENCE, null], 'course' => ['course', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, '0'], 'flag' => ['flag', XMLDB_TYPE_CHAR, '255', null, null, null, 'lala'], ], 'primarykey' => 'id', 'prefix' => 's', 'result' => (object) [ 'sid' => 1, 'scourse' => 42, 'sflag' => 'foo', 'oid' => 'id', 'ocourse' => 'course', 'oflag' => 'flag', ], 'expectedrecord' => (object) [ 'id' => 1, 'course' => 42, 'flag' => 'foo', ], ], ]; } /** * Ensure that \core\dml\table::extract_from_result() works as expected. * * @dataProvider extract_from_result_provider * @covers ::extract_from_result * @param array $fieldlist The list of fields * @param string $primarykey The name of the primary key * @param string $fieldprefix The prefix to use for each field
< * @param stdClass $result The result of the get_records_sql < * @param stdClass $expected The expected output
> * @param \stdClass $result The result of the get_records_sql > * @param \stdClass $expected The expected output
*/ public function test_extract_fields_from_result( array $fieldlist, string $primarykey, string $fieldprefix,
< stdClass $result, < stdClass $expected
> \stdClass $result, > \stdClass $expected
) { $dbman = $this->tdb->get_manager(); $tablename = 'test_table_extraction'; $xmldbtable = new xmldb_table($tablename); $xmldbtable->setComment("This is a test'n drop table. You can drop it safely"); foreach ($fieldlist as $args) { call_user_func_array([$xmldbtable, 'add_field'], $args); } $xmldbtable->add_key('primary', XMLDB_KEY_PRIMARY, [$primarykey]); $dbman->create_table($xmldbtable); $table = new table($tablename, 'footable', $fieldprefix); $this->assertEquals($expected, $table->extract_from_result($result)); } /** * Ensure that \core\dml\table::get_from_sql() works as expected. * * @dataProvider get_field_select_provider * @covers ::get_from_sql * @param string $tablename The name of the table * @param array $fieldlist The list of fields * @param string $primarykey The name of the primary key * @param string $fieldprefix The prefix to use for each field * @param string $tablealias The table AS alias name * @param string $expected The expected SQL */ public function test_get_from_sql( string $tablename, array $fieldlist, string $primarykey, string $fieldprefix, string $tablealias, string $expected ) { $dbman = $this->tdb->get_manager(); $tablename = 'test_table_extraction'; $xmldbtable = new xmldb_table($tablename); $xmldbtable->setComment("This is a test'n drop table. You can drop it safely"); foreach ($fieldlist as $args) { call_user_func_array([$xmldbtable, 'add_field'], $args); } $xmldbtable->add_key('primary', XMLDB_KEY_PRIMARY, [$primarykey]); $dbman->create_table($xmldbtable); $table = new table($tablename, $tablealias, $fieldprefix); $this->assertEquals("{{$tablename}} {$tablealias}", $table->get_from_sql()); } }