MDL-58731 modules: display intro on the course page

something that was forgotten when adding _get_coursemodule_info to activities in MDL-58190
moodle · Apr 28, 2017 · 438c01d · 438c01d
1 parent 5ccddd2
commit 438c01d
Show file tree

Hide file tree

Showing 9 changed files with 54 additions and 9 deletions.
diff --git a/mod/choice/lib.php b/mod/choice/lib.php
@@ -1242,14 +1242,19 @@ function choice_get_coursemodule_info($coursemodule) {
     global $DB;
 
     $dbparams = ['id' => $coursemodule->instance];
-    $fields = 'id, name, completionsubmit';
+    $fields = 'id, name, intro, introformat, completionsubmit';
     if (!$choice = $DB->get_record('choice', $dbparams, $fields)) {
         return false;
     }
 
     $result = new cached_cm_info();
     $result->name = $choice->name;
 
+    if ($coursemodule->showdescription) {
+        // Convert intro to html. Do not filter cached version, filters run at display time.
+        $result->content = format_module_intro('choice', $choice, $coursemodule->id, false);
+    }
+
     // Populate the custom completion rules as key => value pairs, but only if the completion mode is 'automatic'.
     if ($coursemodule->completion == COMPLETION_TRACKING_AUTOMATIC) {
         $result->customdata['customcompletionrules']['completionsubmit'] = $choice->completionsubmit;

diff --git a/mod/data/lib.php b/mod/data/lib.php
@@ -4336,14 +4336,19 @@ function data_get_coursemodule_info($coursemodule) {
     global $DB;
 
     $dbparams = ['id' => $coursemodule->instance];
-    $fields = 'id, name, completionentries';
+    $fields = 'id, name, intro, introformat, completionentries';
     if (!$data = $DB->get_record('data', $dbparams, $fields)) {
         return false;
     }
 
     $result = new cached_cm_info();
     $result->name = $data->name;
 
+    if ($coursemodule->showdescription) {
+        // Convert intro to html. Do not filter cached version, filters run at display time.
+        $result->content = format_module_intro('data', $data, $coursemodule->id, false);
+    }
+
     // Populate the custom completion rules as key => value pairs, but only if the completion mode is 'automatic'.
     if ($coursemodule->completion == COMPLETION_TRACKING_AUTOMATIC) {
         $result->customdata['customcompletionrules']['completionentries'] = $data->completionentries;

diff --git a/mod/feedback/lib.php b/mod/feedback/lib.php
@@ -3492,14 +3492,19 @@ function feedback_get_coursemodule_info($coursemodule) {
     global $DB;
 
     $dbparams = ['id' => $coursemodule->instance];
-    $fields = 'id, name, completionsubmit';
+    $fields = 'id, name, intro, introformat, completionsubmit';
     if (!$feedback = $DB->get_record('feedback', $dbparams, $fields)) {
         return false;
     }
 
     $result = new cached_cm_info();
     $result->name = $feedback->name;
 
+    if ($coursemodule->showdescription) {
+        // Convert intro to html. Do not filter cached version, filters run at display time.
+        $result->content = format_module_intro('feedback', $feedback, $coursemodule->id, false);
+    }
+
     // Populate the custom completion rules as key => value pairs, but only if the completion mode is 'automatic'.
     if ($coursemodule->completion == COMPLETION_TRACKING_AUTOMATIC) {
         $result->customdata['customcompletionrules']['completionsubmit'] = $feedback->completionsubmit;

diff --git a/mod/forum/lib.php b/mod/forum/lib.php
@@ -8244,14 +8244,19 @@ function forum_get_coursemodule_info($coursemodule) {
     global $DB;
 
     $dbparams = ['id' => $coursemodule->instance];
-    $fields = 'id, name, completionposts, completiondiscussions, completionreplies';
+    $fields = 'id, name, intro, introformat, completionposts, completiondiscussions, completionreplies';
     if (!$forum = $DB->get_record('forum', $dbparams, $fields)) {
         return false;
     }
 
     $result = new cached_cm_info();
     $result->name = $forum->name;
 
+    if ($coursemodule->showdescription) {
+        // Convert intro to html. Do not filter cached version, filters run at display time.
+        $result->content = format_module_intro('forum', $forum, $coursemodule->id, false);
+    }
+
     // Populate the custom completion rules as key => value pairs, but only if the completion mode is 'automatic'.
     if ($coursemodule->completion == COMPLETION_TRACKING_AUTOMATIC) {
         $result->customdata['customcompletionrules']['completiondiscussions'] = $forum->completiondiscussions;

diff --git a/mod/glossary/lib.php b/mod/glossary/lib.php
@@ -4220,14 +4220,19 @@ function glossary_get_coursemodule_info($coursemodule) {
     global $DB;
 
     $dbparams = ['id' => $coursemodule->instance];
-    $fields = 'id, name, completionentries';
+    $fields = 'id, name, intro, introformat, completionentries';
     if (!$glossary = $DB->get_record('glossary', $dbparams, $fields)) {
         return false;
     }
 
     $result = new cached_cm_info();
     $result->name = $glossary->name;
 
+    if ($coursemodule->showdescription) {
+        // Convert intro to html. Do not filter cached version, filters run at display time.
+        $result->content = format_module_intro('glossary', $glossary, $coursemodule->id, false);
+    }
+
     // Populate the custom completion rules as key => value pairs, but only if the completion mode is 'automatic'.
     if ($coursemodule->completion == COMPLETION_TRACKING_AUTOMATIC) {
         $result->customdata['customcompletionrules']['completionentries'] = $glossary->completionentries;

diff --git a/mod/lesson/lib.php b/mod/lesson/lib.php
@@ -1665,14 +1665,19 @@ function lesson_get_coursemodule_info($coursemodule) {
     global $DB;
 
     $dbparams = ['id' => $coursemodule->instance];
-    $fields = 'id, name, completionendreached, completiontimespent';
+    $fields = 'id, name, intro, introformat, completionendreached, completiontimespent';
     if (!$lesson = $DB->get_record('lesson', $dbparams, $fields)) {
         return false;
     }
 
     $result = new cached_cm_info();
     $result->name = $lesson->name;
 
+    if ($coursemodule->showdescription) {
+        // Convert intro to html. Do not filter cached version, filters run at display time.
+        $result->content = format_module_intro('lesson', $lesson, $coursemodule->id, false);
+    }
+
     // Populate the custom completion rules as key => value pairs, but only if the completion mode is 'automatic'.
     if ($coursemodule->completion == COMPLETION_TRACKING_AUTOMATIC) {
         $result->customdata['customcompletionrules']['completionendreached'] = $lesson->completionendreached;

diff --git a/mod/quiz/lib.php b/mod/quiz/lib.php
@@ -2178,14 +2178,19 @@ function quiz_get_coursemodule_info($coursemodule) {
     global $DB;
 
     $dbparams = ['id' => $coursemodule->instance];
-    $fields = 'id, name, completionattemptsexhausted, completionpass';
+    $fields = 'id, name, intro, introformat, completionattemptsexhausted, completionpass';
     if (!$quiz = $DB->get_record('quiz', $dbparams, $fields)) {
         return false;
     }
 
     $result = new cached_cm_info();
     $result->name = $quiz->name;
 
+    if ($coursemodule->showdescription) {
+        // Convert intro to html. Do not filter cached version, filters run at display time.
+        $result->content = format_module_intro('quiz', $quiz, $coursemodule->id, false);
+    }
+
     // Populate the custom completion rules as key => value pairs, but only if the completion mode is 'automatic'.
     if ($coursemodule->completion == COMPLETION_TRACKING_AUTOMATIC) {
         $result->customdata['customcompletionrules']['completionattemptsexhausted'] = $quiz->completionattemptsexhausted;

diff --git a/mod/scorm/lib.php b/mod/scorm/lib.php
@@ -1660,14 +1660,19 @@ function scorm_get_coursemodule_info($coursemodule) {
     global $DB;
 
     $dbparams = ['id' => $coursemodule->instance];
-    $fields = 'id, name, completionstatusrequired, completionscorerequired, completionstatusallscos';
+    $fields = 'id, name, intro, introformat, completionstatusrequired, completionscorerequired, completionstatusallscos';
     if (!$scorm = $DB->get_record('scorm', $dbparams, $fields)) {
         return false;
     }
 
     $result = new cached_cm_info();
     $result->name = $scorm->name;
 
+    if ($coursemodule->showdescription) {
+        // Convert intro to html. Do not filter cached version, filters run at display time.
+        $result->content = format_module_intro('scorm', $scorm, $coursemodule->id, false);
+    }
+
     // Populate the custom completion rules as key => value pairs, but only if the completion mode is 'automatic'.
     if ($coursemodule->completion == COMPLETION_TRACKING_AUTOMATIC) {
         $result->customdata['customcompletionrules']['completionstatusrequired'] = $scorm->completionstatusrequired;

diff --git a/mod/survey/lib.php b/mod/survey/lib.php
@@ -1161,14 +1161,19 @@ function survey_get_coursemodule_info($coursemodule) {
     global $DB;
 
     $dbparams = ['id' => $coursemodule->instance];
-    $fields = 'id, name, completionsubmit';
+    $fields = 'id, name, intro, introformat, completionsubmit';
     if (!$survey = $DB->get_record('survey', $dbparams, $fields)) {
         return false;
     }
 
     $result = new cached_cm_info();
     $result->name = $survey->name;
 
+    if ($coursemodule->showdescription) {
+        // Convert intro to html. Do not filter cached version, filters run at display time.
+        $result->content = format_module_intro('survey', $survey, $coursemodule->id, false);
+    }
+
     // Populate the custom completion rules as key => value pairs, but only if the completion mode is 'automatic'.
     if ($coursemodule->completion == COMPLETION_TRACKING_AUTOMATIC) {
         $result->customdata['customcompletionrules']['completionsubmit'] = $survey->completionsubmit;