[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_glossary\completion;
  20  
  21  use core_completion\activity_custom_completion;
  22  
  23  /**
  24   * Activity custom completion subclass for the glossary activity.
  25   *
  26   * Class for defining mod_glossary's custom completion rules and fetching the completion statuses
  27   * of the custom completion rules for a given glossary instance and a user.
  28   *
  29   * @package mod_glossary
  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 $DB;
  43  
  44          $this->validate_rule($rule);
  45  
  46          $glossaryid = $this->cm->instance;
  47          $userid = $this->userid;
  48  
  49          $userentries = $DB->count_records('glossary_entries', ['glossaryid' => $glossaryid, 'userid' => $userid,
  50                  'approved' => 1]);
  51          $completionentries = $this->cm->customdata['customcompletionrules']['completionentries'];
  52  
  53          return ($completionentries <= $userentries) ? COMPLETION_COMPLETE : COMPLETION_INCOMPLETE;
  54      }
  55  
  56      /**
  57       * Fetch the list of custom completion rules that this module defines.
  58       *
  59       * @return array
  60       */
  61      public static function get_defined_custom_rules(): array {
  62          return ['completionentries'];
  63      }
  64  
  65      /**
  66       * Returns an associative array of the descriptions of custom completion rules.
  67       *
  68       * @return array
  69       */
  70      public function get_custom_rule_descriptions(): array {
  71          $completionentries = $this->cm->customdata['customcompletionrules']['completionentries'] ?? 0;
  72          return [
  73              'completionentries' => get_string('completiondetail:entries', 'glossary', $completionentries),
  74          ];
  75      }
  76  
  77      /**
  78       * Returns an array of all completion rules, in the order they should be displayed to users.
  79       *
  80       * @return array
  81       */
  82      public function get_sort_order(): array {
  83          return [
  84              'completionview',
  85              'completionentries',
  86              'completionusegrade',
  87              'completionpassgrade',
  88          ];
  89      }
  90  }