[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   * Create update form mapper interface.
  19   *
  20   * @package    core_calendar
  21   * @copyright  2017 Ryan Wyllie <ryan@moodle.com>
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace core_calendar\local\event\mappers;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  require_once($CFG->dirroot . '/calendar/lib.php');
  30  
  31  /**
  32   * Interface for a create_update_form_mapper class
  33   *
  34   * @copyright  2017 Ryan Wyllie <ryan@moodle.com>
  35   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  36   */
  37  interface create_update_form_mapper_interface {
  38      /**
  39       * Generate the appropriate data for the form from a legacy event.
  40       *
  41       * @param \calendar_event $legacyevent
  42       * @return stdClass
  43       */
  44      public function from_legacy_event_to_data(\calendar_event $legacyevent);
  45  
  46      /**
  47       * Generate the appropriate calendar_event properties from the form data.
  48       *
  49       * @param \stdClass $data
  50       * @return stdClass
  51       */
  52      public function from_data_to_event_properties(\stdClass $data);
  53  }