MDL-19756 Renamed help_icon class to moodle_help_icon

diff --git a/lib/deprecatedlib.php b/lib/deprecatedlib.php
index 811c786ca23eb108deb0647f0622b7ca3c162624..072e74da4889da5ee2d78cbf85c55c665db2bcab 100644 (file)
--- a/lib/deprecatedlib.php
+++ b/lib/deprecatedlib.php
@@ -2809,7 +2809,7 @@ function helpbutton($page, $title, $module='moodle', $image=true, $linktext=fals
         throw new coding_exception('The $imagetext parameter has been deprecated. Please update your code and use $OUTPUT->help_icon() instead.');
     }
 
-    $helpicon = new help_icon();
+    $helpicon = new moodle_help_icon();
     $helpicon->page = $page;
     $helpicon->text = $title;
     $helpicon->module = $module;
@@ -3459,7 +3459,7 @@ function print_heading_with_help($text, $helppage, $module='moodle', $icon=false
 
     global $OUTPUT;
 
-    $helpicon = new help_icon();
+    $helpicon = new moodle_help_icon();
     $helpicon->page = $helppage;
     $helpicon->text = $text;
     $helpicon->module = $module;

diff --git a/lib/outputcomponents.php b/lib/outputcomponents.php
index 37e9931111cfcd31dd54391a6d4d9a3911dbe45d..edd47e437de7a221c30c90448163b8cd2a151d5c 100644 (file)
--- a/lib/outputcomponents.php
+++ b/lib/outputcomponents.php
@@ -307,7 +307,7 @@ class moodle_select extends moodle_html_component {
      */
     public $form;
     /**
-     * @var help_icon $form An optional help_icon component
+     * @var moodle_help_icon $form An optional moodle_help_icon component
      */
     public $helpicon;
     /**
@@ -546,7 +546,7 @@ class moodle_select extends moodle_html_component {
      * <pre>
      * $select->set_help_icon($page, $text, $linktext);
      * // OR
-     * $helpicon = new help_icon();
+     * $helpicon = new moodle_help_icon();
      * $helpicon->page = $page;
      * $helpicon->text = $text;
      * $helpicon->linktext = $linktext;
@@ -556,16 +556,16 @@ class moodle_select extends moodle_html_component {
      * Use the second form when you need to add additional HTML attributes
      * to the label and/or JS actions.
      *
-     * @param mixed $page Either the keyword that defines a help page or a help_icon object
+     * @param mixed $page Either the keyword that defines a help page or a moodle_help_icon object
      * @param text  $text The text of the help icon
      * @param boolean $linktext Whether or not to show text next to the icon
      * @return void
      */
     public function set_help_icon($page, $text, $linktext=false) {
-        if ($page instanceof help_icon) {
+        if ($page instanceof moodle_help_icon) {
             $this->helpicon = $page;
         } else if (!empty($page)) {
-            $this->helpicon = new help_icon();
+            $this->helpicon = new moodle_help_icon();
             $this->helpicon->page = $page;
             $this->helpicon->text = $text;
             $this->helpicon->linktext = $linktext;
@@ -1340,7 +1340,7 @@ class html_link extends moodle_html_component {
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  * @since     Moodle 2.0
  */
-class help_icon extends moodle_html_component {
+class moodle_help_icon extends moodle_html_component {
     /**
      * @var html_link $link A html_link object that will hold the URL info
      */
@@ -1385,11 +1385,11 @@ class help_icon extends moodle_html_component {
         global $COURSE, $OUTPUT;
 
         if (empty($this->page)) {
-            throw new coding_exception('A help_icon object requires a $page parameter');
+            throw new coding_exception('A moodle_help_icon object requires a $page parameter');
         }
 
         if (empty($this->text)) {
-            throw new coding_exception('A help_icon object requires a $text parameter');
+            throw new coding_exception('A moodle_help_icon object requires a $text parameter');
         }
 
         $this->link->text = $this->text;
@@ -1450,7 +1450,7 @@ class help_icon extends moodle_html_component {
     }
 
     public static function make_scale_menu($courseid, $scale) {
-        $helpbutton = new help_icon();
+        $helpbutton = new moodle_help_icon();
         $strscales = get_string('scales');
         $helpbutton->image->alt = $scale->name;
         $helpbutton->link->url = new moodle_url('/course/scales.php', array('id' => $courseid, 'list' => true, 'scaleid' => $scale->id));

diff --git a/lib/outputrenderers.php b/lib/outputrenderers.php
index c12040bce6bb4f4a7a434bbdf2a4ef7cf1089610..a0615c2ad534bcf3efaa37c808c5453eb204a45f 100644 (file)
--- a/lib/outputrenderers.php
+++ b/lib/outputrenderers.php
@@ -1263,7 +1263,7 @@ class moodle_core_renderer extends moodle_renderer_base {
     /*
      * Centered heading with attached help button (same title text)
      * and optional icon attached
-     * @param help_icon $helpicon A help_icon object
+     * @param moodle_help_icon $helpicon A moodle_help_icon object
      * @param mixed $image An image URL or a html_image object
      * @return string HTML fragment
      */
@@ -1279,7 +1279,7 @@ class moodle_core_renderer extends moodle_renderer_base {
     /**
      * Print a help icon.
      *
-     * @param help_icon $helpicon A help_icon object, subclass of html_link
+     * @param moodle_help_icon $helpicon A moodle_help_icon object, subclass of html_link
      *
      * @return string  HTML fragment
      */
@@ -1569,7 +1569,7 @@ class moodle_core_renderer extends moodle_renderer_base {
      * moodle_select::set_label($label) passing a html_label object
      *
      * To add a help icon, use moodle_select::set_help($page, $text, $linktext) or
-     * moodle_select::set_help($helpicon) passing a help_icon object
+     * moodle_select::set_help($helpicon) passing a moodle_help_icon object
      *
      * If you moodle_select::$rendertype to "radio", it will render radio buttons
      * instead of a <select> menu, unless $multiple is true, in which case it
@@ -1628,7 +1628,7 @@ class moodle_core_renderer extends moodle_renderer_base {
             $html .= $this->label($select->label);
         }
 
-        if (!empty($select->helpicon) && $select->helpicon instanceof help_icon) {
+        if (!empty($select->helpicon) && $select->helpicon instanceof moodle_help_icon) {
             $html .= $this->help_icon($select->helpicon);
         }
 

diff --git a/lib/simpletest/testoutputlib.php b/lib/simpletest/testoutputlib.php
index 5c3acbfce557fd2265efba59f360339baad19f9c..80a26ca42de2ce383ac25804444b470c007b208c 100644 (file)
--- a/lib/simpletest/testoutputlib.php
+++ b/lib/simpletest/testoutputlib.php
@@ -1208,7 +1208,7 @@ class moodle_core_renderer_test extends UnitTestCase {
     }
 
     public function test_heading_with_help() {
-        $originalicon = new help_icon();
+        $originalicon = new moodle_help_icon();
         $originalicon->page = 'myhelppage';
         $originalicon->text = 'Cool help text';