Search moodle.org's
Developer Documentation

   1  <?php
   2  // This file is part of Moodle - http://moodle.org/
   3  //
   4  // Moodle is free software: you can redistribute it and/or modify
   5  // it under the terms of the GNU General Public License as published by
   6  // the Free Software Foundation, either version 3 of the License, or
   7  // (at your option) any later version.
   8  //
   9  // Moodle is distributed in the hope that it will be useful,
  10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  // GNU General Public License for more details.
  13  //
  14  // You should have received a copy of the GNU General Public License
  15  // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16  
  17  if (!defined('MOODLE_INTERNAL')) {
  18      die('Direct access to this script is forbidden.');    //  It must be included from a Moodle page.
  19  }
  20  
  21  require_once($CFG->dirroot.'/course/moodleform_mod.php');
  22  require_once($CFG->dirroot.'/mod/scorm/locallib.php');
  23  
  24  class mod_scorm_mod_form extends moodleform_mod {
  25  
  26      public function definition() {
  27          global $CFG, $COURSE, $OUTPUT;
  28          $cfgscorm = get_config('scorm');
  29  
  30          $mform = $this->_form;
  31  
  32          if (!$CFG->slasharguments) {
  33              $mform->addElement('static', '', '', $OUTPUT->notification(get_string('slashargs', 'scorm'), 'notifyproblem'));
  34          }
  35  
  36          $mform->addElement('header', 'general', get_string('general', 'form'));
  37  
  38          // Name.
  39          $mform->addElement('text', 'name', get_string('name'));
  40          if (!empty($CFG->formatstringstriptags)) {
  41              $mform->setType('name', PARAM_TEXT);
  42          } else {
  43              $mform->setType('name', PARAM_CLEANHTML);
  44          }
  45          $mform->addRule('name', null, 'required', null, 'client');
  46          $mform->addRule('name', get_string('maximumchars', '', 255), 'maxlength', 255, 'client');
  47  
  48          // Summary.
  49          $this->add_intro_editor(true);
  50  
  51          // Package.
  52          $mform->addElement('header', 'packagehdr', get_string('packagehdr', 'scorm'));
  53          $mform->setExpanded('packagehdr', true);
  54  
  55          // Scorm types.
  56          $scormtypes = array(SCORM_TYPE_LOCAL => get_string('typelocal', 'scorm'));
  57  
  58          if ($cfgscorm->allowtypeexternal) {
  59              $scormtypes[SCORM_TYPE_EXTERNAL] = get_string('typeexternal', 'scorm');
  60          }
  61  
  62          if ($cfgscorm->allowtypelocalsync) {
  63              $scormtypes[SCORM_TYPE_LOCALSYNC] = get_string('typelocalsync', 'scorm');
  64          }
  65  
  66          if ($cfgscorm->allowtypeexternalaicc) {
  67              $scormtypes[SCORM_TYPE_AICCURL] = get_string('typeaiccurl', 'scorm');
  68          }
  69  
  70          // Reference.
  71          if (count($scormtypes) > 1) {
  72              $mform->addElement('select', 'scormtype', get_string('scormtype', 'scorm'), $scormtypes);
  73              $mform->setType('scormtype', PARAM_ALPHA);
  74              $mform->addHelpButton('scormtype', 'scormtype', 'scorm');
  75              $mform->addElement('text', 'packageurl', get_string('packageurl', 'scorm'), array('size' => 60));
  76              $mform->setType('packageurl', PARAM_RAW);
  77              $mform->addHelpButton('packageurl', 'packageurl', 'scorm');
  78              $mform->disabledIf('packageurl', 'scormtype', 'eq', SCORM_TYPE_LOCAL);
  79          } else {
  80              $mform->addElement('hidden', 'scormtype', SCORM_TYPE_LOCAL);
  81              $mform->setType('scormtype', PARAM_ALPHA);
  82          }
  83  
  84          // New local package upload.
  85          $filemanageroptions = array();
  86          $filemanageroptions['accepted_types'] = array('.zip', '.xml');
  87          $filemanageroptions['maxbytes'] = 0;
  88          $filemanageroptions['maxfiles'] = 1;
  89          $filemanageroptions['subdirs'] = 0;
  90  
  91          $mform->addElement('filemanager', 'packagefile', get_string('package', 'scorm'), null, $filemanageroptions);
  92          $mform->addHelpButton('packagefile', 'package', 'scorm');
  93          $mform->disabledIf('packagefile', 'scormtype', 'noteq', SCORM_TYPE_LOCAL);
  94  
  95          // Update packages timing.
  96          $mform->addElement('select', 'updatefreq', get_string('updatefreq', 'scorm'), scorm_get_updatefreq_array());
  97          $mform->setType('updatefreq', PARAM_INT);
  98          $mform->setDefault('updatefreq', $cfgscorm->updatefreq);
  99          $mform->addHelpButton('updatefreq', 'updatefreq', 'scorm');
 100  
 101          // Display Settings.
 102          $mform->addElement('header', 'displaysettings', get_string('appearance'));
 103  
 104          // Framed / Popup Window.
 105          $mform->addElement('select', 'popup', get_string('display', 'scorm'), scorm_get_popup_display_array());
 106          $mform->setDefault('popup', $cfgscorm->popup);
 107          $mform->setAdvanced('popup', $cfgscorm->popup_adv);
 108  
 109          // Width.
 110          $mform->addElement('text', 'width', get_string('width', 'scorm'), 'maxlength="5" size="5"');
 111          $mform->setDefault('width', $cfgscorm->framewidth);
 112          $mform->setType('width', PARAM_INT);
 113          $mform->setAdvanced('width', $cfgscorm->framewidth_adv);
 114          $mform->disabledIf('width', 'popup', 'eq', 0);
 115  
 116          // Height.
 117          $mform->addElement('text', 'height', get_string('height', 'scorm'), 'maxlength="5" size="5"');
 118          $mform->setDefault('height', $cfgscorm->frameheight);
 119          $mform->setType('height', PARAM_INT);
 120          $mform->setAdvanced('height', $cfgscorm->frameheight_adv);
 121          $mform->disabledIf('height', 'popup', 'eq', 0);
 122  
 123          // Window Options.
 124          $winoptgrp = array();
 125          foreach (scorm_get_popup_options_array() as $key => $value) {
 126              $winoptgrp[] = &$mform->createElement('checkbox', $key, '', get_string($key, 'scorm'));
 127              $mform->setDefault($key, $value);
 128          }
 129          $mform->addGroup($winoptgrp, 'winoptgrp', get_string('options', 'scorm'), '<br />', false);
 130          $mform->disabledIf('winoptgrp', 'popup', 'eq', 0);
 131          $mform->setAdvanced('winoptgrp', $cfgscorm->winoptgrp_adv);
 132  
 133          // Display activity name.
 134          $mform->addElement('advcheckbox', 'displayactivityname', get_string('displayactivityname', 'scorm'));
 135          $mform->addHelpButton('displayactivityname', 'displayactivityname', 'scorm');
 136          $mform->setDefault('displayactivityname', $cfgscorm->displayactivityname);
 137  
 138          // Skip view page.
 139          $skipviewoptions = scorm_get_skip_view_array();
 140          if ($COURSE->format == 'singleactivity') { // Remove option that would cause a constant redirect.
 141              unset($skipviewoptions[SCORM_SKIPVIEW_ALWAYS]);
 142              if ($cfgscorm->skipview == SCORM_SKIPVIEW_ALWAYS) {
 143                  $cfgscorm->skipview = SCORM_SKIPVIEW_FIRST;
 144              }
 145          }
 146          $mform->addElement('select', 'skipview', get_string('skipview', 'scorm'), $skipviewoptions);
 147          $mform->addHelpButton('skipview', 'skipview', 'scorm');
 148          $mform->setDefault('skipview', $cfgscorm->skipview);
 149          $mform->setAdvanced('skipview', $cfgscorm->skipview_adv);
 150  
 151          // Hide Browse.
 152          $mform->addElement('selectyesno', 'hidebrowse', get_string('hidebrowse', 'scorm'));
 153          $mform->addHelpButton('hidebrowse', 'hidebrowse', 'scorm');
 154          $mform->setDefault('hidebrowse', $cfgscorm->hidebrowse);
 155          $mform->setAdvanced('hidebrowse', $cfgscorm->hidebrowse_adv);
 156  
 157          // Display course structure.
 158          $mform->addElement('selectyesno', 'displaycoursestructure', get_string('displaycoursestructure', 'scorm'));
 159          $mform->addHelpButton('displaycoursestructure', 'displaycoursestructure', 'scorm');
 160          $mform->setDefault('displaycoursestructure', $cfgscorm->displaycoursestructure);
 161          $mform->setAdvanced('displaycoursestructure', $cfgscorm->displaycoursestructure_adv);
 162  
 163          // Toc display.
 164          $mform->addElement('select', 'hidetoc', get_string('hidetoc', 'scorm'), scorm_get_hidetoc_array());
 165          $mform->addHelpButton('hidetoc', 'hidetoc', 'scorm');
 166          $mform->setDefault('hidetoc', $cfgscorm->hidetoc);
 167          $mform->setAdvanced('hidetoc', $cfgscorm->hidetoc_adv);
 168          $mform->disabledIf('hidetoc', 'scormtype', 'eq', SCORM_TYPE_AICCURL);
 169  
 170          // Navigation panel display.
 171          $mform->addElement('select', 'nav', get_string('nav', 'scorm'), scorm_get_navigation_display_array());
 172          $mform->addHelpButton('nav', 'nav', 'scorm');
 173          $mform->setDefault('nav', $cfgscorm->nav);
 174          $mform->setAdvanced('nav', $cfgscorm->nav_adv);
 175          $mform->disabledIf('nav', 'hidetoc', 'noteq', SCORM_TOC_SIDE);
 176  
 177          // Navigation panel position from left.
 178          $mform->addElement('text', 'navpositionleft', get_string('fromleft', 'scorm'), 'maxlength="5" size="5"');
 179          $mform->setDefault('navpositionleft', $cfgscorm->navpositionleft);
 180          $mform->setType('navpositionleft', PARAM_INT);
 181          $mform->setAdvanced('navpositionleft', $cfgscorm->navpositionleft_adv);
 182          $mform->disabledIf('navpositionleft', 'hidetoc', 'noteq', SCORM_TOC_SIDE);
 183          $mform->disabledIf('navpositionleft', 'nav', 'noteq', SCORM_NAV_FLOATING);
 184  
 185          // Navigation panel position from top.
 186          $mform->addElement('text', 'navpositiontop', get_string('fromtop', 'scorm'), 'maxlength="5" size="5"');
 187          $mform->setDefault('navpositiontop', $cfgscorm->navpositiontop);
 188          $mform->setType('navpositiontop', PARAM_INT);
 189          $mform->setAdvanced('navpositiontop', $cfgscorm->navpositiontop_adv);
 190          $mform->disabledIf('navpositiontop', 'hidetoc', 'noteq', SCORM_TOC_SIDE);
 191          $mform->disabledIf('navpositiontop', 'nav', 'noteq', SCORM_NAV_FLOATING);
 192  
 193          // Display attempt status.
 194          $mform->addElement('select', 'displayattemptstatus', get_string('displayattemptstatus', 'scorm'),
 195                             scorm_get_attemptstatus_array());
 196          $mform->addHelpButton('displayattemptstatus', 'displayattemptstatus', 'scorm');
 197          $mform->setDefault('displayattemptstatus', $cfgscorm->displayattemptstatus);
 198          $mform->setAdvanced('displayattemptstatus', $cfgscorm->displayattemptstatus_adv);
 199  
 200          // Availability.
 201          $mform->addElement('header', 'availability', get_string('availability'));
 202  
 203          $mform->addElement('date_time_selector', 'timeopen', get_string("scormopen", "scorm"), array('optional' => true));
 204          $mform->addElement('date_time_selector', 'timeclose', get_string("scormclose", "scorm"), array('optional' => true));
 205  
 206          // Grade Settings.
 207          $mform->addElement('header', 'gradesettings', get_string('grade'));
 208  
 209          // Grade Method.
 210          $mform->addElement('select', 'grademethod', get_string('grademethod', 'scorm'), scorm_get_grade_method_array());
 211          $mform->addHelpButton('grademethod', 'grademethod', 'scorm');
 212          $mform->setDefault('grademethod', $cfgscorm->grademethod);
 213  
 214          // Maximum Grade.
 215          for ($i = 0; $i <= 100; $i++) {
 216              $grades[$i] = "$i";
 217          }
 218          $mform->addElement('select', 'maxgrade', get_string('maximumgrade'), $grades);
 219          $mform->setDefault('maxgrade', $cfgscorm->maxgrade);
 220          $mform->disabledIf('maxgrade', 'grademethod', 'eq', GRADESCOES);
 221  
 222          // Attempts management.
 223          $mform->addElement('header', 'attemptsmanagementhdr', get_string('attemptsmanagement', 'scorm'));
 224  
 225          // Max Attempts.
 226          $mform->addElement('select', 'maxattempt', get_string('maximumattempts', 'scorm'), scorm_get_attempts_array());
 227          $mform->addHelpButton('maxattempt', 'maximumattempts', 'scorm');
 228          $mform->setDefault('maxattempt', $cfgscorm->maxattempt);
 229  
 230          // What Grade.
 231          $mform->addElement('select', 'whatgrade', get_string('whatgrade', 'scorm'),  scorm_get_what_grade_array());
 232          $mform->disabledIf('whatgrade', 'maxattempt', 'eq', 1);
 233          $mform->addHelpButton('whatgrade', 'whatgrade', 'scorm');
 234          $mform->setDefault('whatgrade', $cfgscorm->whatgrade);
 235  
 236          // Force new attempt.
 237          $mform->addElement('selectyesno', 'forcenewattempt', get_string('forcenewattempt', 'scorm'));
 238          $mform->addHelpButton('forcenewattempt', 'forcenewattempt', 'scorm');
 239          $mform->setDefault('forcenewattempt', $cfgscorm->forcenewattempt);
 240  
 241          // Last attempt lock - lock the enter button after the last available attempt has been made.
 242          $mform->addElement('selectyesno', 'lastattemptlock', get_string('lastattemptlock', 'scorm'));
 243          $mform->addHelpButton('lastattemptlock', 'lastattemptlock', 'scorm');
 244          $mform->setDefault('lastattemptlock', $cfgscorm->lastattemptlock);
 245  
 246          // Compatibility settings.
 247          $mform->addElement('header', 'compatibilitysettingshdr', get_string('compatibilitysettings', 'scorm'));
 248  
 249          // Force completed.
 250          $mform->addElement('selectyesno', 'forcecompleted', get_string('forcecompleted', 'scorm'));
 251          $mform->addHelpButton('forcecompleted', 'forcecompleted', 'scorm');
 252          $mform->setDefault('forcecompleted', $cfgscorm->forcecompleted);
 253  
 254          // Autocontinue.
 255          $mform->addElement('selectyesno', 'auto', get_string('autocontinue', 'scorm'));
 256          $mform->addHelpButton('auto', 'autocontinue', 'scorm');
 257          $mform->setDefault('auto', $cfgscorm->auto);
 258  
 259          // Autocommit.
 260          $mform->addElement('selectyesno', 'autocommit', get_string('autocommit', 'scorm'));
 261          $mform->addHelpButton('autocommit', 'autocommit', 'scorm');
 262          $mform->setDefault('autocommit', $cfgscorm->autocommit);
 263  
 264          // Hidden Settings.
 265          $mform->addElement('hidden', 'datadir', null);
 266          $mform->setType('datadir', PARAM_RAW);
 267          $mform->addElement('hidden', 'pkgtype', null);
 268          $mform->setType('pkgtype', PARAM_RAW);
 269          $mform->addElement('hidden', 'launch', null);
 270          $mform->setType('launch', PARAM_RAW);
 271          $mform->addElement('hidden', 'redirect', null);
 272          $mform->setType('redirect', PARAM_RAW);
 273          $mform->addElement('hidden', 'redirecturl', null);
 274          $mform->setType('redirecturl', PARAM_RAW);
 275  
 276          $this->standard_coursemodule_elements();
 277  
 278          // Buttons.
 279          $this->add_action_buttons();
 280      }
 281  
 282      public function data_preprocessing(&$defaultvalues) {
 283          global $COURSE;
 284  
 285          if (isset($defaultvalues['popup']) && ($defaultvalues['popup'] == 1) && isset($defaultvalues['options'])) {
 286              if (!empty($defaultvalues['options'])) {
 287                  $options = explode(',', $defaultvalues['options']);
 288                  foreach ($options as $option) {
 289                      list($element, $value) = explode('=', $option);
 290                      $element = trim($element);
 291                      $defaultvalues[$element] = trim($value);
 292                  }
 293              }
 294          }
 295          if (isset($defaultvalues['grademethod'])) {
 296              $defaultvalues['grademethod'] = intval($defaultvalues['grademethod']);
 297          }
 298          if (isset($defaultvalues['width']) && (strpos($defaultvalues['width'], '%') === false)
 299                                             && ($defaultvalues['width'] <= 100)) {
 300              $defaultvalues['width'] .= '%';
 301          }
 302          if (isset($defaultvalues['width']) && (strpos($defaultvalues['height'], '%') === false)
 303                                             && ($defaultvalues['height'] <= 100)) {
 304              $defaultvalues['height'] .= '%';
 305          }
 306          $scorms = get_all_instances_in_course('scorm', $COURSE);
 307          $coursescorm = current($scorms);
 308  
 309          $draftitemid = file_get_submitted_draft_itemid('packagefile');
 310          file_prepare_draft_area($draftitemid, $this->context->id, 'mod_scorm', 'package', 0,
 311              array('subdirs' => 0, 'maxfiles' => 1));
 312          $defaultvalues['packagefile'] = $draftitemid;
 313  
 314          if (($COURSE->format == 'singleactivity') && ((count($scorms) == 0) || ($defaultvalues['instance'] == $coursescorm->id))) {
 315              $defaultvalues['redirect'] = 'yes';
 316              $defaultvalues['redirecturl'] = '../course/view.php?id='.$defaultvalues['course'];
 317          } else {
 318              $defaultvalues['redirect'] = 'no';
 319              $defaultvalues['redirecturl'] = '../mod/scorm/view.php?id='.$defaultvalues['coursemodule'];
 320          }
 321          if (isset($defaultvalues['version'])) {
 322              $defaultvalues['pkgtype'] = (substr($defaultvalues['version'], 0, 5) == 'SCORM') ? 'scorm' : 'aicc';
 323          }
 324          if (isset($defaultvalues['instance'])) {
 325              $defaultvalues['datadir'] = $defaultvalues['instance'];
 326          }
 327          if (empty($defaultvalues['timeopen'])) {
 328              $defaultvalues['timeopen'] = 0;
 329          }
 330          if (empty($defaultvalues['timeclose'])) {
 331              $defaultvalues['timeclose'] = 0;
 332          }
 333  
 334          // Set some completion default data.
 335          if (!empty($defaultvalues['completionstatusrequired']) && !is_array($defaultvalues['completionstatusrequired'])) {
 336              // Unpack values.
 337              $cvalues = array();
 338              foreach (scorm_status_options() as $key => $value) {
 339                  if (($defaultvalues['completionstatusrequired'] & $key) == $key) {
 340                      $cvalues[$key] = 1;
 341                  }
 342              }
 343  
 344              $defaultvalues['completionstatusrequired'] = $cvalues;
 345          }
 346  
 347          if (!isset($defaultvalues['completionscorerequired']) || !strlen($defaultvalues['completionscorerequired'])) {
 348              $defaultvalues['completionscoredisabled'] = 1;
 349          }
 350      }
 351  
 352      public function validation($data, $files) {
 353          global $CFG, $USER;
 354          $errors = parent::validation($data, $files);
 355  
 356          $type = $data['scormtype'];
 357  
 358          if ($type === SCORM_TYPE_LOCAL) {
 359              if (empty($data['packagefile'])) {
 360                  $errors['packagefile'] = get_string('required');
 361  
 362              } else {
 363                  $draftitemid = file_get_submitted_draft_itemid('packagefile');
 364  
 365                  file_prepare_draft_area($draftitemid, $this->context->id, 'mod_scorm', 'packagefilecheck', null,
 366                      array('subdirs' => 0, 'maxfiles' => 1));
 367  
 368                  // Get file from users draft area.
 369                  $usercontext = context_user::instance($USER->id);
 370                  $fs = get_file_storage();
 371                  $files = $fs->get_area_files($usercontext->id, 'user', 'draft', $draftitemid, 'id', false);
 372  
 373                  if (count($files) < 1) {
 374                      $errors['packagefile'] = get_string('required');
 375                      return $errors;
 376                  }
 377                  $file = reset($files);
 378                  if (!$file->is_external_file() && !empty($data['updatefreq'])) {
 379                      // Make sure updatefreq is not set if using normal local file.
 380                      $errors['updatefreq'] = get_string('updatefreq_error', 'mod_scorm');
 381                  }
 382                  if (strtolower($file->get_filename()) == 'imsmanifest.xml') {
 383                      if (!$file->is_external_file()) {
 384                          $errors['packagefile'] = get_string('aliasonly', 'mod_scorm');
 385                      } else {
 386                          $repository = repository::get_repository_by_id($file->get_repository_id(), context_system::instance());
 387                          if (!$repository->supports_relative_file()) {
 388                              $errors['packagefile'] = get_string('repositorynotsupported', 'mod_scorm');
 389                          }
 390                      }
 391                  } else if (strtolower(substr($file->get_filename(), -3)) == 'xml') {
 392                      $errors['packagefile'] = get_string('invalidmanifestname', 'mod_scorm');
 393                  } else {
 394                      // Validate this SCORM package.
 395                      $errors = array_merge($errors, scorm_validate_package($file));
 396                  }
 397              }
 398  
 399          } else if ($type === SCORM_TYPE_EXTERNAL) {
 400              $reference = $data['packageurl'];
 401              // Syntax check.
 402              if (!preg_match('/(http:\/\/|https:\/\/|www).*\/imsmanifest.xml$/i', $reference)) {
 403                  $errors['packageurl'] = get_string('invalidurl', 'scorm');
 404              } else {
 405                  // Availability check.
 406                  $result = scorm_check_url($reference);
 407                  if (is_string($result)) {
 408                      $errors['packageurl'] = $result;
 409                  }
 410              }
 411  
 412          } else if ($type === 'packageurl') {
 413              $reference = $data['reference'];
 414              // Syntax check.
 415              if (!preg_match('/(http:\/\/|https:\/\/|www).*(\.zip|\.pif)$/i', $reference)) {
 416                  $errors['packageurl'] = get_string('invalidurl', 'scorm');
 417              } else {
 418                  // Availability check.
 419                  $result = scorm_check_url($reference);
 420                  if (is_string($result)) {
 421                      $errors['packageurl'] = $result;
 422                  }
 423              }
 424  
 425          } else if ($type === SCORM_TYPE_AICCURL) {
 426              $reference = $data['packageurl'];
 427              // Syntax check.
 428              if (!preg_match('/(http:\/\/|https:\/\/|www).*/', $reference)) {
 429                  $errors['packageurl'] = get_string('invalidurl', 'scorm');
 430              } else {
 431                  // Availability check.
 432                  $result = scorm_check_url($reference);
 433                  if (is_string($result)) {
 434                      $errors['packageurl'] = $result;
 435                  }
 436              }
 437  
 438          }
 439  
 440          return $errors;
 441      }
 442  
 443      // Need to translate the "options" and "reference" field.
 444      public function set_data($defaultvalues) {
 445          $defaultvalues = (array)$defaultvalues;
 446  
 447          if (isset($defaultvalues['scormtype']) and isset($defaultvalues['reference'])) {
 448              switch ($defaultvalues['scormtype']) {
 449                  case SCORM_TYPE_LOCALSYNC :
 450                  case SCORM_TYPE_EXTERNAL:
 451                  case SCORM_TYPE_AICCURL:
 452                      $defaultvalues['packageurl'] = $defaultvalues['reference'];
 453              }
 454          }
 455          unset($defaultvalues['reference']);
 456  
 457          if (!empty($defaultvalues['options'])) {
 458              $options = explode(',', $defaultvalues['options']);
 459              foreach ($options as $option) {
 460                  $opt = explode('=', $option);
 461                  if (isset($opt[1])) {
 462                      $defaultvalues[$opt[0]] = $opt[1];
 463                  }
 464              }
 465          }
 466  
 467          $this->data_preprocessing($defaultvalues);
 468          parent::set_data($defaultvalues);
 469      }
 470  
 471      public function add_completion_rules() {
 472          $mform =& $this->_form;
 473          $items = array();
 474  
 475          // Require score.
 476          $group = array();
 477          $group[] =& $mform->createElement('text', 'completionscorerequired', '', array('size' => 5));
 478          $group[] =& $mform->createElement('checkbox', 'completionscoredisabled', null, get_string('disable'));
 479          $mform->setType('completionscorerequired', PARAM_INT);
 480          $mform->addGroup($group, 'completionscoregroup', get_string('completionscorerequired', 'scorm'), '', false);
 481          $mform->addHelpButton('completionscoregroup', 'completionscorerequired', 'scorm');
 482          $mform->disabledIf('completionscorerequired', 'completionscoredisabled', 'checked');
 483          $mform->setDefault('completionscorerequired', 0);
 484  
 485          $items[] = 'completionscoregroup';
 486  
 487          // Require status.
 488          $first = true;
 489          $firstkey = null;
 490          foreach (scorm_status_options(true) as $key => $value) {
 491              $name = null;
 492              $key = 'completionstatusrequired['.$key.']';
 493              if ($first) {
 494                  $name = get_string('completionstatusrequired', 'scorm');
 495                  $first = false;
 496                  $firstkey = $key;
 497              }
 498              $mform->addElement('checkbox', $key, $name, $value);
 499              $mform->setType($key, PARAM_BOOL);
 500              $items[] = $key;
 501          }
 502          $mform->addHelpButton($firstkey, 'completionstatusrequired', 'scorm');
 503  
 504          return $items;
 505      }
 506  
 507      public function completion_rule_enabled($data) {
 508          $status = !empty($data['completionstatusrequired']);
 509          $score = empty($data['completionscoredisabled']) && strlen($data['completionscorerequired']);
 510  
 511          return $status || $score;
 512      }
 513  
 514      public function get_data($slashed = true) {
 515          $data = parent::get_data($slashed);
 516  
 517          if (!$data) {
 518              return false;
 519          }
 520  
 521          // Convert completionstatusrequired to a proper integer, if any.
 522          $total = 0;
 523          if (isset($data->completionstatusrequired) && is_array($data->completionstatusrequired)) {
 524              foreach (array_keys($data->completionstatusrequired) as $state) {
 525                  $total |= $state;
 526              }
 527              $data->completionstatusrequired = $total;
 528          }
 529  
 530          if (!empty($data->completionunlocked)) {
 531              // Turn off completion settings if the checkboxes aren't ticked.
 532              $autocompletion = isset($data->completion) && $data->completion == COMPLETION_TRACKING_AUTOMATIC;
 533  
 534              if (!(isset($data->completionstatusrequired) && $autocompletion)) {
 535                  $data->completionstatusrequired = null;
 536              }
 537              // Else do nothing: completionstatusrequired has been already converted
 538              //             into a correct integer representation.
 539  
 540              if (!empty($data->completionscoredisabled) || !$autocompletion) {
 541                  $data->completionscorerequired = null;
 542              }
 543          }
 544  
 545          return $data;
 546      }
 547  }

Search This Site: