[Summary view]

Differences Between: [Versions 311 and 401]

   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  declare(strict_types=1);
  18  
  19  namespace mod_assign\completion;
  20  
  21  use core_completion\activity_custom_completion;
  22  
  23  /**
  24   * Activity custom completion subclass for the assign activity.
  25   *
  26   * Class for defining mod_assign's custom completion rules and fetching the completion statuses
  27   * of the custom completion rules for a given assign instance and a user.
  28   *
  29   * @package mod_assign
  30   * @copyright Simey Lameze <simey@moodle.com>
  31   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  32   */
  33  class custom_completion extends activity_custom_completion {
  34  
  35      /**
  36       * Fetches the completion state for a given completion rule.
  37       *
  38       * @param string $rule The completion rule.
  39       * @return int The completion state.
  40       */
  41      public function get_state(string $rule): int {
  42          global $CFG;
  43  
  44          $this->validate_rule($rule);
  45  
  46          $userid = $this->userid;
  47          $cm = $this->cm;
  48  
  49          require_once($CFG->dirroot . '/mod/assign/locallib.php');
  50  
  51          $assign = new \assign(null, $cm, $cm->get_course());
  52          if ($assign->get_instance()->teamsubmission) {
  53              $submission = $assign->get_group_submission($userid, 0, false);
  54          } else {
  55              $submission = $assign->get_user_submission($userid, false);
  56          }
  57          $status = $submission && $submission->status == ASSIGN_SUBMISSION_STATUS_SUBMITTED;
  58  
  59          return $status ? COMPLETION_COMPLETE : COMPLETION_INCOMPLETE;
  60      }
  61  
  62      /**
  63       * Fetch the list of custom completion rules that this module defines.
  64       *
  65       * @return array
  66       */
  67      public static function get_defined_custom_rules(): array {
  68          return ['completionsubmit'];
  69      }
  70  
  71      /**
  72       * Returns an associative array of the descriptions of custom completion rules.
  73       *
  74       * @return array
  75       */
  76      public function get_custom_rule_descriptions(): array {
  77          return [
  78              'completionsubmit' => get_string('completiondetail:submit', 'assign')
  79          ];
  80      }
  81  
  82      /**
  83       * Returns an array of all completion rules, in the order they should be displayed to users.
  84       *
  85       * @return array
  86       */
  87      public function get_sort_order(): array {
  88          return [
  89              'completionview',
  90              'completionsubmit',
  91              'completionusegrade',
  92              'completionpassgrade',
  93          ];
  94      }
  95  }