[Summary view]

Differences Between: [Versions 39 and 311]

   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   * Times 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\value_objects;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * Interface for various times.
  31   *
  32   * @copyright  2017 Cameron Ball <cameron@cameron1729.xyz>
  33   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  34   */
  35  interface times_interface {
  36      /**
  37       * Get the start time.
  38       *
  39       * @return \DateTimeImmutable
  40       */
  41      public function get_start_time();
  42  
  43      /**
  44       * Get the end time.
  45       *
  46       * @return \DateTimeImmutable
  47       */
  48      public function get_end_time();
  49  
  50      /**
  51       * Get the duration (the time between start and end).
  52       *
  53       * @return \DateInterval
  54       */
  55      public function get_duration();
  56  
  57      /**
  58       * Get the sort time.
  59       *
  60       * @return \DateTimeImmutable
  61       */
  62      public function get_sort_time();
  63  
  64      /**
  65       * Get the modified time.
  66       *
  67       * @return \DateTimeImmutable
  68       */
  69      public function get_modified_time();
  70  
  71      /**
  72       * Get the user midnight time.
  73       *
  74       * @return \DateTimeImmutable
  75       */
  76      public function get_usermidnight_time();
  77  }