[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  namespace qbank_customfields;
  18  
  19  use core_question\local\bank\plugin_features_base;
  20  use core_question\local\bank\view;
  21  use qbank_customfields\customfield\question_handler;
  22  
  23  /**
  24   * Class plugin_feature is the entrypoint for the columns.
  25   *
  26   * @package    qbank_customfields
  27   * @copyright  2021 Catalyst IT Australia Pty Ltd
  28   * @author     Ghaly Marc-Alexandre <marc-alexandreghaly@catalyst-ca.net>
  29   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  30   */
  31  class plugin_feature extends plugin_features_base {
  32  
  33      /**
  34       * This method will return the array of objects to be rendered as a prt of question bank columns/actions.
  35       *
  36       * @param view $qbank
  37       * @return array
  38       */
  39      public function get_question_columns(view $qbank): array {
  40          // We make a column for each custom field and load the data into it.
  41          $columns = [];
  42  
  43          // First get all the available question custom fields.
  44          $customfieldhandler = question_handler::create();
  45          $fields = $customfieldhandler->get_fields();
  46          $context = $qbank->get_most_specific_context();
  47  
  48          // Iterate through the fields initialising a column for each.
  49          // We don't need to know the values that questions have at this stage.
  50          foreach ($fields as $field) {
  51              if ($customfieldhandler->can_view_type($field, $context)) {
  52                  $customfieldcolumn = new custom_field_column($qbank, $field);
  53                  $columns[] = $customfieldcolumn;
  54              }
  55  
  56          }
  57  
  58          return $columns;
  59      }
  60  }