Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.11.x will end 14 Nov 2022 (12 months plus 6 months extension).
  • Bug fixes for security issues in 3.11.x will end 13 Nov 2023 (18 months plus 12 months extension).
  • PHP version: minimum PHP 7.3.0 Note: minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is 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/>.

/**
 * Tests for the dataformat plugins
 *
 * @package    core
 * @copyright  2020 Paul Holden <paulh@moodle.com>
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

namespace core;

use context_system;
use core_component;

/**
 * Dataformat tests
 *
 * @package    core
 * @covers     \core\dataformat
 * @copyright  2020 Paul Holden <paulh@moodle.com>
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
< class dataformat_testcase extends \advanced_testcase {
> class dataformat_test extends \advanced_testcase {
/** * Data provider to return array of dataformat types * * @return array */ public function write_data_provider(): array { $data = []; $dataformats = core_component::get_plugin_list('dataformat'); foreach ($dataformats as $dataformat => $unused) { $data[] = [$dataformat]; } return $data; } /** * Test writing dataformat export to local file * * @param string $dataformat * @return void * * @dataProvider write_data_provider */ public function test_write_data(string $dataformat): void { $columns = ['fruit', 'colour', 'animal']; $rows = [ ['banana', 'yellow', 'monkey'], ['apple', 'red', 'wolf'], ['melon', 'green', 'aardvark'], ]; // Export to file. Assert that the exported file exists and is non-zero in size. $exportfile = dataformat::write_data('My export', $dataformat, $columns, $rows); $this->assertFileExists($exportfile); $this->assertGreaterThan(0, filesize($exportfile)); } /** * Test writing dataformat export to filearea * * @param string $dataformat * @return void * * @dataProvider write_data_provider */ public function test_write_data_to_filearea(string $dataformat): void { $this->resetAfterTest(); $columns = ['fruit', 'colour', 'animal']; $rows = [ ['banana', 'yellow', 'monkey'], ['apple', 'red', 'wolf'], ['melon', 'green', 'aardvark'], ]; // Export to filearea. Assert that the the file exists in file storage and matches the original file record. $filerecord = [ 'contextid' => context_system::instance()->id, 'component' => 'core_dataformat', 'filearea' => 'test', 'itemid' => 0, 'filepath' => '/', 'filename' => 'My export', ]; $file = dataformat::write_data_to_filearea($filerecord, $dataformat, $columns, $rows); $this->assertEquals($filerecord['contextid'], $file->get_contextid()); $this->assertEquals($filerecord['component'], $file->get_component()); $this->assertEquals($filerecord['filearea'], $file->get_filearea()); $this->assertEquals($filerecord['itemid'], $file->get_itemid()); $this->assertEquals($filerecord['filepath'], $file->get_filepath()); $this->assertStringStartsWith($filerecord['filename'], $file->get_filename()); $this->assertGreaterThan(0, $file->get_filesize()); } }