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/>.

namespace format_weeks;

> use core_external\external_api; defined('MOODLE_INTERNAL') || die(); >
global $CFG; require_once($CFG->dirroot . '/course/lib.php'); /** * format_weeks related unit tests * * @package format_weeks * @copyright 2015 Marina Glancy * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class format_weeks_test extends \advanced_testcase { /** * Tests for format_weeks::get_section_name method with default section names. */ public function test_get_section_name() { global $DB; $this->resetAfterTest(true); // Generate a course with 5 sections. $generator = $this->getDataGenerator(); $numsections = 5; $course = $generator->create_course(array('numsections' => $numsections, 'format' => 'weeks'), array('createsections' => true)); // Get section names for course. $coursesections = $DB->get_records('course_sections', array('course' => $course->id)); // Test get_section_name with default section names. $courseformat = course_get_format($course); foreach ($coursesections as $section) { // Assert that with unmodified section names, get_section_name returns the same result as get_default_section_name. $this->assertEquals($courseformat->get_default_section_name($section), $courseformat->get_section_name($section)); } } /** * Tests for format_weeks::get_section_name method with modified section names. */ public function test_get_section_name_customised() { global $DB; $this->resetAfterTest(true); // Generate a course with 5 sections. $generator = $this->getDataGenerator(); $numsections = 5; $course = $generator->create_course(array('numsections' => $numsections, 'format' => 'weeks'), array('createsections' => true)); // Get section names for course. $coursesections = $DB->get_records('course_sections', array('course' => $course->id)); // Modify section names. $customname = "Custom Section"; foreach ($coursesections as $section) { $section->name = "$customname $section->section"; $DB->update_record('course_sections', $section); } // Requery updated section names then test get_section_name. $coursesections = $DB->get_records('course_sections', array('course' => $course->id)); $courseformat = course_get_format($course); foreach ($coursesections as $section) { // Assert that with modified section names, get_section_name returns the modified section name. $this->assertEquals($section->name, $courseformat->get_section_name($section)); } } /** * Tests for format_weeks::get_default_section_name. */ public function test_get_default_section_name() { global $DB; $this->resetAfterTest(true); // Generate a course with 5 sections. $generator = $this->getDataGenerator(); $numsections = 5; $course = $generator->create_course(array('numsections' => $numsections, 'format' => 'weeks'), array('createsections' => true)); // Get section names for course. $coursesections = $DB->get_records('course_sections', array('course' => $course->id)); // Test get_default_section_name with default section names. $courseformat = course_get_format($course); foreach ($coursesections as $section) { if ($section->section == 0) { $sectionname = get_string('section0name', 'format_weeks'); $this->assertEquals($sectionname, $courseformat->get_default_section_name($section)); } else { $dates = $courseformat->get_section_dates($section); $dates->end = ($dates->end - 86400); $dateformat = get_string('strftimedateshort'); $weekday = userdate($dates->start, $dateformat); $endweekday = userdate($dates->end, $dateformat); $sectionname = $weekday.' - '.$endweekday; $this->assertEquals($sectionname, $courseformat->get_default_section_name($section)); } } } /** * Test web service updating section name */ public function test_update_inplace_editable() { global $CFG, $DB, $PAGE; require_once($CFG->dirroot . '/lib/external/externallib.php'); $this->resetAfterTest(); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $course = $this->getDataGenerator()->create_course(array('numsections' => 5, 'format' => 'weeks'), array('createsections' => true)); $section = $DB->get_record('course_sections', array('course' => $course->id, 'section' => 2)); // Call webservice without necessary permissions. try { \core_external::update_inplace_editable('format_weeks', 'sectionname', $section->id, 'New section name'); $this->fail('Exception expected'); } catch (\moodle_exception $e) { $this->assertEquals('Course or activity not accessible. (Not enrolled)', $e->getMessage()); } // Change to teacher and make sure that section name can be updated using web service update_inplace_editable(). $teacherrole = $DB->get_record('role', array('shortname' => 'editingteacher')); $this->getDataGenerator()->enrol_user($user->id, $course->id, $teacherrole->id); $res = \core_external::update_inplace_editable('format_weeks', 'sectionname', $section->id, 'New section name');
< $res = \external_api::clean_returnvalue(\core_external::update_inplace_editable_returns(), $res);
> $res = external_api::clean_returnvalue(\core_external::update_inplace_editable_returns(), $res);
$this->assertEquals('New section name', $res['value']); $this->assertEquals('New section name', $DB->get_field('course_sections', 'name', array('id' => $section->id))); } /** * Test callback updating section name */ public function test_inplace_editable() { global $CFG, $DB, $PAGE; $this->resetAfterTest(); $user = $this->getDataGenerator()->create_user(); $course = $this->getDataGenerator()->create_course(array('numsections' => 5, 'format' => 'weeks'), array('createsections' => true)); $teacherrole = $DB->get_record('role', array('shortname' => 'editingteacher')); $this->getDataGenerator()->enrol_user($user->id, $course->id, $teacherrole->id); $this->setUser($user); $section = $DB->get_record('course_sections', array('course' => $course->id, 'section' => 2)); // Call callback format_weeks_inplace_editable() directly. $tmpl = component_callback('format_weeks', 'inplace_editable', array('sectionname', $section->id, 'Rename me again')); $this->assertInstanceOf('core\output\inplace_editable', $tmpl); $res = $tmpl->export_for_template($PAGE->get_renderer('core')); $this->assertEquals('Rename me again', $res['value']); $this->assertEquals('Rename me again', $DB->get_field('course_sections', 'name', array('id' => $section->id))); // Try updating using callback from mismatching course format. try { $tmpl = component_callback('format_topics', 'inplace_editable', array('sectionname', $section->id, 'New name')); $this->fail('Exception expected'); } catch (\moodle_exception $e) { $this->assertEquals(1, preg_match('/^Can\'t find data record in database/', $e->getMessage())); } } /** * Test get_default_course_enddate. * * @return void */ public function test_default_course_enddate() { global $CFG, $DB, $PAGE; $this->resetAfterTest(true); require_once($CFG->dirroot . '/course/tests/fixtures/testable_course_edit_form.php'); $this->setTimezone('UTC'); $params = array('format' => 'weeks', 'numsections' => 5, 'startdate' => 1445644800); $course = $this->getDataGenerator()->create_course($params); $category = $DB->get_record('course_categories', array('id' => $course->category)); $args = [ 'course' => $course, 'category' => $category, 'editoroptions' => [ 'context' => \context_course::instance($course->id), 'subdirs' => 0 ], 'returnto' => new \moodle_url('/'), 'returnurl' => new \moodle_url('/'), ]; $PAGE->set_course($course); $courseform = new \testable_course_edit_form(null, $args); $courseform->definition_after_data();
< // format_weeks::get_section_dates is adding 2h to avoid DST problems, we need to replicate it here. < $enddate = $params['startdate'] + (WEEKSECS * $params['numsections']) + 7200;
> // Calculate the expected end date. > $enddate = $params['startdate'] + (WEEKSECS * $params['numsections']);
$weeksformat = course_get_format($course->id); $this->assertEquals($enddate, $weeksformat->get_default_course_enddate($courseform->get_quick_form())); } /** * Test for get_view_url() to ensure that the url is only given for the correct cases */ public function test_get_view_url() { global $CFG; $this->resetAfterTest(); $linkcoursesections = $CFG->linkcoursesections; // Generate a course with two sections (0 and 1) and two modules. $generator = $this->getDataGenerator(); $course1 = $generator->create_course(array('format' => 'weeks')); course_create_sections_if_missing($course1, array(0, 1)); $data = (object)['id' => $course1->id]; $format = course_get_format($course1); $format->update_course_format_options($data); // In page. $CFG->linkcoursesections = 0; $this->assertNotEmpty($format->get_view_url(null)); $this->assertNotEmpty($format->get_view_url(0)); $this->assertNotEmpty($format->get_view_url(1)); $CFG->linkcoursesections = 1; $this->assertNotEmpty($format->get_view_url(null)); $this->assertNotEmpty($format->get_view_url(0)); $this->assertNotEmpty($format->get_view_url(1)); // Navigation. $CFG->linkcoursesections = 0; $this->assertNull($format->get_view_url(1, ['navigation' => 1])); $this->assertNull($format->get_view_url(0, ['navigation' => 1])); $CFG->linkcoursesections = 1; $this->assertNotEmpty($format->get_view_url(1, ['navigation' => 1])); $this->assertNotEmpty($format->get_view_url(0, ['navigation' => 1])); } }