Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.

Differences Between: [Versions 310 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  /**
  18   * Renderers for the import of CSV files into the gradebook.
  19   *
  20   * @package   gradeimport_csv
  21   * @copyright 2014 Adrian Greeve <adrian@moodle.com>
  22   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  defined('MOODLE_INTERNAL') || die();
  26  
  27  /**
  28   * Renderers for the import of CSV files into the gradebook.
  29   *
  30   * @package   gradeimport_csv
  31   * @copyright 2014 Adrian Greeve <adrian@moodle.com>
  32   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  33   */
  34  class gradeimport_csv_renderer extends plugin_renderer_base {
  35  
  36      /**
  37       * A renderer for the standard upload file form.
  38       *
  39       * @param object $course The course we are doing all of this action in.
  40       * @param object $mform The mform for uploading CSV files.
  41       * @return string html to be displayed.
  42       */
  43      public function standard_upload_file_form($course, $mform) {
  44  
  45          $output = groups_print_course_menu($course, 'index.php?id=' . $course->id, true);
  46          $output .= html_writer::start_tag('div', array('class' => 'clearer'));
  47          $output .= html_writer::end_tag('div');
  48  
  49          // Form.
  50          ob_start();
  51          $mform->display();
  52          $output .= ob_get_contents();
  53          ob_end_clean();
  54  
  55          return $output;
  56      }
  57  
  58      /**
  59       * A renderer for the CSV file preview.
  60       *
  61       * @param array $header Column headers from the CSV file.
  62       * @param array $data The rest of the data from the CSV file.
  63       * @return string html to be displayed.
  64       */
  65      public function import_preview_page($header, $data) {
  66  
  67          $html = $this->output->heading(get_string('importpreview', 'grades'));
  68  
  69          $table = new html_table();
  70          $table->head = array_map('s', $header);
  71          $table->data = array_map(static function($row) {
  72              return array_map('s', $row);
  73          }, $data);
  74          $html .= html_writer::table($table);
  75  
  76          return $html;
  77      }
  78  
  79      /**
  80       * A renderer for errors generated trying to import the CSV file.
  81       *
  82       * @param array $errors Display import errors.
  83       * @return string errors as html to be displayed.
  84       */
  85      public function errors($errors) {
  86          $html = '';
  87          foreach ($errors as $error) {
  88              $html .= $this->output->notification($error);
  89          }
  90          return $html;
  91      }
  92  }