[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   * Event mapper interface.
  19   *
  20   * @package    core_calendar
  21   * @copyright  2017 Cameron Ball <cameron@cameron1729.xyz>
  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  use core_calendar\event;
  30  use core_calendar\local\event\entities\event_interface;
  31  
  32  /**
  33   * Interface for an event mapper class
  34   *
  35   * @copyright  2017 Cameron Ball <cameron@cameron1729.xyz>
  36   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  37   */
  38  interface event_mapper_interface {
  39      /**
  40       * Map a legacy event to an event.
  41       *
  42       * @param \calendar_event $event The legacy event.
  43       * @return event_interface The mapped event.
  44       */
  45      public function from_legacy_event_to_event(\calendar_event $event);
  46  
  47      /**
  48       * Map an event to a legacy event.
  49       *
  50       * @param event_interface $event The legacy event.
  51       * @return \calendar_event The mapped legacy event.
  52       */
  53      public function from_event_to_legacy_event(event_interface $event);
  54  
  55      /**
  56       * Map an event to a stdClass
  57       *
  58       * @param event_interface $event The legacy event.
  59       * @return \stdClass The mapped stdClass.
  60       */
  61      public function from_event_to_stdclass(event_interface $event);
  62  
  63      /**
  64       * Map an event to an associative array.
  65       *
  66       * @param event_interface $event The legacy event.
  67       * @return array The mapped legacy event array.
  68       */
  69      public function from_event_to_assoc_array(event_interface $event);
  70  }