MDL-21217, MDL-21198 simplified/improved outputlib help icon related …

…apis + several fixed regresions
ragusa87 · Dec 30, 2009 · 4bcc511 · 4bcc511
1 parent 48a67d9
commit 4bcc511
Show file tree

Hide file tree

Showing 113 changed files with 441 additions and 969 deletions.
diff --git a/admin/index.php b/admin/index.php
@@ -380,7 +380,7 @@
 $lastcron = $DB->get_field_sql('SELECT MAX(lastcron) FROM {modules}');
 if (time() - $lastcron > 3600 * 24) {
     $strinstallation = get_string('installation', 'install');
-    $helpbutton = $OUTPUT->help_icon(moodle_help_icon::make('install', $strinstallation));
+    $helpbutton = $OUTPUT->help_icon('install', $strinstallation);
     echo $OUTPUT->box(get_string('cronwarning', 'admin').'&nbsp;'.$helpbutton, 'generalbox adminwarning');
 }
 

diff --git a/admin/lang.php b/admin/lang.php
@@ -496,7 +496,7 @@
         $select->nothinglabel = $strchoosefiletoedit;
         $select->set_label($selectionlabel);
         echo $OUTPUT->select($select);
-        echo $OUTPUT->help_icon(moodle_help_icon::make('langswitchstorage', $strfilestoredinhelp));
+        echo $OUTPUT->help_icon('langswitchstorage', $strfilestoredinhelp);
         echo $OUTPUT->box_end();
 
         if ($currentfile <> '') {
@@ -763,7 +763,7 @@
         $select->nothinglabel = $strchoosefiletoedit;
         $select->set_label($selectionlabel);
         echo $OUTPUT->select($select);
-        echo $OUTPUT->help_icon(moodle_help_icon::make('langswitchstorage', $strfilestoredinhelp));
+        echo $OUTPUT->help_icon('langswitchstorage', $strfilestoredinhelp);
         echo $OUTPUT->box_end();
 
         if (!empty($currentfile)) {
@@ -812,11 +812,11 @@
             echo '<div>';
 
             if ($uselocal) {
-                $strsavetotitle = $strlanglocalpackage . $OUTPUT->help_icon(moodle_help_icon::make('langpackages', $strlanglocalpackage));
-                $straltdirtitle = $strlangmasterpackage . $OUTPUT->help_icon(moodle_help_icon::make('langpackages', $strlangmasterpackage));
+                $strsavetotitle = $strlanglocalpackage . $OUTPUT->help_icon('langpackages', $strlanglocalpackage);
+                $straltdirtitle = $strlangmasterpackage . $OUTPUT->help_icon('langpackages', $strlangmasterpackage);
             } else {
-                $straltdirtitle = $strlanglocalpackage . $OUTPUT->help_icon(moodle_help_icon::make('langpackages', $strlanglocalpackage));
-                $strsavetotitle = $strlangmasterpackage . $OUTPUT->help_icon(moodle_help_icon::make('langpackages', $strlangmasterpackage));
+                $straltdirtitle = $strlanglocalpackage . $OUTPUT->help_icon('langpackages', $strlanglocalpackage);
+                $strsavetotitle = $strlangmasterpackage . $OUTPUT->help_icon('langpackages', $strlangmasterpackage);
 
             }
 
@@ -876,7 +876,7 @@
             }
             if (is_readable($ensrc)) {
                 echo '<fieldset><legend>'.$strlangmasterenglish;
-                echo $OUTPUT->help_icon(moodle_help_icon::make('langpackages', $strlangmasterenglish));
+                echo $OUTPUT->help_icon('langpackages', $strlangmasterenglish);
                 echo '</legend>';
                 echo "<div class='mdl-align'>\n<textarea rows=\"$fileeditorrows\" cols=\"$fileeditorcols\" name=\"\">";
                 echo htmlspecialchars(file_get_contents($ensrc));

diff --git a/admin/mnet/mnet_review.html b/admin/mnet/mnet_review.html
@@ -32,7 +32,7 @@
     <td align="right" valign="top"><?php
         print_string('publickey', 'mnet');
         echo ': <br />';
-        echo $OUTPUT->help_icon(moodle_help_icon::make("publickey", get_string('publickey', 'mnet'), "mnet", true));
+        echo $OUTPUT->help_icon("publickey", get_string('publickey', 'mnet'), "mnet", true);
     ?></td>
 <?php
 
@@ -105,7 +105,7 @@
     <tr>
         <td align="right" valign="top"><?php print_string('ipaddress', 'mnet');
         echo ': <br />';
-        echo $OUTPUT->help_icon(moodle_help_icon::make("ipaddress", get_string('ipaddress', 'mnet'), "mnet", true));
+        echo $OUTPUT->help_icon("ipaddress", get_string('ipaddress', 'mnet'), "mnet", true);
         ?>:</td>
         <td valign="top"><?php echo $mnet_peer->ip_address; ?></td>
     </tr>

diff --git a/admin/roles/assign.php b/admin/roles/assign.php
@@ -296,10 +296,7 @@
     }
 
     /// Print heading.
-    $helpicon = new moodle_help_icon();
-    $helpicon->text = $title;
-    $helpicon->page = 'assignroles';
-    echo $OUTPUT->heading_with_help($helpicon);
+    echo $OUTPUT->heading_with_help($title, 'assignroles');
 
     if ($roleid) {
     /// Show UI for assigning a particular role to users.
@@ -330,7 +327,7 @@
               if ($hidden) { echo 'checked="checked" '; } ?>/>
               <label for="hidden" title="<?php print_string('createhiddenassign', 'role'); ?>">
                   <?php print_string('hidden', 'role'); ?>
-                  <?php echo $OUTPUT->help_icon(moodle_help_icon::make('hiddenassign', get_string('createhiddenassign', 'role'))); ?>
+                  <?php echo $OUTPUT->help_icon('hiddenassign', get_string('createhiddenassign', 'role')); ?>
               </label></p>
 
               <p><label for="extendperiod"><?php print_string('enrolperiod') ?></label><br />

diff --git a/admin/roles/check.php b/admin/roles/check.php
@@ -138,10 +138,7 @@
     }
 
 /// Print heading.
-    $helpicon = new moodle_help_icon();
-    $helpicon->text = $title;
-    $helpicon->page = 'checkpermissions';
-    echo $OUTPUT->heading_with_help($helpicon);
+    echo $OUTPUT->heading_with_help($title, 'checkpermissions');
 
 /// If a user has been chosen, show all the permissions for this user.
     $reportuser = $userselector->get_selected_user();

diff --git a/admin/roles/define.php b/admin/roles/define.php
@@ -120,10 +120,7 @@
     } else if ($action == 'edit') {
         $title = get_string('editingrolex', 'role', $rolenames[$roleid]->localname);
     }
-    $helpicon = new moodle_help_icon();
-    $helpicon->text = $title;
-    $helpicon->page = 'roles';
-    echo $OUTPUT->heading_with_help($helpicon);
+    echo $OUTPUT->heading_with_help($title, 'roles');
 
 /// Work out some button labels.
     if ($action == 'add' || $action == 'duplicate') {

diff --git a/admin/roles/lib.php b/admin/roles/lib.php
@@ -380,7 +380,7 @@ public function display() {
     protected function add_header_cells() {
         global $OUTPUT;
         echo '<th colspan="' . count($this->displaypermissions) . '" scope="col">' .
-                get_string('permission', 'role') . ' ' . $OUTPUT->help_icon(moodle_help_icon::make('permissions', get_string('permissions', 'role'))) . '</th>';
+                get_string('permission', 'role') . ' ' . $OUTPUT->help_icon('permissions', get_string('permissions', 'role')) . '</th>';
         echo '<th class="risk" colspan="' . count($this->allrisks) . '" scope="col">' . get_string('risks','role') . '</th>';
     }
 

diff --git a/admin/roles/manage.php b/admin/roles/manage.php
@@ -206,7 +206,7 @@
     $table->wrap = array('nowrap', '', 'nowrap','nowrap');
     $table->width = '90%';
     $table->head = array(
-        get_string('role') . ' ' . $OUTPUT->help_icon(moodle_help_icon::make('roles', get_string('roles'))),
+        get_string('role') . ' ' . $OUTPUT->help_icon('roles', get_string('roles')),
         get_string('description'),
         get_string('shortname'),
         get_string('edit')

diff --git a/admin/roles/override.php b/admin/roles/override.php
@@ -175,10 +175,7 @@
         include_once('tabs.php');
     }
 
-    $helpicon = new moodle_help_icon();
-    $helpicon->text = $title;
-    $helpicon->page = 'overrides';
-    echo $OUTPUT->heading_with_help($helpicon);
+    echo $OUTPUT->heading_with_help($title, 'overrides');
 
     if ($roleid) {
     /// Show UI for overriding roles.

diff --git a/admin/uploadpicture.php b/admin/uploadpicture.php
@@ -58,10 +58,7 @@
 /// Print the header
 admin_externalpage_print_header();
 
-$helpicon = new moodle_help_icon();
-$helpicon->text = $struploadpictures;
-$helpicon->page = 'uploadpictures';
-echo $OUTPUT->heading_with_help($helpicon);
+echo $OUTPUT->heading_with_help($struploadpictures, 'uploadpictures');
 
 $mform = new admin_uploadpicture_form(null, $userfields);
 if ($formdata = $mform->get_data()) {

diff --git a/admin/uploaduser.php b/admin/uploaduser.php
@@ -107,10 +107,7 @@
     } else {
         admin_externalpage_print_header();
 
-        $helpicon = new moodle_help_icon();
-        $helpicon->text = get_string('uploadusers');
-        $helpicon->page = 'uploadusers3';
-        echo $OUTPUT->heading_with_help($helpicon);
+        echo $OUTPUT->heading_with_help(get_string('uploadusers'), 'uploadusers3');
 
         $mform->display();
         echo $OUTPUT->footer();
@@ -749,10 +746,7 @@
 
 /// Print the form
 
-$helpicon = new moodle_help_icon();
-$helpicon->text = get_string('uploaduserspreview', 'admin');
-$helpicon->page = 'uploadusers2';
-echo $OUTPUT->heading_with_help($helpicon);
+echo $OUTPUT->heading_with_help(get_string('uploaduserspreview', 'admin'), 'uploadusers2');
 
 $ci = 0;
 $ri = 0;

diff --git a/admin/user/user_bulk_forms.php b/admin/user/user_bulk_forms.php
@@ -94,7 +94,7 @@ function definition() {
 
 
         $grp =& $mform->addElement('group', 'usersgrp', get_string('users'), $objs, ' ', false);
-        $grp->setHelpButton(array('lists', get_string('users'), 'bulkusers'));
+        $mform->setHelpButton('usersgrp', array('lists', get_string('users'), 'bulkusers'));
 
         $mform->addElement('static', 'comment');
 
@@ -104,7 +104,7 @@ function definition() {
         $objs[] =& $mform->createElement('submit', 'addall', get_string('addall', 'bulkusers'));
         $objs[] =& $mform->createElement('submit', 'removeall', get_string('removeall', 'bulkusers'));
         $grp =& $mform->addElement('group', 'buttonsgrp', get_string('selectedlist', 'bulkusers'), $objs, array(' ', '<br />'), false);
-        $grp->setHelpButton(array('selectedlist', get_string('selectedlist', 'bulkusers'), 'bulkusers'));
+        $mform->setHelpButton('buttonsgrp', array('selectedlist', get_string('selectedlist', 'bulkusers'), 'bulkusers'));
 
         $renderer =& $mform->defaultRenderer();
         $template = '<label class="qflabel" style="vertical-align:top">{label}</label> {element}';

diff --git a/backup/backup_form.html b/backup/backup_form.html
@@ -281,7 +281,7 @@
             echo "<tr>";
             echo "<td align=\"right\" colspan=\"2\"><b>";
             echo '<label for="menubackup_site_files">'.get_string ("sitefilesused").'</label>';
-            echo $OUTPUT->help_icon(moodle_help_icon::make('sitefilesused', get_string('sitefilesused')));
+            echo $OUTPUT->help_icon('sitefilesused', get_string('sitefilesused'));
             echo "</b></td><td colspan=\"2\">";
             $course_file_options[0] = get_string("no");
             $course_file_options[1] = get_string("yes");

diff --git a/backup/restore_form.html b/backup/restore_form.html
@@ -269,7 +269,7 @@
         echo '<label for="shortnamefield">'.get_string ('shortname').'</label>';
         echo "</td>";
         echo "<td><input type=\"text\" id=\"shortnamefield\" name=\"shortname\" maxlength=\"100\"  size=\"20\" value=\"".s($form1->shortname)."\" alt=\"".get_string("shortname")."\"  />" ;
-        echo $OUTPUT->help_icon(moodle_help_icon::make("courseshortname", get_string("shortname"))) ;
+        echo $OUTPUT->help_icon("courseshortname", get_string("shortname"));
         if (isset($err["shortname"])) echo $OUTPUT->error_text($err["shortname"]);
         echo "</td>";
         echo "</tr>";
@@ -278,7 +278,7 @@
         echo '<label for="fullnamefield">'.get_string ('fullname').'</label>';
         echo "</td>";
         echo "<td><input type=\"text\" id=\"fullnamefield\" name=\"fullname\" maxlength=\"254\" size=\"50\" value=\"".s($form1->fullname)."\" alt=\" ".get_string("fullname")."\"  />" ;
-        echo $OUTPUT->help_icon(moodle_help_icon::make("coursefullname", get_string("fullname"))) ;
+        echo $OUTPUT->help_icon("coursefullname", get_string("fullname"));
         if (isset($err["fullname"])) echo $OUTPUT->error_text($err["fullname"]);
         echo"</td></tr>";
     } else {
@@ -303,7 +303,7 @@
             $yearselector = html_select::make_time_selector('years', "startyear", $form1->startdate);
 
             echo $OUTPUT->select($dayselector) . $OUTPUT->select($monthselector) . $OUTPUT->select($yearselector);
-            echo $OUTPUT->help_icon(moodle_help_icon::make("coursestartdate", get_string("startdate")));
+            echo $OUTPUT->help_icon("coursestartdate", get_string("startdate"));
         } else {
             print_string('notavailable');
             echo '<input type="hidden" name="startyear" value="0" />';
@@ -463,7 +463,7 @@
         //Now print the Groups tr (assume there is no $info->backup_groups)
         echo "<tr>";
         echo "<td align=\"right\" colspan=\"2\"><b>";
-        $helplink = $OUTPUT->help_icon(moodle_help_icon::make('grouprestore', get_string('groups')));
+        $helplink = $OUTPUT->help_icon('grouprestore', get_string('groups'));
         echo '<label for="menurestore_groups">'.get_string ("groups").'</label>'.$helplink;
         echo "</b></td><td colspan=\"2\">";
         if (empty($CFG->enablegroupings)) {

diff --git a/blocks/search_forums/block_search_forums.php b/blocks/search_forums/block_search_forums.php
@@ -36,7 +36,7 @@ function get_content() {
                                 '<input id="searchform_search" name="search" type="text" size="16" />';
         $this->content->text .= '<button id="searchform_button" type="submit" title="'.$search.'">'.$button.'</button><br />';
         $this->content->text .= '<a href="'.$CFG->wwwroot.'/mod/forum/search.php?id='.$this->page->course->id.'">'.$advancedsearch.'</a>';
-        $this->content->text .= $OUTPUT->help_icon(moodle_help_icon::make('search', $advancedsearch));
+        $this->content->text .= $OUTPUT->help_icon('search', $advancedsearch);
         $this->content->text .= '</fieldset></form></div>';
 
         return $this->content;

diff --git a/blocks/tags/block_tags.php b/blocks/tags/block_tags.php
@@ -232,7 +232,7 @@ function get_content() {
                     $tagthisunit = get_string('tagthisunit', $tagslang);
                     $buttonadd = get_string('add', $tagslang);
                     $arrowtitle = get_string('arrowtitle', $tagslang);
-                    $coursetaghelpbutton = $OUTPUT->help_icon(moodle_help_icon::make('addtags', 'adding tags', $tagslang));
+                    $coursetaghelpbutton = $OUTPUT->help_icon('addtags', 'adding tags', $tagslang);
                     $sesskey = sesskey();
                     $arrowright = $OUTPUT->pix_url('t/arrow_left');
                     $this->content->footer .= <<<EOT

diff --git a/course/editsection.php b/course/editsection.php
@@ -79,10 +79,7 @@
 $PAGE->set_focuscontrol('theform.summary');
 echo $OUTPUT->header();
 
-$helpicon = new moodle_help_icon();
-$helpicon->text = $strsummaryof;
-$helpicon->page = 'summaries';
-echo $OUTPUT->heading_with_help($helpicon);
+echo $OUTPUT->heading_with_help($strsummaryof, 'summaries');
 
 $mform->display();
 echo $OUTPUT->footer();
diff --git a/course/import/groups/mod.php b/course/import/groups/mod.php
@@ -35,10 +35,7 @@
 $strusersnew = get_string("usersnew");
 $strimportgroups = get_string("importgroups");
 
-$helpicon = new moodle_help_icon();
-$helpicon->text = $strimportgroups;
-$helpicon->page = 'uploadgroups';
-echo $OUTPUT->heading_with_help($helpicon);
+echo $OUTPUT->heading_with_help($strimportgroups, 'uploadgroups');
 
 $maxuploadsize = get_max_upload_file_size();
 echo '<p align="center">';

diff --git a/course/lib.php b/course/lib.php
@@ -3026,7 +3026,7 @@ function print_groupmode_setting($form, $course=NULL) {
         $select = html_select::make($choices, 'groupmode', $groupmode, false);
         $select->disabled = $course->groupmodeforce;
         echo $OUTPUT->select($select);
-        echo $OUTPUT->help_icon(moodle_help_icon::make('groupmode', get_string('groupmode')));
+        echo $OUTPUT->help_icon('groupmode', get_string('groupmode'));
         echo '</td></tr>';
     }
 }

diff --git a/course/modedit.php b/course/modedit.php
@@ -616,11 +616,7 @@
             require($CFG->dirroot.'/'.$CFG->admin.'/roles/tabs.php');
         }
 
-        $helpicon = new moodle_help_icon();
-        $helpicon->page = 'mods';
-        $helpicon->text = $pageheading;
-        $helpicon->module = $module->name;
-        echo $OUTPUT->heading_with_help($helpicon, $OUTPUT->pix_url('icon', $module->name));
+        echo $OUTPUT->heading_with_help($pageheading, 'mods', $module->name, 'icon');
 
         $mform->display();
 

diff --git a/course/report/participation/index.php b/course/report/participation/index.php
@@ -126,7 +126,7 @@
     echo $OUTPUT->select(html_select::make($roleoptions,'roleid',$roleid,false));
     echo '<label for="menuaction">'.get_string('showactions').'</label>'."\n";
     echo $OUTPUT->select(html_select::make($actionoptions,'action',$action,false));
-    echo $OUTPUT->help_icon(moodle_help_icon::make('participationreport',get_string('participationreport')));
+    echo $OUTPUT->help_icon('participationreport', get_string('participationreport'));
     echo '<input type="submit" value="'.get_string('go').'" />'."\n</div></form>\n";
 
     $baseurl =  $CFG->wwwroot.'/course/report/participation/index.php?id='.$course->id.'&amp;roleid='
@@ -281,7 +281,7 @@
         $select->label = get_string("withselectedusers");
         $select->add_action('change', 'conditionalsubmit', array('formid' => 'studentsform'));
         echo $OUTPUT->select($select);
-        echo $OUTPUT->help_icon(moodle_help_icon::make("participantswithselectedusers", get_string("withselectedusers")));
+        echo $OUTPUT->help_icon("participantswithselectedusers", get_string("withselectedusers"));
         echo '<input type="submit" value="' . get_string('ok') . '" />'."\n";
         echo '</div>'."\n";
         echo '</form>'."\n";

diff --git a/enrol/authorize/config_form.php b/enrol/authorize/config_form.php
@@ -131,7 +131,7 @@
 <tr valign="top">
     <td align="right">an_authcode:</td>
     <td><?php echo $OUTPUT->checkbox(html_select_option::make_checkbox('1', !empty($frm->an_authcode), get_string("adminauthcode", "enrol_authorize")), 'an_authcode');  ?>
-        <?php echo $OUTPUT->help_icon(moodle_help_icon::make('authorize/authcode', 'authcode', 'enrol')); ?><br />
+        <?php echo $OUTPUT->help_icon('authorize/authcode', 'authcode', 'enrol'); ?><br />
     </td>
 </tr>
 
@@ -177,20 +177,20 @@
 </tr>
 
 <tr valign="top"><td colspan="2"><h4><?php print_string("adminauthorizeccapture", "enrol_authorize") ?>
-                                     <?php echo $OUTPUT->help_icon(moodle_help_icon::make('authorize/orderreview', 'orderreview', 'enrol')); ?>
+                                     <?php echo $OUTPUT->help_icon('authorize/orderreview', 'orderreview', 'enrol'); ?>
                                  </h4></td></tr>
 
 <tr valign="top">
     <td align="right">an_review:</td>
     <td><?php echo $OUTPUT->checkbox(html_select_option::make_checkbox('1', !empty($frm->an_review), get_string("adminreview", "enrol_authorize")), 'an_review'); ?>
-        <?php echo $OUTPUT->help_icon(moodle_help_icon::make('authorize/review', get_string('adminhelpreviewtitle', 'enrol_authorize'), 'enrol')); ?><br />
+        <?php echo $OUTPUT->help_icon('authorize/review', get_string('adminhelpreviewtitle', 'enrol_authorize'), 'enrol'); ?><br />
     </td>
 </tr>
 
 <tr valign="top">
     <td align="right">an_capture_day:</td>
     <td><input type="text" name="an_capture_day" size="2" maxlength="2" value="<?php p($frm->an_capture_day) ?>" />
-        <?php echo $OUTPUT->help_icon(moodle_help_icon::make('authorize/captureday', get_string('adminhelpcapturetitle', 'enrol_authorize'), 'enrol')); ?><br />
+        <?php echo $OUTPUT->help_icon('authorize/captureday', get_string('adminhelpcapturetitle', 'enrol_authorize'), 'enrol'); ?><br />
         <?php print_string("reviewday", "enrol_authorize", $frm->an_capture_day) ?></td>
 </tr>
 

diff --git a/enrol/authorize/uploadcsv.php b/enrol/authorize/uploadcsv.php
@@ -23,11 +23,7 @@
     $PAGE->set_button($managebutton);
     echo $OUTPUT->header();
 
-    $helpicon = new moodle_help_icon();
-    $helpicon->text = $struploadcsv;
-    $helpicon->page = 'authorize/uploadcsv';
-    $helpicon->module = 'enrol';
-    echo $OUTPUT->heading_with_help($helpicon);
+    echo $OUTPUT->heading_with_help($struploadcsv, 'authorize/uploadcsv', 'enrol');
 
 /// Handle CSV file
     if (($form = data_submitted()) && confirm_sesskey()) {