fixup! MDL-87177 question: Update page types returns for 5.2

Author: marxjohnson

public/lib/questionlib.php

@@ -1841,6 +1841,9 @@ function core_question_question_preview_pluginfile($previewcontext, $questionid,
 
 /**
  * Return a list of page types for questions and the page types for the current module/context.
+ *
+ * This list is used when displaying blocks on a question page, to provide the list of possible page type patterns for the block.
+ *
  * @param string $pagetype current page type
  * @param stdClass $parentcontext Block's parent context
  * @param stdClass $currentcontext Current context of block
@@ -1854,6 +1857,7 @@ function question_page_type_list($pagetype, $parentcontext, $currentcontext): ar
         'question-bank-exportquestions-export' => get_string('page-question-export', 'question'),
         'question-bank-importquestions-import' => get_string('page-question-import', 'question'),
     ];
+    // If current page is in a module context, include the list of page types for that module, if it provides one.
     if ($currentcontext && $currentcontext->contextlevel == CONTEXT_MODULE) {
         [, $cm] = get_course_and_cm_from_cmid($currentcontext->instanceid);
         $directory = core_component::get_plugin_directory('mod', $cm->modname);

public/lib/tests/questionlib_test.php

@@ -20,6 +20,7 @@
 use core\context\module;
 use core_question\local\bank\question_bank_helper;
 use mod_quiz\quiz_settings;
+use PHPUnit\Framework\Attributes\DataProvider;
 use question_bank;
 
 defined('MOODLE_INTERNAL') || die();
@@ -1781,31 +1782,74 @@ public function test_move_question_set_references_category(): void {
     }
 
     /**
-     * Check the page type list is correct based on the context of the module the question is in.
+     * Provide examples of different modules and the page types returned by their _page_type_list function.
+     *
+     * @return array[] Module name, and a list of page types.
+     */
+    public static function module_page_types(): array {
+        return [
+            'quiz' => [
+                'module' => 'quiz',
+                'pagetypes' => [
+                    'mod-quiz-*',
+                    'mod-quiz-view',
+                    'mod-quiz-attempt',
+                    'mod-quiz-summary',
+                    'mod-quiz-review',
+                    'mod-quiz-edit',
+                    'mod-quiz-report',
+                ],
+            ],
+            'forum' => [
+                'module' => 'forum',
+                'pagetypes' => [
+                    'mod-forum-*',
+                    'mod-forum-view',
+                    'mod-forum-discuss',
+                ],
+            ],
+            'scorm' => [
+                'module' => 'scorm',
+                'pagetypes' => [
+                    'mod-scorm-*',
+                ],
+            ],
+            'lti' => [ // LTI has no additional page types.
+                'module' => 'lti',
+                'pagetypes' => [],
+            ],
+        ];
+    }
+
+    /**
+     * Calling question_page_type_list should return the question page types, plus the page types for the module context.
      *
      * @covers ::question_page_type_list()
+     * @param string $module The module name.
+     * @param string[] $pagetypes A list of the page type patterns this module should add.
      */
-    public function test_question_page_type_list(): void {
+    #[DataProvider('module_page_types')]
+    public function test_question_page_type_list(string $module, array $pagetypes): void {
         $this->resetAfterTest();
         $this->setAdminUser();
 
         $course = $this->getDataGenerator()->create_course();
         $coursecontext = course::instance($course->id);
 
-        $quiz = $this->getDataGenerator()->create_module('quiz', ['course' => $course->id]);
-        $quizcontext = module::instance($quiz->cmid);
+        $modulerecord = $this->getDataGenerator()->create_module($module, ['course' => $course->id]);
+        $modulecontext = module::instance($modulerecord->cmid);
 
-        $forum = $this->getDataGenerator()->create_module('forum', ['course' => $course->id]);
-        $forumcontext = module::instance($forum->cmid);
-
-        $scorm = $this->getDataGenerator()->create_module('scorm', ['course' => $course->id]);
-        $scormcontext = module::instance($scorm->cmid);
+        $questionpagetypes = [
+            'question-*',
+            'question-edit',
+            'question-bank-managecategories-category',
+            'question-bank-exportquestions-export',
+            'question-bank-importquestions-import',
+        ];
 
-        // Function quiz_page_type_list has 7 additional page types.
-        $this->assertCount(12, question_page_type_list('question-edit', $coursecontext, $quizcontext));
-        // Function forum_page_type_list has 3 additional page types.
-        $this->assertCount(8, question_page_type_list('question-edit', $coursecontext, $forumcontext));
-        // Function scorm_page_type_list has 1 additional page types.
-        $this->assertCount(6, question_page_type_list('question-edit', $coursecontext, $scormcontext));
+        $expectedpagetypes = array_merge($pagetypes, $questionpagetypes);
+        $actualpagetypes = question_page_type_list('question-edit', $coursecontext, $modulecontext);
+        // Check that the expected page type patterns match those returned for this module.
+        $this->assertEquals($expectedpagetypes, array_keys($actualpagetypes));
     }
 }