[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   * Online Text assignment submission subplugin data generator.
  19   *
  20   * @package mod_assign
  21   * @category test
  22   * @copyright 2021 Andrew Lyons <andrew@nicols.co.uk>
  23   * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24   */
  25  abstract class assignsubmission_subplugin_generator extends testing_module_generator {
  26      /**
  27       * Add submission data in the correct format for a call to `assign::save_submission()` from a table containing
  28       * submission data for a single activity.
  29       *
  30       * Data should be added to the $submission object passed into the function.
  31       *
  32       * @param stdClass $submission The submission record to be modified
  33       * @param assign $assign The assignment being submitted to
  34       * @param array $data The data received
  35       */
  36      abstract public function add_submission_data(stdClass $submission, assign $assign, array $data): void;
  37  }