completion MDL-25927 Change print_help_icon to display_help_icon (ret…

…urns html instead of printing)
NoelDeMartin · Jan 10, 2011 · 563e97b · 563e97b
1 parent 46f4c39
commit 563e97b
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 8 deletions.
diff --git a/course/format/topics/format.php b/course/format/topics/format.php
@@ -69,7 +69,7 @@
 
 // Print the Your progress icon if the track completion is enabled
 $completioninfo = new completion_info($course);
-$completioninfo->print_help_icon();
+echo $completioninfo->display_help_icon();
 
 echo $OUTPUT->heading(get_string('topicoutline'), 2, 'headingblock header outline');
 

diff --git a/course/format/weeks/format.php b/course/format/weeks/format.php
@@ -61,7 +61,7 @@
 
     //Print the Your progress icon if the track completion is enabled
     $completioninfo = new completion_info($course);
-    $completioninfo->print_help_icon();
+    echo $completioninfo->display_help_icon();
 
     echo $OUTPUT->heading(get_string('weeklyoutline'), 2, 'headingblock header outline');
 

diff --git a/lib/completionlib.php b/lib/completionlib.php
@@ -207,17 +207,19 @@ public function is_enabled($cm=null) {
     }
 
     /**
-     * Print the Your progress help icon if the completion tracking is enabled.
+     * Returns the 'Your progress' help icon, if completion tracking is enabled.
      * @global object
-     * @return void
+     * @return string HTML code for help icon, or blank if not needed
      */
-    public function print_help_icon() {
+    public function display_help_icon() {
         global $PAGE, $OUTPUT;
+        $result = '';
         if ($this->is_enabled() && !$PAGE->user_is_editing() && isloggedin() && !isguestuser()) {
-            echo '<span id = "completionprogressid" class="completionprogress">'.get_string('yourprogress','completion').' ';
-            echo $OUTPUT->help_icon('completionicons', 'completion');
-            echo '</span>';
+            $result .= '<span id = "completionprogressid" class="completionprogress">'.get_string('yourprogress','completion').' ';
+            $result .= $OUTPUT->help_icon('completionicons', 'completion');
+            $result .= '</span>';
         }
+        return $result;
     }
 
     /**