Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 3.9.x will end* 10 May 2021 (12 months).
  • Bug fixes for security issues in 3.9.x will end* 8 May 2023 (36 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.

Differences Between: [Versions 39 and 311] [Versions 39 and 400] [Versions 39 and 401] [Versions 39 and 402] [Versions 39 and 403]

   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->standard_intro_elements();
  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->hideIf('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->hideIf('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->hideIf('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->hideIf('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->hideIf('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          $mform->addElement('select', 'skipview', get_string('skipview', 'scorm'), $skipviewoptions);
 141          $mform->addHelpButton('skipview', 'skipview', 'scorm');
 142          $mform->setDefault('skipview', $cfgscorm->skipview);
 143          $mform->setAdvanced('skipview', $cfgscorm->skipview_adv);
 144  
 145          // Hide Browse.
 146          $mform->addElement('selectyesno', 'hidebrowse', get_string('hidebrowse', 'scorm'));
 147          $mform->addHelpButton('hidebrowse', 'hidebrowse', 'scorm');
 148          $mform->setDefault('hidebrowse', $cfgscorm->hidebrowse);
 149          $mform->setAdvanced('hidebrowse', $cfgscorm->hidebrowse_adv);
 150  
 151          // Display course structure.
 152          $mform->addElement('selectyesno', 'displaycoursestructure', get_string('displaycoursestructure', 'scorm'));
 153          $mform->addHelpButton('displaycoursestructure', 'displaycoursestructure', 'scorm');
 154          $mform->setDefault('displaycoursestructure', $cfgscorm->displaycoursestructure);
 155          $mform->setAdvanced('displaycoursestructure', $cfgscorm->displaycoursestructure_adv);
 156  
 157          // Toc display.
 158          $mform->addElement('select', 'hidetoc', get_string('hidetoc', 'scorm'), scorm_get_hidetoc_array());
 159          $mform->addHelpButton('hidetoc', 'hidetoc', 'scorm');
 160          $mform->setDefault('hidetoc', $cfgscorm->hidetoc);
 161          $mform->setAdvanced('hidetoc', $cfgscorm->hidetoc_adv);
 162          $mform->disabledIf('hidetoc', 'scormtype', 'eq', SCORM_TYPE_AICCURL);
 163  
 164          // Navigation panel display.
 165          $mform->addElement('select', 'nav', get_string('nav', 'scorm'), scorm_get_navigation_display_array());
 166          $mform->addHelpButton('nav', 'nav', 'scorm');
 167          $mform->setDefault('nav', $cfgscorm->nav);
 168          $mform->setAdvanced('nav', $cfgscorm->nav_adv);
 169          $mform->hideIf('nav', 'hidetoc', 'noteq', SCORM_TOC_SIDE);
 170  
 171          // Navigation panel position from left.
 172          $mform->addElement('text', 'navpositionleft', get_string('fromleft', 'scorm'), 'maxlength="5" size="5"');
 173          $mform->setDefault('navpositionleft', $cfgscorm->navpositionleft);
 174          $mform->setType('navpositionleft', PARAM_INT);
 175          $mform->setAdvanced('navpositionleft', $cfgscorm->navpositionleft_adv);
 176          $mform->hideIf('navpositionleft', 'hidetoc', 'noteq', SCORM_TOC_SIDE);
 177          $mform->hideIf('navpositionleft', 'nav', 'noteq', SCORM_NAV_FLOATING);
 178  
 179          // Navigation panel position from top.
 180          $mform->addElement('text', 'navpositiontop', get_string('fromtop', 'scorm'), 'maxlength="5" size="5"');
 181          $mform->setDefault('navpositiontop', $cfgscorm->navpositiontop);
 182          $mform->setType('navpositiontop', PARAM_INT);
 183          $mform->setAdvanced('navpositiontop', $cfgscorm->navpositiontop_adv);
 184          $mform->hideIf('navpositiontop', 'hidetoc', 'noteq', SCORM_TOC_SIDE);
 185          $mform->hideIf('navpositiontop', 'nav', 'noteq', SCORM_NAV_FLOATING);
 186  
 187          // Display attempt status.
 188          $mform->addElement('select', 'displayattemptstatus', get_string('displayattemptstatus', 'scorm'),
 189                             scorm_get_attemptstatus_array());
 190          $mform->addHelpButton('displayattemptstatus', 'displayattemptstatus', 'scorm');
 191          $mform->setDefault('displayattemptstatus', $cfgscorm->displayattemptstatus);
 192          $mform->setAdvanced('displayattemptstatus', $cfgscorm->displayattemptstatus_adv);
 193  
 194          // Availability.
 195          $mform->addElement('header', 'availability', get_string('availability'));
 196  
 197          $mform->addElement('date_time_selector', 'timeopen', get_string("scormopen", "scorm"), array('optional' => true));
 198          $mform->addElement('date_time_selector', 'timeclose', get_string("scormclose", "scorm"), array('optional' => true));
 199  
 200          // Grade Settings.
 201          $mform->addElement('header', 'gradesettings', get_string('grade'));
 202  
 203          // Grade Method.
 204          $mform->addElement('select', 'grademethod', get_string('grademethod', 'scorm'), scorm_get_grade_method_array());
 205          $mform->addHelpButton('grademethod', 'grademethod', 'scorm');
 206          $mform->setDefault('grademethod', $cfgscorm->grademethod);
 207  
 208          // Maximum Grade.
 209          for ($i = 0; $i <= 100; $i++) {
 210              $grades[$i] = "$i";
 211          }
 212          $mform->addElement('select', 'maxgrade', get_string('maximumgrade'), $grades);
 213          $mform->setDefault('maxgrade', $cfgscorm->maxgrade);
 214          $mform->hideIf('maxgrade', 'grademethod', 'eq', GRADESCOES);
 215  
 216          // Attempts management.
 217          $mform->addElement('header', 'attemptsmanagementhdr', get_string('attemptsmanagement', 'scorm'));
 218  
 219          // Max Attempts.
 220          $mform->addElement('select', 'maxattempt', get_string('maximumattempts', 'scorm'), scorm_get_attempts_array());
 221          $mform->addHelpButton('maxattempt', 'maximumattempts', 'scorm');
 222          $mform->setDefault('maxattempt', $cfgscorm->maxattempt);
 223  
 224          // What Grade.
 225          $mform->addElement('select', 'whatgrade', get_string('whatgrade', 'scorm'),  scorm_get_what_grade_array());
 226          $mform->hideIf('whatgrade', 'maxattempt', 'eq', 1);
 227          $mform->addHelpButton('whatgrade', 'whatgrade', 'scorm');
 228          $mform->setDefault('whatgrade', $cfgscorm->whatgrade);
 229  
 230          // Force new attempt.
 231          $newattemptselect = scorm_get_forceattempt_array();
 232          $mform->addElement('select', 'forcenewattempt', get_string('forcenewattempts', 'scorm'), $newattemptselect);
 233          $mform->addHelpButton('forcenewattempt', 'forcenewattempts', 'scorm');
 234          $mform->setDefault('forcenewattempt', $cfgscorm->forcenewattempt);
 235  
 236          // Last attempt lock - lock the enter button after the last available attempt has been made.
 237          $mform->addElement('selectyesno', 'lastattemptlock', get_string('lastattemptlock', 'scorm'));
 238          $mform->addHelpButton('lastattemptlock', 'lastattemptlock', 'scorm');
 239          $mform->setDefault('lastattemptlock', $cfgscorm->lastattemptlock);
 240  
 241          // Compatibility settings.
 242          $mform->addElement('header', 'compatibilitysettingshdr', get_string('compatibilitysettings', 'scorm'));
 243  
 244          // Force completed.
 245          $mform->addElement('selectyesno', 'forcecompleted', get_string('forcecompleted', 'scorm'));
 246          $mform->addHelpButton('forcecompleted', 'forcecompleted', 'scorm');
 247          $mform->setDefault('forcecompleted', $cfgscorm->forcecompleted);
 248  
 249          // Autocontinue.
 250          $mform->addElement('selectyesno', 'auto', get_string('autocontinue', 'scorm'));
 251          $mform->addHelpButton('auto', 'autocontinue', 'scorm');
 252          $mform->setDefault('auto', $cfgscorm->auto);
 253  
 254          // Autocommit.
 255          $mform->addElement('selectyesno', 'autocommit', get_string('autocommit', 'scorm'));
 256          $mform->addHelpButton('autocommit', 'autocommit', 'scorm');
 257          $mform->setDefault('autocommit', $cfgscorm->autocommit);
 258  
 259          // Mastery score overrides status.
 260          $mform->addElement('selectyesno', 'masteryoverride', get_string('masteryoverride', 'scorm'));
 261          $mform->addHelpButton('masteryoverride', 'masteryoverride', 'scorm');
 262          $mform->setDefault('masteryoverride', $cfgscorm->masteryoverride);
 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['height']) && (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          $cvalues = array();
 336          if (empty($this->_instance)) {
 337              // When in add mode, set a default completion rule that requires the SCORM's status be set to "Completed".
 338              $cvalues[4] = 1;
 339          } else if (!empty($defaultvalues['completionstatusrequired']) && !is_array($defaultvalues['completionstatusrequired'])) {
 340              // Unpack values.
 341              foreach (scorm_status_options() as $key => $value) {
 342                  if (($defaultvalues['completionstatusrequired'] & $key) == $key) {
 343                      $cvalues[$key] = 1;
 344                  }
 345              }
 346          }
 347          if (!empty($cvalues)) {
 348              $defaultvalues['completionstatusrequired'] = $cvalues;
 349          }
 350  
 351          if (!isset($defaultvalues['completionscorerequired']) || !strlen($defaultvalues['completionscorerequired'])) {
 352              $defaultvalues['completionscoredisabled'] = 1;
 353          }
 354      }
 355  
 356      public function validation($data, $files) {
 357          global $CFG, $USER;
 358          $errors = parent::validation($data, $files);
 359  
 360          $type = $data['scormtype'];
 361  
 362          if ($type === SCORM_TYPE_LOCAL) {
 363              if (empty($data['packagefile'])) {
 364                  $errors['packagefile'] = get_string('required');
 365  
 366              } else {
 367                  $draftitemid = file_get_submitted_draft_itemid('packagefile');
 368  
 369                  file_prepare_draft_area($draftitemid, $this->context->id, 'mod_scorm', 'packagefilecheck', null,
 370                      array('subdirs' => 0, 'maxfiles' => 1));
 371  
 372                  // Get file from users draft area.
 373                  $usercontext = context_user::instance($USER->id);
 374                  $fs = get_file_storage();
 375                  $files = $fs->get_area_files($usercontext->id, 'user', 'draft', $draftitemid, 'id', false);
 376  
 377                  if (count($files) < 1) {
 378                      $errors['packagefile'] = get_string('required');
 379                      return $errors;
 380                  }
 381                  $file = reset($files);
 382                  if (!$file->is_external_file() && !empty($data['updatefreq'])) {
 383                      // Make sure updatefreq is not set if using normal local file.
 384                      $errors['updatefreq'] = get_string('updatefreq_error', 'mod_scorm');
 385                  }
 386                  if (strtolower($file->get_filename()) == 'imsmanifest.xml') {
 387                      if (!$file->is_external_file()) {
 388                          $errors['packagefile'] = get_string('aliasonly', 'mod_scorm');
 389                      } else {
 390                          $repository = repository::get_repository_by_id($file->get_repository_id(), context_system::instance());
 391                          if (!$repository->supports_relative_file()) {
 392                              $errors['packagefile'] = get_string('repositorynotsupported', 'mod_scorm');
 393                          }
 394                      }
 395                  } else if (strtolower(substr($file->get_filename(), -3)) == 'xml') {
 396                      $errors['packagefile'] = get_string('invalidmanifestname', 'mod_scorm');
 397                  } else {
 398                      // Validate this SCORM package.
 399                      $errors = array_merge($errors, scorm_validate_package($file));
 400                  }
 401              }
 402  
 403          } else if ($type === SCORM_TYPE_EXTERNAL) {
 404              $reference = $data['packageurl'];
 405              // Syntax check.
 406              if (!preg_match('/(http:\/\/|https:\/\/|www).*\/imsmanifest.xml$/i', $reference)) {
 407                  $errors['packageurl'] = get_string('invalidurl', 'scorm');
 408              } else {
 409                  // Availability check.
 410                  $result = scorm_check_url($reference);
 411                  if (is_string($result)) {
 412                      $errors['packageurl'] = $result;
 413                  }
 414              }
 415  
 416          } else if ($type === 'packageurl') {
 417              $reference = $data['reference'];
 418              // Syntax check.
 419              if (!preg_match('/(http:\/\/|https:\/\/|www).*(\.zip|\.pif)$/i', $reference)) {
 420                  $errors['packageurl'] = get_string('invalidurl', 'scorm');
 421              } else {
 422                  // Availability check.
 423                  $result = scorm_check_url($reference);
 424                  if (is_string($result)) {
 425                      $errors['packageurl'] = $result;
 426                  }
 427              }
 428  
 429          } else if ($type === SCORM_TYPE_AICCURL) {
 430              $reference = $data['packageurl'];
 431              // Syntax check.
 432              if (!preg_match('/(http:\/\/|https:\/\/|www).*/', $reference)) {
 433                  $errors['packageurl'] = get_string('invalidurl', 'scorm');
 434              } else {
 435                  // Availability check.
 436                  $result = scorm_check_url($reference);
 437                  if (is_string($result)) {
 438                      $errors['packageurl'] = $result;
 439                  }
 440              }
 441  
 442          }
 443  
 444          // Validate availability dates.
 445          if ($data['timeopen'] && $data['timeclose']) {
 446              if ($data['timeopen'] > $data['timeclose']) {
 447                  $errors['timeclose'] = get_string('closebeforeopen', 'scorm');
 448              }
 449          }
 450          if (!empty($data['completionstatusallscos'])) {
 451              $requirestatus = false;
 452              foreach (scorm_status_options(true) as $key => $value) {
 453                  if (!empty($data['completionstatusrequired'][$key])) {
 454                      $requirestatus = true;
 455                  }
 456              }
 457              if (!$requirestatus) {
 458                  $errors['completionstatusallscos'] = get_string('youmustselectastatus', 'scorm');
 459              }
 460          }
 461  
 462          return $errors;
 463      }
 464  
 465      // Need to translate the "options" and "reference" field.
 466      public function set_data($defaultvalues) {
 467          $defaultvalues = (array)$defaultvalues;
 468  
 469          if (isset($defaultvalues['scormtype']) and isset($defaultvalues['reference'])) {
 470              switch ($defaultvalues['scormtype']) {
 471                  case SCORM_TYPE_LOCALSYNC :
 472                  case SCORM_TYPE_EXTERNAL:
 473                  case SCORM_TYPE_AICCURL:
 474                      $defaultvalues['packageurl'] = $defaultvalues['reference'];
 475              }
 476          }
 477          unset($defaultvalues['reference']);
 478  
 479          if (!empty($defaultvalues['options'])) {
 480              $options = explode(',', $defaultvalues['options']);
 481              foreach ($options as $option) {
 482                  $opt = explode('=', $option);
 483                  if (isset($opt[1])) {
 484                      $defaultvalues[$opt[0]] = $opt[1];
 485                  }
 486              }
 487          }
 488  
 489          parent::set_data($defaultvalues);
 490      }
 491  
 492      public function add_completion_rules() {
 493          $mform =& $this->_form;
 494          $items = array();
 495  
 496          // Require score.
 497          $group = array();
 498          $group[] =& $mform->createElement('text', 'completionscorerequired', '', array('size' => 5));
 499          $group[] =& $mform->createElement('checkbox', 'completionscoredisabled', null, get_string('disable'));
 500          $mform->setType('completionscorerequired', PARAM_INT);
 501          $mform->addGroup($group, 'completionscoregroup', get_string('completionscorerequired', 'scorm'), '', false);
 502          $mform->addHelpButton('completionscoregroup', 'completionscorerequired', 'scorm');
 503          $mform->disabledIf('completionscorerequired', 'completionscoredisabled', 'checked');
 504          $mform->setDefault('completionscorerequired', 0);
 505  
 506          $items[] = 'completionscoregroup';
 507  
 508          // Require status.
 509          $first = true;
 510          $firstkey = null;
 511          foreach (scorm_status_options(true) as $key => $value) {
 512              $name = null;
 513              $key = 'completionstatusrequired['.$key.']';
 514              if ($first) {
 515                  $name = get_string('completionstatusrequired', 'scorm');
 516                  $first = false;
 517                  $firstkey = $key;
 518              }
 519              $mform->addElement('checkbox', $key, $name, $value);
 520              $mform->setType($key, PARAM_BOOL);
 521              $items[] = $key;
 522          }
 523          $mform->addHelpButton($firstkey, 'completionstatusrequired', 'scorm');
 524  
 525          $mform->addElement('checkbox', 'completionstatusallscos', get_string('completionstatusallscos', 'scorm'));
 526          $mform->setType('completionstatusallscos', PARAM_BOOL);
 527          $mform->addHelpButton('completionstatusallscos', 'completionstatusallscos', 'scorm');
 528          $mform->setDefault('completionstatusallscos', 0);
 529          $items[] = 'completionstatusallscos';
 530  
 531          return $items;
 532      }
 533  
 534      public function completion_rule_enabled($data) {
 535          $status = !empty($data['completionstatusrequired']);
 536          $score = empty($data['completionscoredisabled']) && strlen($data['completionscorerequired']);
 537  
 538          return $status || $score;
 539      }
 540  
 541      /**
 542       * Allows module to modify the data returned by form get_data().
 543       * This method is also called in the bulk activity completion form.
 544       *
 545       * Only available on moodleform_mod.
 546       *
 547       * @param stdClass $data the form data to be modified.
 548       */
 549      public function data_postprocessing($data) {
 550          parent::data_postprocessing($data);
 551          // Convert completionstatusrequired to a proper integer, if any.
 552          $total = 0;
 553          if (isset($data->completionstatusrequired) && is_array($data->completionstatusrequired)) {
 554              foreach ($data->completionstatusrequired as $state => $value) {
 555                  if ($value) {
 556                      $total |= $state;
 557                  }
 558              }
 559              if (!$total) {
 560                  $total  = null;
 561              }
 562              $data->completionstatusrequired = $total;
 563          }
 564  
 565          if (!empty($data->completionunlocked)) {
 566              // Turn off completion settings if the checkboxes aren't ticked.
 567              $autocompletion = isset($data->completion) && $data->completion == COMPLETION_TRACKING_AUTOMATIC;
 568  
 569              if (!(isset($data->completionstatusrequired) && $autocompletion)) {
 570                  $data->completionstatusrequired = null;
 571              }
 572              // Else do nothing: completionstatusrequired has been already converted
 573              //             into a correct integer representation.
 574  
 575              if (!empty($data->completionscoredisabled) || !$autocompletion) {
 576                  $data->completionscorerequired = null;
 577              }
 578          }
 579      }
 580  }