ecommun / owncloud_ynh

Blame view

sources/3rdparty/sabre/vobject/lib/Sabre/VObject/Component/VAlarm.php 3.78 KB
edit raw normal view history
03e52840d   Kload   Init 
1
2
3
4
5
6
7
8
9
10
 
  <?php
  
  namespace Sabre\VObject\Component;
  use Sabre\VObject;
  
  /**
   * VAlarm component
   *
   * This component contains some additional functionality specific for VALARMs.
   *
6d9380f96   Cédric Dupont   Update sources OC... 
11
12
 
   * @copyright Copyright (C) 2007-2013 fruux GmbH (https://fruux.com/).
   * @author Evert Pot (http://evertpot.com/)
03e52840d   Kload   Init 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
   * @license http://code.google.com/p/sabredav/wiki/License Modified BSD License
   */
  class VAlarm extends VObject\Component {
  
      /**
       * Returns a DateTime object when this alarm is going to trigger.
       *
       * This ignores repeated alarm, only the first trigger is returned.
       *
       * @return DateTime
       */
      public function getEffectiveTriggerTime() {
  
          $trigger = $this->TRIGGER;
          if(!isset($trigger['VALUE']) || strtoupper($trigger['VALUE']) === 'DURATION') {
              $triggerDuration = VObject\DateTimeParser::parseDuration($this->TRIGGER);
              $related = (isset($trigger['RELATED']) && strtoupper($trigger['RELATED']) == 'END') ? 'END' : 'START';
  
              $parentComponent = $this->parent;
              if ($related === 'START') {
  
                  if ($parentComponent->name === 'VTODO') {
                      $propName = 'DUE';
                  } else {
                      $propName = 'DTSTART';
                  }
  
                  $effectiveTrigger = clone $parentComponent->$propName->getDateTime();
                  $effectiveTrigger->add($triggerDuration);
              } else {
                  if ($parentComponent->name === 'VTODO') {
                      $endProp = 'DUE';
                  } elseif ($parentComponent->name === 'VEVENT') {
                      $endProp = 'DTEND';
                  } else {
                      throw new \LogicException('time-range filters on VALARM components are only supported when they are a child of VTODO or VEVENT');
                  }
  
                  if (isset($parentComponent->$endProp)) {
                      $effectiveTrigger = clone $parentComponent->$endProp->getDateTime();
                      $effectiveTrigger->add($triggerDuration);
                  } elseif (isset($parentComponent->DURATION)) {
                      $effectiveTrigger = clone $parentComponent->DTSTART->getDateTime();
                      $duration = VObject\DateTimeParser::parseDuration($parentComponent->DURATION);
                      $effectiveTrigger->add($duration);
                      $effectiveTrigger->add($triggerDuration);
                  } else {
                      $effectiveTrigger = clone $parentComponent->DTSTART->getDateTime();
                      $effectiveTrigger->add($triggerDuration);
                  }
              }
          } else {
              $effectiveTrigger = $trigger->getDateTime();
          }
          return $effectiveTrigger;
  
      }
  
      /**
       * Returns true or false depending on if the event falls in the specified
       * time-range. This is used for filtering purposes.
       *
       * The rules used to determine if an event falls within the specified
       * time-range is based on the CalDAV specification.
       *
       * @param \DateTime $start
       * @param \DateTime $end
       * @return bool
       */
      public function isInTimeRange(\DateTime $start, \DateTime $end) {
  
          $effectiveTrigger = $this->getEffectiveTriggerTime();
  
          if (isset($this->DURATION)) {
              $duration = VObject\DateTimeParser::parseDuration($this->DURATION);
              $repeat = (string)$this->repeat;
              if (!$repeat) {
                  $repeat = 1;
              }
  
              $period = new \DatePeriod($effectiveTrigger, $duration, (int)$repeat);
  
              foreach($period as $occurrence) {
  
                  if ($start <= $occurrence && $end > $occurrence) {
                      return true;
                  }
              }
              return false;
          } else {
              return ($start <= $effectiveTrigger && $end > $effectiveTrigger);
          }
  
      }
  
  }