MDL-50540 mod_glossary: Final clean up of new external function
authorFrederic Massart <fred@moodle.com>
Tue, 6 Oct 2015 04:27:24 +0000 (12:27 +0800)
committerFrederic Massart <fred@moodle.com>
Mon, 7 Dec 2015 05:42:37 +0000 (13:42 +0800)
lib/db/services.php
mod/glossary/classes/external.php
mod/glossary/db/services.php [new file with mode: 0644]
mod/glossary/tests/external_test.php [new file with mode: 0644]
mod/glossary/tests/externallib_test.php [deleted file]
mod/glossary/version.php
version.php

index 6c0408a..61b5752 100644 (file)
@@ -1148,14 +1148,6 @@ $functions = array(
         'ajax'        => true
     ),
 
-    'mod_glossary_get_glossaries_by_courses' => array(
-        'classname'     => 'mod_glossary_external',
-        'methodname'    => 'get_glossaries_by_courses',
-        'description'   => 'Retrieve a list of glossaries from several courses.',
-        'type'          => 'read',
-        'capabilities'  => 'mod/glossary:view'
-    ),
-
 );
 
 $services = array(
index 6404f4a..65c8bf3 100644 (file)
 //
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
 /**
- * Glossary module external API
+ * Glossary module external API.
  *
  * @package    mod_glossary
  * @category   external
  * @copyright  2015 Costantino Cito <ccito@cvaconsulting.com>
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- * @since      Moodle 3.0
+ * @since      Moodle 3.1
  */
 defined('MOODLE_INTERNAL') || die;
-require_once("$CFG->libdir/externallib.php");
+require_once($CFG->libdir . '/externallib.php');
+
 /**
- * Glossary module external functions
+ * Glossary module external functions.
  *
  * @package    mod_glossary
  * @category   external
  * @copyright  2015 Costantino Cito <ccito@cvaconsulting.com>
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- * @since      Moodle 3.0
+ * @since      Moodle 3.1
  */
 class mod_glossary_external extends external_api {
+
     /**
      * Describes the parameters for get_glossaries_by_courses.
      *
      * @return external_external_function_parameters
-     * @since Moodle 3.0
+     * @since Moodle 3.1
      */
     public static function get_glossaries_by_courses_parameters() {
         return new external_function_parameters (
             array(
                 'courseids' => new external_multiple_structure(
                     new external_value(PARAM_INT, 'course id'),
-                    'Array of course ids', VALUE_DEFAULT, array()
+                    'Array of course IDs', VALUE_DEFAULT, array()
                 ),
             )
         );
     }
+
     /**
-     * Returns a list of glossaries in a provided list of courses,
-     * if no list is provided all glossaries that the user can view will be returned.
+     * Returns a list of glossaries in a provided list of courses.
      *
-     * @param array $courseids the course ids
-     * @return array of glossaries details
-     * @since Moodle 3.0
+     * If no list is provided all glossaries that the user can view will be returned.
+     *
+     * @param array $courseids the course IDs.
+     * @return array of glossaries
+     * @since Moodle 3.1
      */
     public static function get_glossaries_by_courses($courseids = array()) {
-        global $CFG;
         $params = self::validate_parameters(self::get_glossaries_by_courses_parameters(), array('courseids' => $courseids));
+
         $warnings = array();
-        if (!empty($params['courseids'])) {
-            $courses = array();
-            $courseids = $params['courseids'];
-        } else {
+        $courses = array();
+        $courseids = $params['courseids'];
+
+        if (empty($courseids)) {
             $courses = enrol_get_my_courses();
             $courseids = array_keys($courses);
         }
+
         // Array to store the glossaries to return.
-        $arrglossaries = array();
+        $glossaries = array();
+
         // Ensure there are courseids to loop through.
         if (!empty($courseids)) {
-            // Array of the courses we are going to retrieve the glossaries from.
-            $arraycourses = array();
-            // Go through the courseids.
-            foreach ($courseids as $cid) {
-                // Check the user can function in this context.
-                try {
-                    $context = context_course::instance($cid);
-                    self::validate_context($context);
-                    if (has_capability('mod/glossary:view', $context)) {
-                        // Check if this course was already loaded (by enrol_get_my_courses).
-                        if (!isset($courses[$cid])) {
-                            $courses[$cid] = get_course($cid);
-                        }
-                        $arraycourses[$cid] = $courses[$cid];
-                    } else {
-                        $warnings[] = array(
-                            'item' => 'course',
-                            'itemid' => $cid,
-                            'warningcode' => '2',
-                            'message' => get_string('missingrequiredcapability', 'webservice', 'mod/glossary:view')
-                        );
-                    }
-                } catch (Exception $e) {
-                    $warnings[] = array(
-                        'item' => 'course',
-                        'itemid' => $cid,
-                        'warningcode' => '1',
-                        'message' => 'No access rights in course context '.$e->getMessage()
-                    );
-                }
-            }
-            // Get the glossaries in this course, this function checks users visibility permissions.
-            // We can avoid then additional validate_context calls.
-            $glossaries = get_all_instances_in_courses("glossary", $arraycourses);
+            list($courses, $warnings) = external_util::validate_courses($courseids, $courses);
+
+            // Get the glossaries in these courses, this function checks users visibility permissions.
+            $glossaries = get_all_instances_in_courses('glossary', $courses);
             foreach ($glossaries as $glossary) {
-                $glossarycontext = context_module::instance($glossary->coursemodule);
-                // Entry to return.
-                $glossarydetails = array();
-                // First, we return information that any user can see in the web interface.
-                $glossarydetails['id'] = $glossary->id;
-                $glossarydetails['coursemodule']      = $glossary->coursemodule;
-                $glossarydetails['course']            = $glossary->course;
-                $glossarydetails['name']              = $glossary->name;
-                // Format intro.
-                list($glossarydetails['intro'], $glossarydetails['introformat']) =
-                    external_format_text($glossary->intro, $glossary->introformat,
-                                            $glossarycontext->id, 'mod_glossary', 'intro', null);
-                $glossarydetails['allowduplicatedentries'] = $glossary->allowduplicatedentries;
-                $glossarydetails['displayformat']          = $glossary->displayformat;
-                $glossarydetails['mainglossary']           = $glossary->mainglossary;
-                $glossarydetails['showspecial']            = $glossary->showspecial;
-                $glossarydetails['showalphabet']           = $glossary->showalphabet;
-                $glossarydetails['showall']                = $glossary->showall;
-                $glossarydetails['allowcomments']          = $glossary->allowcomments;
-                $glossarydetails['allowprintview']         = $glossary->allowprintview;
-                $glossarydetails['usedynalink']            = $glossary->usedynalink;
-                $glossarydetails['defaultapproval']        = $glossary->defaultapproval;
-                $glossarydetails['approvaldisplayformat']  = $glossary->approvaldisplayformat;
-                $glossarydetails['globalglossary']         = $glossary->globalglossary;
-                $glossarydetails['entbypage']              = $glossary->entbypage;
-                $glossarydetails['editalways']             = $glossary->editalways;
-                $glossarydetails['rsstype']                = $glossary->rsstype;
-                $glossarydetails['rssarticles']            = $glossary->rssarticles;
-                $glossarydetails['assessed']               = $glossary->assessed;
-                $glossarydetails['assesstimestart']        = $glossary->assesstimestart;
-                $glossarydetails['assesstimefinish']       = $glossary->assesstimefinish;
-                $glossarydetails['scale']                  = $glossary->scale;
-                if (has_capability('moodle/course:manageactivities', $glossarycontext)) {
-                    $glossarydetails['timecreated']            = $glossary->timecreated;
-                    $glossarydetails['timemodified']           = $glossary->timemodified;
-                    $glossarydetails['completionentries']      = $glossary->completionentries;
-                    $glossarydetails['section']                = $glossary->section;
-                    $glossarydetails['visible']                = $glossary->visible;
-                    $glossarydetails['groupmode']              = $glossary->groupmode;
-                    $glossarydetails['groupingid']             = $glossary->groupingid;
-                }
-                $arrglossaries[] = $glossarydetails;
+                $context = context_module::instance($glossary->coursemodule);
+                $glossary->name = external_format_string($glossary->name, $context->id);
+                list($glossary->intro, $glossary->introformat) = external_format_text($glossary->intro, $glossary->introformat,
+                    $context->id, 'mod_glossary', 'intro', null);
             }
         }
+
         $result = array();
-        $result['glossaries'] = $arrglossaries;
+        $result['glossaries'] = $glossaries;
         $result['warnings'] = $warnings;
         return $result;
     }
+
     /**
      * Describes the get_glossaries_by_courses return value.
      *
      * @return external_single_structure
-     * @since Moodle 3.0
+     * @since Moodle 3.1
      */
     public static function get_glossaries_by_courses_returns() {
-        return new external_single_structure(
-            array(
-                'glossaries' => new external_multiple_structure(
-                    new external_single_structure(
-                        array(
-                            'id' => new external_value(PARAM_INT, 'Glossary id'),
-                            'coursemodule' => new external_value(PARAM_INT, 'Course module id'),
-                            'course' => new external_value(PARAM_TEXT, 'Course id'),
-                            'name' => new external_value(PARAM_TEXT, 'Glossary name'),
-                            'intro' => new external_value(PARAM_RAW, 'The Glossary intro'),
-                            'introformat' => new external_format_value('intro'),
-                            'allowduplicatedentries' => new external_value(PARAM_INT, 'If enabled, multiple entries can have the'.
-                                                                                                            ' same concept name'),
-                            'displayformat' => new external_value(PARAM_TEXT, 'display format type'),
-                            'mainglossary'  => new external_value(PARAM_INT, 'main glossary'),
-                            'showspecial'   => new external_value(PARAM_INT, 'If enabled, participants can browse the glossary by'.
-                                                                                           ' special characters, such as @ and #'),
-                            'showalphabet'  => new external_value(PARAM_INT, 'If enabled, participants can browse the glossary by'.
-                                                                                                       ' letters of the alphabet'),
-                            'showall'       => new external_value(PARAM_INT, 'If enabled, participants can browse all entries '.
-                                                                                                                     ' at once'),
-                            'allowcomments' => new external_value(PARAM_INT, 'If enabled, all participants with permission to '.
-                                                             'create comments will be able to add comments to glossary entries'),
-                            'allowprintview' => new external_value(PARAM_INT, 'If enabled, students are provided with a link to a '.
-                                             ' printer-friendly version of the glossary. The link is always available to teachers'),
-                            'usedynalink' => new external_value(PARAM_INT, 'If site-wide glossary auto-linking has been enabled by'.
-                                            ' an administrator and this checkbox is ticked, the entry will be automatically linked'.
-                                               ' wherever the concept words and phrases appear throughout the rest of the course.'),
-                            'defaultapproval' => new external_value(PARAM_INT, 'If set to no, entries require approving by a '.
-                                                                              'teacher before they are viewable by everyone.'),
-                            'approvaldisplayformat' => new external_value(PARAM_TEXT, 'When approving glossary items you may wish'.
-                                                                                             ' to use a different display format'),
-                            'globalglossary' => new external_value(PARAM_INT, ''),
-                            'entbypage' => new external_value(PARAM_INT, 'Entries shown per page'),
-                            'editalways' => new external_value(PARAM_INT, 'Always allow editing'),
-                            'rsstype' => new external_value(PARAM_INT, 'To enable the RSS feed for this activity, select either'.
-                                                   ' concepts with author or concepts without author to be included in the feed'),
-                            'rssarticles' => new external_value(PARAM_INT, 'This setting specifies the number of glossary entry'.
-                                                  ' concepts to include in the RSS feed. Between 5 and 20 generally acceptable'),
-                            'assessed' => new external_value(PARAM_INT, 'assessed'),
-                            'assesstimestart' => new external_value(PARAM_RAW, 'assess time start'),
-                            'assesstimefinish' => new external_value(PARAM_RAW, 'assess time finish'),
-                            'scale' => new external_value(PARAM_INT, 'scale'),
-                            'timecreated' => new external_value(PARAM_RAW, 'time created', VALUE_OPTIONAL),
-                            'timemodified' => new external_value(PARAM_RAW, 'time modified', VALUE_OPTIONAL),
-                            'completionentries' => new external_value(PARAM_INT, 'completion entries', VALUE_OPTIONAL),
-                            'section' => new external_value(PARAM_INT, 'section', VALUE_OPTIONAL),
-                            'visible' => new external_value(PARAM_INT, 'visible', VALUE_OPTIONAL),
-                            'groupmode' => new external_value(PARAM_INT, 'group mode', VALUE_OPTIONAL),
-                            'groupingid' => new external_value(PARAM_INT, 'grouping id', VALUE_OPTIONAL),
-                        ), 'Glossaries'
-                    )
-                ),
-                'warnings' => new external_warnings(),
-            )
+        return new external_single_structure(array(
+            'glossaries' => new external_multiple_structure(
+                new external_single_structure(array(
+                    'id' => new external_value(PARAM_INT, 'Glossary id'),
+                    'coursemodule' => new external_value(PARAM_INT, 'Course module id'),
+                    'course' => new external_value(PARAM_INT, 'Course id'),
+                    'name' => new external_value(PARAM_RAW, 'Glossary name'),
+                    'intro' => new external_value(PARAM_RAW, 'The Glossary intro'),
+                    'introformat' => new external_format_value('intro'),
+                    'allowduplicatedentries' => new external_value(PARAM_INT, 'If enabled, multiple entries can have the' .
+                        ' same concept name'),
+                    'displayformat' => new external_value(PARAM_TEXT, 'Display format type'),
+                    'mainglossary' => new external_value(PARAM_INT, 'If enabled this glossary is a main glossary.'),
+                    'showspecial' => new external_value(PARAM_INT, 'If enabled, participants can browse the glossary by' .
+                        ' special characters, such as @ and #'),
+                    'showalphabet' => new external_value(PARAM_INT, 'If enabled, participants can browse the glossary by' .
+                        ' letters of the alphabet'),
+                    'showall' => new external_value(PARAM_INT, 'If enabled, participants can browse all entries at once'),
+                    'allowcomments' => new external_value(PARAM_INT, 'If enabled, all participants with permission to' .
+                        ' create comments will be able to add comments to glossary entries'),
+                    'allowprintview' => new external_value(PARAM_INT, 'If enabled, students are provided with a link to a' .
+                        ' printer-friendly version of the glossary. The link is always available to teachers'),
+                    'usedynalink' => new external_value(PARAM_INT, 'If site-wide glossary auto-linking has been enabled' .
+                        ' by an administrator and this checkbox is ticked, the entry will be automatically linked' .
+                        ' wherever the concept words and phrases appear throughout the rest of the course.'),
+                    'defaultapproval' => new external_value(PARAM_INT, 'If set to no, entries require approving by a' .
+                        ' teacher before they are viewable by everyone.'),
+                    'approvaldisplayformat' => new external_value(PARAM_TEXT, 'When approving glossary items you may wish' .
+                        ' to use a different display format'),
+                    'globalglossary' => new external_value(PARAM_INT, ''),
+                    'entbypage' => new external_value(PARAM_INT, 'Entries shown per page'),
+                    'editalways' => new external_value(PARAM_INT, 'Always allow editing'),
+                    'rsstype' => new external_value(PARAM_INT, 'To enable the RSS feed for this activity, select either' .
+                        ' concepts with author or concepts without author to be included in the feed'),
+                    'rssarticles' => new external_value(PARAM_INT, 'This setting specifies the number of glossary entry' .
+                        ' concepts to include in the RSS feed. Between 5 and 20 generally acceptable'),
+                    'assessed' => new external_value(PARAM_INT, 'Aggregate type'),
+                    'assesstimestart' => new external_value(PARAM_INT, 'Restrict rating to items created after this'),
+                    'assesstimefinish' => new external_value(PARAM_INT, 'Restrict rating to items created before this'),
+                    'scale' => new external_value(PARAM_INT, 'Scale ID'),
+                    'timecreated' => new external_value(PARAM_INT, 'Time created'),
+                    'timemodified' => new external_value(PARAM_INT, 'Time modified'),
+                    'completionentries' => new external_value(PARAM_INT, 'Number of entries to complete'),
+                    'section' => new external_value(PARAM_INT, 'Section'),
+                    'visible' => new external_value(PARAM_INT, 'Visible'),
+                    'groupmode' => new external_value(PARAM_INT, 'Group mode'),
+                    'groupingid' => new external_value(PARAM_INT, 'Grouping ID'),
+                ), 'Glossaries')
+            ),
+            'warnings' => new external_warnings())
         );
     }
 }
diff --git a/mod/glossary/db/services.php b/mod/glossary/db/services.php
new file mode 100644 (file)
index 0000000..fe26d6c
--- /dev/null
@@ -0,0 +1,38 @@
+<?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/>.
+
+/**
+ * Glossary module external functions.
+ *
+ * @package    mod_glossary
+ * @category   external
+ * @copyright  2015 Frédéric Massart - FMCorz.net
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+$functions = array(
+
+    'mod_glossary_get_glossaries_by_courses' => array(
+        'classname'     => 'mod_glossary_external',
+        'methodname'    => 'get_glossaries_by_courses',
+        'description'   => 'Retrieve a list of glossaries from several courses.',
+        'type'          => 'read',
+        'capabilities'  => 'mod/glossary:view'
+    ),
+
+);
diff --git a/mod/glossary/tests/external_test.php b/mod/glossary/tests/external_test.php
new file mode 100644 (file)
index 0000000..405ba93
--- /dev/null
@@ -0,0 +1,88 @@
+<?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/>.
+
+/**
+ * External glossary functions unit tests
+ *
+ * @package    mod_glossary
+ * @category   external
+ * @copyright  2015 Costantino Cito <ccito@cvaconsulting.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+global $CFG;
+require_once($CFG->dirroot . '/webservice/tests/helpers.php');
+
+/**
+ * External glossary functions unit tests
+ *
+ * @package    mod_glossary
+ * @category   external
+ * @copyright  2015 Costantino Cito <ccito@cvaconsulting.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class mod_glossary_external_testcase extends externallib_advanced_testcase {
+
+    /**
+     * Test get_glossaries_by_courses
+     */
+    public function test_get_glossaries_by_courses() {
+        $this->resetAfterTest(true);
+
+        // As admin.
+        $this->setAdminUser();
+        $c1 = self::getDataGenerator()->create_course();
+        $c2 = self::getDataGenerator()->create_course();
+        $g1 = self::getDataGenerator()->create_module('glossary', array('course' => $c1->id, 'name' => 'First Glossary'));
+        $g2 = self::getDataGenerator()->create_module('glossary', array('course' => $c1->id, 'name' => 'Second Glossary'));
+        $g3 = self::getDataGenerator()->create_module('glossary', array('course' => $c2->id, 'name' => 'Third Glossary'));
+
+        $s1 = $this->getDataGenerator()->create_user();
+        self::getDataGenerator()->enrol_user($s1->id,  $c1->id);
+
+        // Check results where student is enrolled.
+        $this->setUser($s1);
+        $glossaries = mod_glossary_external::get_glossaries_by_courses(array());
+        $glossaries = external_api::clean_returnvalue(mod_glossary_external::get_glossaries_by_courses_returns(), $glossaries);
+
+        $this->assertCount(2, $glossaries['glossaries']);
+        $this->assertEquals('First Glossary', $glossaries['glossaries'][0]['name']);
+        $this->assertEquals('Second Glossary', $glossaries['glossaries'][1]['name']);
+
+        // Check results with specific course IDs.
+        $glossaries = mod_glossary_external::get_glossaries_by_courses(array($c1->id, $c2->id));
+        $glossaries = external_api::clean_returnvalue(mod_glossary_external::get_glossaries_by_courses_returns(), $glossaries);
+
+        $this->assertCount(2, $glossaries['glossaries']);
+        $this->assertEquals('First Glossary', $glossaries['glossaries'][0]['name']);
+        $this->assertEquals('Second Glossary', $glossaries['glossaries'][1]['name']);
+
+        $this->assertEquals('course', $glossaries['warnings'][0]['item']);
+        $this->assertEquals($c2->id, $glossaries['warnings'][0]['itemid']);
+        $this->assertEquals('1', $glossaries['warnings'][0]['warningcode']);
+
+        // Now as admin.
+        $this->setAdminUser();
+
+        $glossaries = mod_glossary_external::get_glossaries_by_courses(array($c2->id));
+        $glossaries = external_api::clean_returnvalue(mod_glossary_external::get_glossaries_by_courses_returns(), $glossaries);
+
+        $this->assertCount(1, $glossaries['glossaries']);
+        $this->assertEquals('Third Glossary', $glossaries['glossaries'][0]['name']);
+    }
+
+}
diff --git a/mod/glossary/tests/externallib_test.php b/mod/glossary/tests/externallib_test.php
deleted file mode 100644 (file)
index 4e94bf4..0000000
+++ /dev/null
@@ -1,94 +0,0 @@
-<?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/>.
-/**
- * External glossary functions unit tests
- *
- * @package    mod_glossary
- * @category   external
- * @copyright  2015 Costantino Cito <ccito@cvaconsulting.com>
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-defined('MOODLE_INTERNAL') || die();
-global $CFG;
-require_once($CFG->dirroot . '/webservice/tests/helpers.php');
-/**
- * External glossary functions unit tests
- *
- * @package    mod_glossary
- * @category   external
- * @copyright  2015 Costantino Cito <ccito@cvaconsulting.com>
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-class mod_glossary_externallib_testcase extends externallib_advanced_testcase {
-    /**
-     * Test get_glossaries_by_courses
-     */
-    public function test_get_glossaries_by_courses() {
-        global $DB, $USER;
-        $this->resetAfterTest(true);
-        // As admin.
-        $this->setAdminUser();
-        $course1 = self::getDataGenerator()->create_course();
-        $glossaryoptions1 = array(
-                              'course' => $course1->id,
-                              'name' => 'First Glossary'
-                             );
-        $glossary1 = self::getDataGenerator()->create_module('glossary', $glossaryoptions1);
-        $course2 = self::getDataGenerator()->create_course();
-        $glossaryoptions2 = array(
-                              'course' => $course2->id,
-                              'name' => 'Second Glossary'
-                             );
-        $glossary2 = self::getDataGenerator()->create_module('glossary', $glossaryoptions2);
-        $student1 = $this->getDataGenerator()->create_user();
-        $studentrole = $DB->get_record('role', array('shortname' => 'student'));
-        // Enroll Student1 in Course1.
-        self::getDataGenerator()->enrol_user($student1->id,  $course1->id, $studentrole->id);
-        $this->setUser($student1);
-        $glossaries = mod_glossary_external::get_glossaries_by_courses(array());
-        // We need to execute the return values cleaning process to simulate the web service server.
-        $glossaries = external_api::clean_returnvalue(mod_glossary_external::get_glossaries_by_courses_returns(), $glossaries);
-        $this->assertCount(1, $glossaries['glossaries']);
-        $this->assertEquals('First Glossary', $glossaries['glossaries'][0]['name']);
-        // As Student you cannot see some glossary properties like 'showunanswered'.
-        $this->assertFalse(isset($glossaries['glossaries'][0]['section']));
-        // Student1 is not enrolled in this Course.
-        // The webservice will give a warning!
-        $glossaries = mod_glossary_external::get_glossaries_by_courses(array($course2->id));
-        // We need to execute the return values cleaning process to simulate the web service server.
-        $glossaries = external_api::clean_returnvalue(mod_glossary_external::get_glossaries_by_courses_returns(), $glossaries);
-        $this->assertCount(0, $glossaries['glossaries']);
-        $this->assertEquals(1, $glossaries['warnings'][0]['warningcode']);
-        // Now as admin.
-        $this->setAdminUser();
-        // As Admin we can see this glossary.
-        $glossaries = mod_glossary_external::get_glossaries_by_courses(array($course2->id));
-        // We need to execute the return values cleaning process to simulate the web service server.
-        $glossaries = external_api::clean_returnvalue(mod_glossary_external::get_glossaries_by_courses_returns(), $glossaries);
-        $this->assertCount(1, $glossaries['glossaries']);
-        $this->assertEquals('Second Glossary', $glossaries['glossaries'][0]['name']);
-        // As an Admin you can see some glossary properties like 'section'.
-        $this->assertEquals(0, $glossaries['glossaries'][0]['section']);
-        $this->setUser($student1);
-        // Prohibit capability = mod:glossary:view on Course1 for students.
-        $contextcourse1 = context_course::instance($course1->id);
-        assign_capability('mod/glossary:view', CAP_PROHIBIT, $studentrole->id, $contextcourse1->id);
-        accesslib_clear_all_caches_for_unit_testing();
-        $glossaries = mod_glossary_external::get_glossaries_by_courses(array($course1->id));
-        $glossaries = external_api::clean_returnvalue(mod_glossary_external::get_glossaries_by_courses_returns(), $glossaries);
-        $this->assertEquals(2, $glossaries['warnings'][0]['warningcode']);
-    }
-}
index b776316..66ae9ad 100644 (file)
@@ -24,7 +24,7 @@
 
 defined('MOODLE_INTERNAL') || die();
 
-$plugin->version   = 2015111600;       // The current module version (Date: YYYYMMDDXX)
+$plugin->version   = 2015111601;       // The current module version (Date: YYYYMMDDXX)
 $plugin->requires  = 2015111000;    // Requires this Moodle version
 $plugin->component = 'mod_glossary';   // Full name of the plugin (used for diagnostics)
 $plugin->cron      = 0;
index 535c147..3b24633 100644 (file)
@@ -29,7 +29,7 @@
 
 defined('MOODLE_INTERNAL') || die();
 
-$version  = 2015120400.01;              // YYYYMMDD      = weekly release date of this DEV branch.
+$version  = 2015120400.02;              // YYYYMMDD      = weekly release date of this DEV branch.
                                         //         RR    = release increments - 00 in DEV branches.
                                         //           .XX = incremental changes.