[Summary view]

   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_folder\completion;
  20  
  21  use core_completion\activity_custom_completion;
  22  
  23  /**
  24   * Activity custom completion subclass for the folder resource.
  25   *
  26   * Class for defining mod_folder's custom completion rules.
  27   *
  28   * @package    mod_folder
  29   * @copyright  2022 David Woloszyn <david.woloszyn@moodle.com>
  30   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  31   */
  32  class custom_completion extends activity_custom_completion {
  33  
  34      /**
  35       * Fetches the completion state for a given completion rule.
  36       *
  37       * @param string $rule The completion rule.
  38       * @return int The completion state.
  39       */
  40      public function get_state(string $rule): int {
  41          return COMPLETION_UNKNOWN;
  42      }
  43  
  44      /**
  45       * Fetch the list of custom completion rules that this module defines.
  46       *
  47       * @return array
  48       */
  49      public static function get_defined_custom_rules(): array {
  50          // This activity/resource does not have any custom rules.
  51          return [];
  52      }
  53  
  54      /**
  55       * Returns an associative array of the descriptions of custom completion rules.
  56       *
  57       * @return array
  58       */
  59      public function get_custom_rule_descriptions(): array {
  60          // This activity/resource does not have any custom rule descriptions.
  61          return [];
  62      }
  63  
  64      /**
  65       * Show the manual completion button depending on the display option set.
  66       *
  67       * @return bool
  68       */
  69      public function manual_completion_always_shown(): bool {
  70          $display = $this->cm->customdata->display ?? null;
  71  
  72          return ($display == FOLDER_DISPLAY_INLINE ?? false);
  73      }
  74  
  75      /**
  76       * Returns an array of all completion rules, in the order they should be displayed to users.
  77       *
  78       * @return array
  79       */
  80      public function get_sort_order(): array {
  81          // This module only supports manual completion.
  82          return [];
  83      }
  84  }