Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.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 Moodle 2 format backup operation. < * < * @package core_backup < * @copyright 2014 Russell Smith < * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later < */
> namespace core_backup; > > use backup; > use backup_controller; > use restore_dbops; > use restore_controller;
defined('MOODLE_INTERNAL') || die(); global $CFG; require_once($CFG->dirroot . '/backup/util/includes/backup_includes.php'); require_once($CFG->dirroot . '/backup/util/includes/restore_includes.php'); require_once($CFG->dirroot . '/course/format/topics/lib.php'); require_once($CFG->libdir . '/completionlib.php');
> require_once($CFG->dirroot . '/backup/moodle2/tests/fixtures/format_test_cs_options.php');
/** * Tests for Moodle 2 course format section_options backup operation. * * @package core_backup * @copyright 2014 Russell Smith * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */
< class core_backup_moodle2_course_format_testcase extends advanced_testcase {
> class moodle2_course_format_test extends \advanced_testcase {
/** * Tests a backup and restore adds the required section option data * when the same course format is used. */ public function test_course_format_options_restore() { global $DB, $CFG; $this->resetAfterTest(true); $this->setAdminUser(); $CFG->enableavailability = true; $CFG->enablecompletion = true; // Create a course with some availability data set. $generator = $this->getDataGenerator(); $course = $generator->create_course( array('format' => 'test_cs_options', 'numsections' => 3, 'enablecompletion' => COMPLETION_ENABLED), array('createsections' => true));
< $courseobject = format_base::instance($course->id);
> $courseobject = \core_courseformat\base::instance($course->id);
$section = $DB->get_record('course_sections', array('course' => $course->id, 'section' => 1), '*', MUST_EXIST); $data = array('id' => $section->id, 'numdaystocomplete' => 2); $courseobject->update_section_format_options($data); // Backup and restore it. $this->backup_and_restore($course); $sectionoptions = $courseobject->get_format_options(1); $this->assertArrayHasKey('numdaystocomplete', $sectionoptions); $this->assertEquals(2, $sectionoptions['numdaystocomplete']); } /** * Tests an import into the same subject successfully * restores the options without error. */ public function test_course_format_options_import_myself() { global $DB, $CFG; $this->resetAfterTest(true); $this->setAdminUser(); $CFG->enableavailability = true; $CFG->enablecompletion = true; // Create a course with some availability data set. $generator = $this->getDataGenerator(); $course = $generator->create_course( array('format' => 'test_cs_options', 'numsections' => 3, 'enablecompletion' => COMPLETION_ENABLED), array('createsections' => true));
< $courseobject = format_base::instance($course->id);
> $courseobject = \core_courseformat\base::instance($course->id);
$section = $DB->get_record('course_sections', array('course' => $course->id, 'section' => 1), '*', MUST_EXIST); $data = array('id' => $section->id, 'numdaystocomplete' => 2); $courseobject->update_section_format_options($data); $this->backup_and_restore($course, $course, backup::TARGET_EXISTING_ADDING); $sectionoptions = $courseobject->get_format_options(1); $this->assertArrayHasKey('numdaystocomplete', $sectionoptions); $this->assertArrayNotHasKey('secondparameter', $sectionoptions); $this->assertEquals(2, $sectionoptions['numdaystocomplete']); } /** * Tests that all section options are copied when the course format is changed. * None of the data is copied. * * It is a future enhancement to copy; * 1. Only the relevant options. * 2. Only the data associated with relevant options. */ public function test_course_format_options_restore_new_format() { global $DB, $CFG; $this->resetAfterTest(true); $this->setAdminUser(); // Create a source course using the test_cs2_options format. $generator = $this->getDataGenerator(); $course = $generator->create_course( array('format' => 'test_cs2_options', 'numsections' => 3, 'enablecompletion' => COMPLETION_ENABLED), array('createsections' => true)); // Create a target course using test_cs_options format. $newcourse = $generator->create_course( array('format' => 'test_cs_options', 'numsections' => 3, 'enablecompletion' => COMPLETION_ENABLED), array('createsections' => true)); // Set section 2 to have both options, and a name.
< $courseobject = format_base::instance($course->id);
> $courseobject = \core_courseformat\base::instance($course->id);
$section = $DB->get_record('course_sections', array('course' => $course->id, 'section' => 2), '*', MUST_EXIST); $data = array('id' => $section->id, 'numdaystocomplete' => 2, 'secondparameter' => 8 ); $courseobject->update_section_format_options($data); $DB->set_field('course_sections', 'name', 'Frogs', array('id' => $section->id)); // Backup and restore to the new course using 'add to existing' so it // keeps the current (test_cs_options) format. $this->backup_and_restore($course, $newcourse, backup::TARGET_EXISTING_ADDING); // Check that the section contains the options suitable for the new // format and that even the one with the same name as from the old format // has NOT been set.
< $newcourseobject = format_base::instance($newcourse->id);
> $newcourseobject = \core_courseformat\base::instance($newcourse->id);
$sectionoptions = $newcourseobject->get_format_options(2); $this->assertArrayHasKey('numdaystocomplete', $sectionoptions); $this->assertArrayNotHasKey('secondparameter', $sectionoptions); $this->assertEquals(0, $sectionoptions['numdaystocomplete']); // However, the name should have been changed, as this does not depend // on the format. $modinfo = get_fast_modinfo($newcourse->id); $section = $modinfo->get_section_info(2); $this->assertEquals('Frogs', $section->name); } /** * Backs a course up and restores it. *
< * @param stdClass $srccourse Course object to backup < * @param stdClass $dstcourse Course object to restore into
> * @param \stdClass $srccourse Course object to backup > * @param \stdClass $dstcourse Course object to restore into
* @param int $target Target course mode (backup::TARGET_xx) * @return int ID of newly restored course */ protected function backup_and_restore($srccourse, $dstcourse = null, $target = backup::TARGET_NEW_COURSE) { global $USER, $CFG; // Turn off file logging, otherwise it can't delete the file (Windows). $CFG->backup_file_logger_level = backup::LOG_NONE; // Do backup with default settings. MODE_IMPORT means it will just // create the directory and not zip it. $bc = new backup_controller(backup::TYPE_1COURSE, $srccourse->id, backup::FORMAT_MOODLE, backup::INTERACTIVE_NO, backup::MODE_IMPORT, $USER->id); $backupid = $bc->get_backupid(); $bc->execute_plan(); $bc->destroy(); // Do restore to new course with default settings. if ($dstcourse !== null) { $newcourseid = $dstcourse->id; } else { $newcourseid = restore_dbops::create_new_course( $srccourse->fullname, $srccourse->shortname . '_2', $srccourse->category); } $rc = new restore_controller($backupid, $newcourseid, backup::INTERACTIVE_NO, backup::MODE_GENERAL, $USER->id, $target); $this->assertTrue($rc->execute_precheck()); $rc->execute_plan(); $rc->destroy(); return $newcourseid;
< } < } < < /** < * Class format_test_cs_options < * < * Test course format that has 1 option. < */ < class format_test_cs_options extends format_topics { < /** < * Override method format_topics::get_default_section_name to prevent PHPUnit errors related to the nonexistent < * format_test_cs_options lang file. < * < * @param stdClass $section The section in question. < * @return string The section's name for display. < */ < public function get_default_section_name($section) { < if ($section->section == 0) { < return parent::get_default_section_name($section); < } else { < return get_string('sectionname', 'format_topics') . ' ' . $section->section; < } < } < < public function section_format_options($foreditform = false) { < return array( < 'numdaystocomplete' => array( < 'type' => PARAM_INT, < 'label' => 'Test days', < 'element_type' => 'text', < 'default' => 0, < ), < ); < } < } < < /** < * Class format_test_cs2_options < * < * Test course format that has 2 options, 1 inherited. < */ < class format_test_cs2_options extends format_test_cs_options { < public function section_format_options($foreditform = false) { < return array( < 'numdaystocomplete' => array( < 'type' => PARAM_INT, < 'label' => 'Test days', < 'element_type' => 'text', < 'default' => 0, < ), < 'secondparameter' => array( < 'type' => PARAM_INT, < 'label' => 'Test Parmater', < 'element_type' => 'text', < 'default' => 0, < ), < ) + parent::section_format_options($foreditform);
} }