Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
  • Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 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/>.

< /** < * Tests for class customfield_textarea < * < * @package customfield_textarea < * @copyright 2019 Marina Glancy < * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later < */ < < defined('MOODLE_INTERNAL') || die();
> namespace customfield_textarea;
< use customfield_textarea\field_controller; < use customfield_textarea\data_controller;
> use core_customfield_generator; > use core_customfield_test_instance_form;
/** * Functional test for customfield_textarea * * @package customfield_textarea * @copyright 2019 Marina Glancy * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */
< class customfield_textarea_plugin_testcase extends advanced_testcase {
> class plugin_test extends \advanced_testcase {
/** @var stdClass[] */ private $courses = []; /** @var \core_customfield\category_controller */ private $cfcat; /** @var \core_customfield\field_controller[] */ private $cfields; /** @var \core_customfield\data_controller[] */ private $cfdata; /** * Tests set up. */ public function setUp(): void { $this->resetAfterTest(); $this->cfcat = $this->get_generator()->create_category(); $this->cfields[1] = $this->get_generator()->create_field( ['categoryid' => $this->cfcat->get('id'), 'shortname' => 'myfield1', 'type' => 'textarea']); $this->cfields[2] = $this->get_generator()->create_field( ['categoryid' => $this->cfcat->get('id'), 'shortname' => 'myfield2', 'type' => 'textarea', 'configdata' => ['required' => 1]]); $this->cfields[3] = $this->get_generator()->create_field( ['categoryid' => $this->cfcat->get('id'), 'shortname' => 'myfield3', 'type' => 'textarea', 'configdata' => ['defaultvalue' => 'Value3', 'defaultvalueformat' => FORMAT_MOODLE]]); $this->courses[1] = $this->getDataGenerator()->create_course(); $this->courses[2] = $this->getDataGenerator()->create_course(); $this->courses[3] = $this->getDataGenerator()->create_course(); $this->cfdata[1] = $this->get_generator()->add_instance_data($this->cfields[1], $this->courses[1]->id, ['text' => 'Value1', 'format' => FORMAT_MOODLE]); $this->cfdata[2] = $this->get_generator()->add_instance_data($this->cfields[1], $this->courses[2]->id, ['text' => 'Value2', 'format' => FORMAT_MOODLE]); $this->setUser($this->getDataGenerator()->create_user()); } /** * Get generator * @return core_customfield_generator */ protected function get_generator() : core_customfield_generator { return $this->getDataGenerator()->get_plugin_generator('core_customfield'); } /** * Test for initialising field and data controllers */ public function test_initialise() { $f = \core_customfield\field_controller::create($this->cfields[1]->get('id')); $this->assertTrue($f instanceof field_controller); $f = \core_customfield\field_controller::create(0, (object)['type' => 'textarea'], $this->cfcat); $this->assertTrue($f instanceof field_controller); $d = \core_customfield\data_controller::create($this->cfdata[1]->get('id')); $this->assertTrue($d instanceof data_controller); $d = \core_customfield\data_controller::create(0, null, $this->cfields[1]); $this->assertTrue($d instanceof data_controller); } /** * Test for configuration form functions * * Create a configuration form and submit it with the same values as in the field */ public function test_config_form() {
> $this->setAdminUser();
$submitdata = (array)$this->cfields[3]->to_record(); $submitdata['configdata'] = $this->cfields[3]->get('configdata');
< \core_customfield\field_config_form::mock_submit($submitdata, []); < $handler = $this->cfcat->get_handler(); < $form = $handler->get_field_config_form($this->cfields[3]);
> $submitdata = \core_customfield\field_config_form::mock_ajax_submit($submitdata); > $form = new \core_customfield\field_config_form(null, null, 'post', '', null, true, > $submitdata, true); > $form->set_data_for_dynamic_submission();
$this->assertTrue($form->is_validated());
< $data = $form->get_data(); < $handler->save_field_configuration($this->cfields[3], $data);
> $form->process_dynamic_submission();
} /** * Test for instance form functions */ public function test_instance_form() { global $CFG; require_once($CFG->dirroot . '/customfield/tests/fixtures/test_instance_form.php'); $this->setAdminUser(); $handler = $this->cfcat->get_handler(); // First try to submit without required field. $submitdata = (array)$this->courses[1]; core_customfield_test_instance_form::mock_submit($submitdata, []); $form = new core_customfield_test_instance_form('POST', ['handler' => $handler, 'instance' => $this->courses[1]]); $this->assertFalse($form->is_validated()); // Now with required field. $submitdata['customfield_myfield2_editor'] = ['text' => 'Some text', 'format' => FORMAT_HTML]; core_customfield_test_instance_form::mock_submit($submitdata, []); $form = new core_customfield_test_instance_form('POST', ['handler' => $handler, 'instance' => $this->courses[1]]); $this->assertTrue($form->is_validated()); $data = $form->get_data(); $this->assertNotEmpty($data->customfield_myfield1_editor); $this->assertNotEmpty($data->customfield_myfield2_editor); $handler->instance_form_save($data); } /** * Test that instance form save empties the field content for blank values */ public function test_instance_form_save_clear(): void { global $CFG; require_once("{$CFG->dirroot}/customfield/tests/fixtures/test_instance_form.php"); $this->setAdminUser(); $handler = $this->cfcat->get_handler(); // Set our custom field to a known value. $submitdata = (array) $this->courses[1] + [ 'customfield_myfield1_editor' => ['text' => 'I can see it in your eyes', 'format' => FORMAT_HTML], 'customfield_myfield2_editor' => ['text' => 'I can see it in your smile', 'format' => FORMAT_HTML], ]; core_customfield_test_instance_form::mock_submit($submitdata, []); $form = new core_customfield_test_instance_form('post', ['handler' => $handler, 'instance' => $this->courses[1]]); $handler->instance_form_save($form->get_data()); $this->assertEquals($submitdata['customfield_myfield1_editor']['text'],
< core_customfield\data_controller::create($this->cfdata[1]->get('id'))->export_value());
> \core_customfield\data_controller::create($this->cfdata[1]->get('id'))->export_value());
// Now empty our non-required field. $submitdata['customfield_myfield1_editor']['text'] = ''; core_customfield_test_instance_form::mock_submit($submitdata, []); $form = new core_customfield_test_instance_form('post', ['handler' => $handler, 'instance' => $this->courses[1]]); $handler->instance_form_save($form->get_data());
< $this->assertEmpty(core_customfield\data_controller::create($this->cfdata[1]->get('id'))->export_value());
> $this->assertEmpty(\core_customfield\data_controller::create($this->cfdata[1]->get('id'))->export_value());
} /** * Test for data_controller::get_value and export_value */ public function test_get_export_value() { $this->assertEquals('Value1', $this->cfdata[1]->get_value()); $this->assertEquals('<div class="text_to_html">Value1</div>', $this->cfdata[1]->export_value()); // Field without data but with a default value.
< $d = core_customfield\data_controller::create(0, null, $this->cfields[3]);
> $d = \core_customfield\data_controller::create(0, null, $this->cfields[3]);
$this->assertEquals('Value3', $d->get_value()); $this->assertEquals('<div class="text_to_html">Value3</div>', $d->export_value()); } /** * Deleting fields and data */ public function test_delete() { $this->cfcat->get_handler()->delete_all(); } }