[Summary view]

Differences Between: [Versions 39 and 402]

   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 times class.
  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   * Class representing event 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  class event_times implements times_interface {
  36      /**
  37       * @var \DateTimeImmutable $start Event start time.
  38       */
  39      protected $start;
  40  
  41      /**
  42       * @var \DateTimeImmutable $end Event end time.
  43       */
  44      protected $end;
  45  
  46      /**
  47       * @var \DateTimeImmutable $sort Time used to sort events.
  48       */
  49      protected $sort;
  50  
  51      /**
  52       * @var \DateTimeImmutable $modified Time event was last modified.
  53       */
  54      protected $modified;
  55  
  56      /**
  57       * @var \DateTimeImmutable $usermidnight User midnight for the event.
  58       */
  59      protected $usermidnight;
  60  
  61      /**
  62       * Constructor.
  63       *
  64       * @param \DateTimeImmutable $start        Event start time.
  65       * @param \DateTimeImmutable $end          Event end time.
  66       * @param \DateTimeImmutable $sort         Date used to sort events.
  67       * @param \DateTimeImmutable $modified     Time event was last updated.
  68       * @param \DateTimeImmutable $usermidnight User midnight for the event.
  69       */
  70      public function __construct(
  71          \DateTimeImmutable $start,
  72          \DateTimeImmutable $end,
  73          \DateTimeImmutable $sort,
  74          \DateTimeImmutable $modified,
  75          \DateTimeImmutable $usermidnight
  76      ) {
  77          $this->start = $start;
  78          $this->end = $end;
  79          $this->sort = $sort;
  80          $this->modified = $modified;
  81          $this->usermidnight = $usermidnight;
  82      }
  83  
  84      public function get_start_time() {
  85          return $this->start;
  86      }
  87  
  88      public function get_end_time() {
  89          return $this->end;
  90      }
  91  
  92      public function get_duration() {
  93          return $this->end->diff($this->start);
  94      }
  95  
  96      public function get_modified_time() {
  97          return $this->modified;
  98      }
  99  
 100      public function get_sort_time() {
 101          return $this->sort;
 102      }
 103  
 104      /**
 105       * Getter for usermidnight.
 106       *
 107       * @return \DateTimeImmutable
 108       */
 109      public function get_usermidnight_time() {
 110          return $this->usermidnight;
 111      }
 112  }