[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  /**
  18   * H5P activity report interface
  19   *
  20   * @package    mod_h5pactivity
  21   * @since      Moodle 3.9
  22   * @copyright  2020 Ferran Recio <ferran@moodle.com>
  23   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24   */
  25  
  26  namespace mod_h5pactivity\local;
  27  
  28  use templatable;
  29  use stdClass;
  30  
  31  /**
  32   * Interface for any mod_h5pactivity report.
  33   *
  34   * @package    mod_h5pactivity
  35   * @since      Moodle 3.9
  36   * @copyright  2020 Ferran Recio <ferran@moodle.com>
  37   */
  38  interface report {
  39  
  40      /**
  41       * Return the report user record.
  42       *
  43       * @return stdClass|null a user or null
  44       */
  45      public function get_user(): ?stdClass;
  46  
  47      /**
  48       * Return the report attempt object.
  49       *
  50       * @return attempt|null the attempt object or null
  51       */
  52      public function get_attempt(): ?attempt;
  53  
  54      /**
  55       * Print the report visualization.
  56       */
  57      public function print(): void;
  58  }