Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.

Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401]

   1  <?php
   2  
   3  // This file defines settingpages and externalpages under the "grades" section
   4  
   5  if (has_capability('moodle/grade:manage', $systemcontext)
   6   or has_capability('moodle/grade:manageletters', $systemcontext)) { // speedup for non-admins, add all caps used on this page
   7  
   8      require_once $CFG->libdir.'/grade/constants.php';
   9      $display_types = array(GRADE_DISPLAY_TYPE_REAL => new lang_string('real', 'grades'),
  10                             GRADE_DISPLAY_TYPE_PERCENTAGE => new lang_string('percentage', 'grades'),
  11                             GRADE_DISPLAY_TYPE_LETTER => new lang_string('letter', 'grades'),
  12                             GRADE_DISPLAY_TYPE_REAL_PERCENTAGE => new lang_string('realpercentage', 'grades'),
  13                             GRADE_DISPLAY_TYPE_REAL_LETTER => new lang_string('realletter', 'grades'),
  14                             GRADE_DISPLAY_TYPE_LETTER_REAL => new lang_string('letterreal', 'grades'),
  15                             GRADE_DISPLAY_TYPE_LETTER_PERCENTAGE => new lang_string('letterpercentage', 'grades'),
  16                             GRADE_DISPLAY_TYPE_PERCENTAGE_LETTER => new lang_string('percentageletter', 'grades'),
  17                             GRADE_DISPLAY_TYPE_PERCENTAGE_REAL => new lang_string('percentagereal', 'grades')
  18                             );
  19      asort($display_types);
  20  
  21      // General settings
  22  
  23      $temp = new admin_settingpage('gradessettings', new lang_string('generalsettings', 'grades'), 'moodle/grade:manage');
  24      if ($ADMIN->fulltree) {
  25  
  26          // new CFG variable for gradebook (what roles to display)
  27          $temp->add(new admin_setting_special_gradebookroles());
  28  
  29          // enable outcomes checkbox now in subsystems area
  30  
  31          $temp->add(new admin_setting_grade_profilereport());
  32  
  33          $temp->add(new admin_setting_configselect('grade_aggregationposition', new lang_string('aggregationposition', 'grades'),
  34                                                    new lang_string('aggregationposition_help', 'grades'), GRADE_REPORT_AGGREGATION_POSITION_LAST,
  35                                                    array(GRADE_REPORT_AGGREGATION_POSITION_FIRST => new lang_string('positionfirst', 'grades'),
  36                                                          GRADE_REPORT_AGGREGATION_POSITION_LAST => new lang_string('positionlast', 'grades'))));
  37  
  38          $temp->add(new admin_setting_regradingcheckbox('grade_includescalesinaggregation', new lang_string('includescalesinaggregation', 'grades'), new lang_string('includescalesinaggregation_help', 'grades'), 1));
  39  
  40          $temp->add(new admin_setting_configcheckbox('grade_hiddenasdate', new lang_string('hiddenasdate', 'grades'), new lang_string('hiddenasdate_help', 'grades'), 0));
  41  
  42          // enable publishing in exports/imports
  43          $temp->add(new admin_setting_configcheckbox('gradepublishing', new lang_string('gradepublishing', 'grades'), new lang_string('gradepublishing_help', 'grades'), 0));
  44  
  45          $temp->add(new admin_setting_configcheckbox('grade_export_exportfeedback', new lang_string('exportfeedback', 'grades'),
  46                                                    new lang_string('exportfeedback_desc', 'grades'), 0));
  47  
  48          $temp->add(new admin_setting_configselect('grade_export_displaytype', new lang_string('gradeexportdisplaytype', 'grades'),
  49                                                    new lang_string('gradeexportdisplaytype_desc', 'grades'), GRADE_DISPLAY_TYPE_REAL, $display_types));
  50  
  51          $temp->add(new admin_setting_configselect('grade_export_decimalpoints', new lang_string('gradeexportdecimalpoints', 'grades'),
  52                                                    new lang_string('gradeexportdecimalpoints_desc', 'grades'), 2,
  53                                                    array( '0' => '0',
  54                                                           '1' => '1',
  55                                                           '2' => '2',
  56                                                           '3' => '3',
  57                                                           '4' => '4',
  58                                                           '5' => '5')));
  59  
  60          $setting = new admin_setting_configtext('grade_export_userprofilefields',
  61              new lang_string('gradeexportuserprofilefields', 'grades'),
  62              new lang_string('gradeexportuserprofilefields_desc', 'grades'),
  63              'firstname,lastname,idnumber,institution,department,email', PARAM_TEXT);
  64          $setting->set_force_ltr(true);
  65          $temp->add($setting);
  66  
  67          $setting = new admin_setting_configtext('grade_export_customprofilefields',
  68              new lang_string('gradeexportcustomprofilefields', 'grades'),
  69              new lang_string('gradeexportcustomprofilefields_desc', 'grades'), '', PARAM_TEXT);
  70          $setting->set_force_ltr(true);
  71          $temp->add($setting);
  72  
  73          $temp->add(new admin_setting_configcheckbox('recovergradesdefault', new lang_string('recovergradesdefault', 'grades'), new lang_string('recovergradesdefault_help', 'grades'), 0));
  74  
  75          $temp->add(new admin_setting_special_gradeexport());
  76  
  77          $temp->add(new admin_setting_special_gradelimiting());
  78  
  79          $temp->add(new admin_setting_configcheckbox('grade_report_showmin',
  80                                                      get_string('minimum_show', 'grades'),
  81                                                      get_string('minimum_show_help', 'grades'), '1'));
  82  
  83          $temp->add(new admin_setting_special_gradepointmax());
  84  
  85          $temp->add(new admin_setting_special_gradepointdefault());
  86  
  87          $temp->add(new admin_setting_special_grademinmaxtouse());
  88  
  89          $temp->add(new admin_setting_my_grades_report());
  90  
  91          $temp->add(new admin_setting_configtext('gradereport_mygradeurl', new lang_string('externalurl', 'grades'),
  92                  new lang_string('externalurl_desc', 'grades'), ''));
  93      }
  94      $ADMIN->add('grades', $temp);
  95  
  96      /// Grade category settings
  97      $temp = new admin_settingpage('gradecategorysettings', new lang_string('gradecategorysettings', 'grades'), 'moodle/grade:manage');
  98      if ($ADMIN->fulltree) {
  99          $temp->add(new admin_setting_configcheckbox('grade_hideforcedsettings', new lang_string('hideforcedsettings', 'grades'), new lang_string('hideforcedsettings_help', 'grades'), '1'));
 100  
 101          $strnoforce = new lang_string('noforce', 'grades');
 102  
 103          // Aggregation type
 104          $options = array(GRADE_AGGREGATE_MEAN            =>new lang_string('aggregatemean', 'grades'),
 105                           GRADE_AGGREGATE_WEIGHTED_MEAN   =>new lang_string('aggregateweightedmean', 'grades'),
 106                           GRADE_AGGREGATE_WEIGHTED_MEAN2  =>new lang_string('aggregateweightedmean2', 'grades'),
 107                           GRADE_AGGREGATE_EXTRACREDIT_MEAN=>new lang_string('aggregateextracreditmean', 'grades'),
 108                           GRADE_AGGREGATE_MEDIAN          =>new lang_string('aggregatemedian', 'grades'),
 109                           GRADE_AGGREGATE_MIN             =>new lang_string('aggregatemin', 'grades'),
 110                           GRADE_AGGREGATE_MAX             =>new lang_string('aggregatemax', 'grades'),
 111                           GRADE_AGGREGATE_MODE            =>new lang_string('aggregatemode', 'grades'),
 112                           GRADE_AGGREGATE_SUM             =>new lang_string('aggregatesum', 'grades'));
 113  
 114          $defaultvisible = array(GRADE_AGGREGATE_SUM);
 115  
 116          $defaults = array('value' => GRADE_AGGREGATE_SUM, 'forced' => false, 'adv' => false);
 117          $temp->add(new admin_setting_gradecat_combo('grade_aggregation', new lang_string('aggregation', 'grades'), new lang_string('aggregation_help', 'grades'), $defaults, $options));
 118  
 119          $temp->add(new admin_setting_configmultiselect('grade_aggregations_visible', new lang_string('aggregationsvisible', 'grades'),
 120                                                         new lang_string('aggregationsvisiblehelp', 'grades'), $defaultvisible, $options));
 121  
 122          $options = array(0 => new lang_string('no'), 1 => new lang_string('yes'));
 123  
 124          $defaults = array('value'=>1, 'forced'=>false, 'adv'=>true);
 125          $temp->add(new admin_setting_gradecat_combo('grade_aggregateonlygraded', new lang_string('aggregateonlygraded', 'grades'),
 126                      new lang_string('aggregateonlygraded_help', 'grades'), $defaults, $options));
 127          $defaults = array('value'=>0, 'forced'=>false, 'adv'=>true);
 128          $temp->add(new admin_setting_gradecat_combo('grade_aggregateoutcomes', new lang_string('aggregateoutcomes', 'grades'),
 129                      new lang_string('aggregateoutcomes_help', 'grades'), $defaults, $options));
 130  
 131          $options = array(0 => new lang_string('none'));
 132          for ($i=1; $i<=20; $i++) {
 133              $options[$i] = $i;
 134          }
 135  
 136          $defaults['value'] = 0;
 137          $defaults['forced'] = true;
 138          $temp->add(new admin_setting_gradecat_combo('grade_keephigh', new lang_string('keephigh', 'grades'),
 139                      new lang_string('keephigh_help', 'grades'), $defaults, $options));
 140          $defaults['forced'] = false;
 141          $temp->add(new admin_setting_gradecat_combo('grade_droplow', new lang_string('droplow', 'grades'),
 142                      new lang_string('droplow_help', 'grades'), $defaults, $options));
 143  
 144          $temp->add(new admin_setting_configcheckbox('grade_overridecat', new lang_string('overridecat', 'grades'),
 145                     new lang_string('overridecat_help', 'grades'), 1));
 146      }
 147      $ADMIN->add('grades', $temp);
 148  
 149  
 150      /// Grade item settings
 151      $temp = new admin_settingpage('gradeitemsettings', new lang_string('gradeitemsettings', 'grades'), 'moodle/grade:manage');
 152      if ($ADMIN->fulltree) {
 153          $temp->add(new admin_setting_configselect('grade_displaytype', new lang_string('gradedisplaytype', 'grades'),
 154                                                    new lang_string('gradedisplaytype_help', 'grades'), GRADE_DISPLAY_TYPE_REAL, $display_types));
 155  
 156          $temp->add(new admin_setting_configselect('grade_decimalpoints', new lang_string('decimalpoints', 'grades'),
 157                                                    new lang_string('decimalpoints_help', 'grades'), 2,
 158                                                    array( '0' => '0',
 159                                                           '1' => '1',
 160                                                           '2' => '2',
 161                                                           '3' => '3',
 162                                                           '4' => '4',
 163                                                           '5' => '5')));
 164  
 165          $temp->add(new admin_setting_configmultiselect('grade_item_advanced', new lang_string('gradeitemadvanced', 'grades'), new lang_string('gradeitemadvanced_help', 'grades'),
 166                                                         array('iteminfo', 'idnumber', 'gradepass', 'plusfactor', 'multfactor', 'display', 'decimals', 'hiddenuntil', 'locktime'),
 167                                                         array('iteminfo' => new lang_string('iteminfo', 'grades'),
 168                                                               'idnumber' => new lang_string('idnumbermod'),
 169                                                               'gradetype' => new lang_string('gradetype', 'grades'),
 170                                                               'scaleid' => new lang_string('scale'),
 171                                                               'grademin' => new lang_string('grademin', 'grades'),
 172                                                               'grademax' => new lang_string('grademax', 'grades'),
 173                                                               'gradepass' => new lang_string('gradepass', 'grades'),
 174                                                               'plusfactor' => new lang_string('plusfactor', 'grades'),
 175                                                               'multfactor' => new lang_string('multfactor', 'grades'),
 176                                                               'display' => new lang_string('gradedisplaytype', 'grades'),
 177                                                               'decimals' => new lang_string('decimalpoints', 'grades'),
 178                                                               'hidden' => new lang_string('hidden', 'grades'),
 179                                                               'hiddenuntil' => new lang_string('hiddenuntil', 'grades'),
 180                                                               'locked' => new lang_string('locked', 'grades'),
 181                                                               'locktime' => new lang_string('locktime', 'grades'),
 182                                                               'aggregationcoef' => new lang_string('aggregationcoef', 'grades'),
 183                                                               'parentcategory' => new lang_string('parentcategory', 'grades'))));
 184      }
 185      $ADMIN->add('grades', $temp);
 186  
 187  
 188      /// Scales and outcomes
 189  
 190      $scales = new admin_externalpage('scales', new lang_string('scales'), $CFG->wwwroot.'/grade/edit/scale/index.php', 'moodle/grade:manage');
 191      $ADMIN->add('grades', $scales);
 192      if (!empty($CFG->enableoutcomes)) {
 193          $outcomes = new admin_externalpage('outcomes', new lang_string('outcomes', 'grades'), $CFG->wwwroot.'/grade/edit/outcome/index.php', 'moodle/grade:manage');
 194          $ADMIN->add('grades', $outcomes);
 195      }
 196      $letters = new admin_externalpage('letters', new lang_string('letters', 'grades'), $CFG->wwwroot.'/grade/edit/letter/index.php', 'moodle/grade:manageletters');
 197      $ADMIN->add('grades', $letters);
 198  
 199      // The plugins must implement a settings.php file that adds their admin settings to the $settings object
 200  
 201      // Reports
 202      $ADMIN->add('grades', new admin_category('gradereports', new lang_string('reportsettings', 'grades')));
 203      foreach (core_component::get_plugin_list('gradereport') as $plugin => $plugindir) {
 204       // Include all the settings commands for this plugin if there are any
 205          if (file_exists($plugindir.'/settings.php')) {
 206              $settings = new admin_settingpage('gradereport'.$plugin, new lang_string('pluginname', 'gradereport_'.$plugin), 'moodle/grade:manage');
 207              include($plugindir.'/settings.php');
 208              if ($settings) {
 209                  $ADMIN->add('gradereports', $settings);
 210              }
 211          }
 212      }
 213  
 214      // Imports
 215      $ADMIN->add('grades', new admin_category('gradeimports', new lang_string('importsettings', 'grades')));
 216      foreach (core_component::get_plugin_list('gradeimport') as $plugin => $plugindir) {
 217  
 218       // Include all the settings commands for this plugin if there are any
 219          if (file_exists($plugindir.'/settings.php')) {
 220              $settings = new admin_settingpage('gradeimport'.$plugin, new lang_string('pluginname', 'gradeimport_'.$plugin), 'moodle/grade:manage');
 221              include($plugindir.'/settings.php');
 222              if ($settings) {
 223                  $ADMIN->add('gradeimports', $settings);
 224              }
 225          }
 226      }
 227  
 228  
 229      // Exports
 230      $ADMIN->add('grades', new admin_category('gradeexports', new lang_string('exportsettings', 'grades')));
 231      foreach (core_component::get_plugin_list('gradeexport') as $plugin => $plugindir) {
 232       // Include all the settings commands for this plugin if there are any
 233          if (file_exists($plugindir.'/settings.php')) {
 234              $settings = new admin_settingpage('gradeexport'.$plugin, new lang_string('pluginname', 'gradeexport_'.$plugin), 'moodle/grade:manage');
 235              include($plugindir.'/settings.php');
 236              if ($settings) {
 237                  $ADMIN->add('gradeexports', $settings);
 238              }
 239          }
 240      }
 241  
 242  } // end of speedup
 243