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 mod_url;

> use core_external\external_api;
use externallib_advanced_testcase; use mod_url_external; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once($CFG->dirroot . '/webservice/tests/helpers.php'); /** * External mod_url functions unit tests * * @package mod_url * @category external * @copyright 2015 Juan Leyva <juan@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later * @since Moodle 3.0 */ class externallib_test extends externallib_advanced_testcase { /** * Test view_url */ public function test_view_url() { global $DB; $this->resetAfterTest(true); // Setup test data. $course = $this->getDataGenerator()->create_course(); $url = $this->getDataGenerator()->create_module('url', array('course' => $course->id)); $context = \context_module::instance($url->cmid); $cm = get_coursemodule_from_instance('url', $url->id); // Test invalid instance id. try { mod_url_external::view_url(0); $this->fail('Exception expected due to invalid mod_url instance id.'); } catch (\moodle_exception $e) { $this->assertEquals('invalidrecord', $e->errorcode); } // Test not-enrolled user. $user = self::getDataGenerator()->create_user(); $this->setUser($user); try { mod_url_external::view_url($url->id); $this->fail('Exception expected due to not enrolled user.'); } catch (\moodle_exception $e) { $this->assertEquals('requireloginerror', $e->errorcode); } // Test user with full capabilities. $studentrole = $DB->get_record('role', array('shortname' => 'student')); $this->getDataGenerator()->enrol_user($user->id, $course->id, $studentrole->id); // Trigger and capture the event. $sink = $this->redirectEvents(); $result = mod_url_external::view_url($url->id);
< $result = \external_api::clean_returnvalue(mod_url_external::view_url_returns(), $result);
> $result = external_api::clean_returnvalue(mod_url_external::view_url_returns(), $result);
$events = $sink->get_events(); $this->assertCount(1, $events); $event = array_shift($events); // Checking that the event contains the expected values. $this->assertInstanceOf('\mod_url\event\course_module_viewed', $event); $this->assertEquals($context, $event->get_context()); $moodleurl = new \moodle_url('/mod/url/view.php', array('id' => $cm->id)); $this->assertEquals($moodleurl, $event->get_url()); $this->assertEventContextNotUsed($event); $this->assertNotEmpty($event->get_name()); // Test user with no capabilities. // We need a explicit prohibit since this capability is only defined in authenticated user and guest roles. assign_capability('mod/url:view', CAP_PROHIBIT, $studentrole->id, $context->id); // Empty all the caches that may be affected by this change. accesslib_clear_all_caches_for_unit_testing(); \course_modinfo::clear_instance_cache(); try { mod_url_external::view_url($url->id); $this->fail('Exception expected due to missing capability.'); } catch (\moodle_exception $e) { $this->assertEquals('requireloginerror', $e->errorcode); } } /** * Test test_mod_url_get_urls_by_courses */ public function test_mod_url_get_urls_by_courses() { global $DB; $this->resetAfterTest(true); $course1 = self::getDataGenerator()->create_course(); $course2 = self::getDataGenerator()->create_course(); $student = self::getDataGenerator()->create_user(); $studentrole = $DB->get_record('role', array('shortname' => 'student')); $this->getDataGenerator()->enrol_user($student->id, $course1->id, $studentrole->id); // First url. $record = new \stdClass(); $record->course = $course1->id; $url1 = self::getDataGenerator()->create_module('url', $record); // Second url. $record = new \stdClass(); $record->course = $course2->id; $url2 = self::getDataGenerator()->create_module('url', $record); // Execute real Moodle enrolment as we'll call unenrol() method on the instance later. $enrol = enrol_get_plugin('manual'); $enrolinstances = enrol_get_instances($course2->id, true); foreach ($enrolinstances as $courseenrolinstance) { if ($courseenrolinstance->enrol == "manual") { $instance2 = $courseenrolinstance; break; } } $enrol->enrol_user($instance2, $student->id, $studentrole->id); self::setUser($student); $returndescription = mod_url_external::get_urls_by_courses_returns(); // Create what we expect to be returned when querying the two courses.
< $expectedfields = array('id', 'coursemodule', 'course', 'name', 'intro', 'introformat', 'introfiles', 'externalurl', < 'display', 'displayoptions', 'parameters', 'timemodified', 'section', 'visible', 'groupmode',
> $expectedfields = array('id', 'coursemodule', 'course', 'name', 'intro', 'introformat', 'introfiles', 'lang', > 'externalurl', 'display', 'displayoptions', 'parameters', 'timemodified', 'section', 'visible', 'groupmode',
'groupingid'); // Add expected coursemodule and data. $url1->coursemodule = $url1->cmid; $url1->introformat = 1; $url1->section = 0; $url1->visible = true; $url1->groupmode = 0; $url1->groupingid = 0; $url1->introfiles = [];
> $url1->lang = '';
$url2->coursemodule = $url2->cmid; $url2->introformat = 1; $url2->section = 0; $url2->visible = true; $url2->groupmode = 0; $url2->groupingid = 0; $url2->introfiles = [];
> $url2->lang = '';
foreach ($expectedfields as $field) { $expected1[$field] = $url1->{$field}; $expected2[$field] = $url2->{$field}; } $expectedurls = array($expected2, $expected1); // Call the external function passing course ids. $result = mod_url_external::get_urls_by_courses(array($course2->id, $course1->id));
< $result = \external_api::clean_returnvalue($returndescription, $result);
> $result = external_api::clean_returnvalue($returndescription, $result);
$this->assertEquals($expectedurls, $result['urls']); $this->assertCount(0, $result['warnings']); // Call the external function without passing course id. $result = mod_url_external::get_urls_by_courses();
< $result = \external_api::clean_returnvalue($returndescription, $result);
> $result = external_api::clean_returnvalue($returndescription, $result);
$this->assertEquals($expectedurls, $result['urls']); $this->assertCount(0, $result['warnings']); // Add a file to the intro. $filename = "file.txt"; $filerecordinline = array( 'contextid' => \context_module::instance($url2->cmid)->id, 'component' => 'mod_url', 'filearea' => 'intro', 'itemid' => 0, 'filepath' => '/', 'filename' => $filename, ); $fs = get_file_storage(); $timepost = time(); $fs->create_file_from_string($filerecordinline, 'image contents (not really)'); $result = mod_url_external::get_urls_by_courses(array($course2->id, $course1->id));
< $result = \external_api::clean_returnvalue($returndescription, $result);
> $result = external_api::clean_returnvalue($returndescription, $result);
$this->assertCount(1, $result['urls'][0]['introfiles']); $this->assertEquals($filename, $result['urls'][0]['introfiles'][0]['filename']); // Unenrol user from second course and alter expected urls. $enrol->unenrol_user($instance2, $student->id); array_shift($expectedurls); // Call the external function without passing course id. $result = mod_url_external::get_urls_by_courses();
< $result = \external_api::clean_returnvalue($returndescription, $result);
> $result = external_api::clean_returnvalue($returndescription, $result);
$this->assertEquals($expectedurls, $result['urls']); // Call for the second course we unenrolled the user from, expected warning. $result = mod_url_external::get_urls_by_courses(array($course2->id)); $this->assertCount(1, $result['warnings']); $this->assertEquals('1', $result['warnings'][0]['warningcode']); $this->assertEquals($course2->id, $result['warnings'][0]['itemid']); } }