RRuleParser. More...

Inheritance diagram for Sabre\VObject\Recur\RRuleIterator:

Collaboration diagram for Sabre\VObject\Recur\RRuleIterator:

Public Member Functions
	__construct ($rrule, DateTimeInterface $start)
	Creates the Iterator. More...

	current ()

	key ()
	Returns the current item number. More...

	valid ()
	Returns whether the current item is a valid item for the recurrence iterator. More...

	rewind ()
	Resets the iterator. More...

	next ()
	Goes on to the next iteration. More...

	isInfinite ()
	Returns true if this recurring event never ends. More...

	fastForward (DateTimeInterface $dt)
	This method allows you to quickly go to the next occurrence after the specified date. More...

Protected Member Functions
	nextHourly ()
	Does the processing for advancing the iterator for hourly frequency. More...

	nextDaily ()
	Does the processing for advancing the iterator for daily frequency. More...

	nextWeekly ()
	Does the processing for advancing the iterator for weekly frequency. More...

	nextMonthly ()
	Does the processing for advancing the iterator for monthly frequency. More...

	nextYearly ()
	Does the processing for advancing the iterator for yearly frequency. More...

	parseRRule ($rrule)
	This method receives a string from an RRULE property, and populates this class with all the values. More...

	getMonthlyOccurrences ()
	Returns all the occurrences for a monthly frequency with a 'byDay' or 'byMonthDay' expansion for the current month. More...

	getHours ()

	getDays ()

	getMonths ()

Protected Attributes
	$startDate

	$currentDate

	$frequency

	$count

	$interval = 1

	$until

	$bySecond

	$byMinute

	$byHour

	$counter = 0

	$byDay

	$byMonthDay

	$byYearDay

	$byWeekNo

	$byMonth

	$bySetPos

	$weekStart = 'MO'

	$dayNames

	$dayMap

Detailed Description

RRuleParser.

This class receives an RRULE string, and allows you to iterate to get a list of dates in that recurrence.

For instance, passing: FREQ=DAILY;LIMIT=5 will cause the iterator to contain 5 items, one for each day.

Copyright: Copyright (C) fruux GmbH (https://fruux.com/)

Author: Evert Pot (http://evertpot.com/) http://sabre.io/license/ Modified BSD License

Definition at line 25 of file RRuleIterator.php.

Constructor & Destructor Documentation

◆ __construct()

Sabre\VObject\Recur\RRuleIterator::__construct	(		$rrule,
		DateTimeInterface	$start
	)

Creates the Iterator.

Parameters

string \| array	$rrule
DateTimeInterface	$start

Definition at line 33 of file RRuleIterator.php.

References $start, Sabre\VObject\Recur\RRuleIterator\$startDate, and Sabre\VObject\Recur\RRuleIterator\parseRRule().

                                                            {
 
         $this->startDate = $start;
         $this->parseRRule($rrule);
         $this->currentDate = clone $this->startDate;
 
     }

Here is the call graph for this function:

Member Function Documentation

◆ current()

Sabre\VObject\Recur\RRuleIterator::current ( )

Definition at line 43 of file RRuleIterator.php.

References Sabre\VObject\Recur\RRuleIterator\$currentDate, and Sabre\VObject\Recur\RRuleIterator\valid().

                        {
 
         if (!$this->valid()) return;
         return clone $this->currentDate;
 
     }

Here is the call graph for this function:

◆ fastForward()

Sabre\VObject\Recur\RRuleIterator::fastForward ( DateTimeInterface $dt )

This method allows you to quickly go to the next occurrence after the specified date.

Parameters

DateTimeInterface $dt

Returns: void

Definition at line 146 of file RRuleIterator.php.

References Sabre\VObject\Recur\RRuleIterator\next(), and Sabre\VObject\Recur\RRuleIterator\valid().

Referenced by Sabre\VObject\FreeBusyGenerator\calculateAvailability().

                                                 {
 
         while ($this->valid() && $this->currentDate < $dt) {
             $this->next();
         }
 
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDays()

Sabre\VObject\Recur\RRuleIterator::getDays ( )

protected

Definition at line 989 of file RRuleIterator.php.

References Sabre\VObject\Recur\RRuleIterator\$byDay.

Referenced by Sabre\VObject\Recur\RRuleIterator\nextDaily(), and Sabre\VObject\Recur\RRuleIterator\nextWeekly().

                                  {
 
         $recurrenceDays = [];
         foreach ($this->byDay as $byDay) {
 
             // The day may be preceeded with a positive (+n) or
             // negative (-n) integer. However, this does not make
             // sense in 'weekly' so we ignore it here.
             $recurrenceDays[] = $this->dayMap[substr($byDay, -2)];
 
         }
 
         return $recurrenceDays;
     }

Here is the caller graph for this function:

◆ getHours()

Sabre\VObject\Recur\RRuleIterator::getHours ( )

protected

Definition at line 979 of file RRuleIterator.php.

References Sabre\VObject\Recur\RRuleIterator\$byHour.

Referenced by Sabre\VObject\Recur\RRuleIterator\nextDaily(), and Sabre\VObject\Recur\RRuleIterator\nextWeekly().

                                   {
 
         $recurrenceHours = [];
         foreach ($this->byHour as $byHour) {
             $recurrenceHours[] = $byHour;
         }
 
         return $recurrenceHours;
     }

Here is the caller graph for this function:

◆ getMonthlyOccurrences()

Sabre\VObject\Recur\RRuleIterator::getMonthlyOccurrences ( )

protected

Returns all the occurrences for a monthly frequency with a 'byDay' or 'byMonthDay' expansion for the current month.

The returned list is an array of integers with the day of month (1-31).

Returns: array

Definition at line 855 of file RRuleIterator.php.

References Sabre\VObject\Recur\RRuleIterator\$currentDate, $result, and Sabre\VObject\Recur\RRuleIterator\$startDate.

Referenced by Sabre\VObject\Recur\RRuleIterator\nextMonthly(), and Sabre\VObject\Recur\RRuleIterator\nextYearly().

                                                {
 
         $startDate = clone $this->currentDate;
 
         $byDayResults = [];
 
         // Our strategy is to simply go through the byDays, advance the date to
         // that point and add it to the results.
         if ($this->byDay) foreach ($this->byDay as $day) {
 
             $dayName = $this->dayNames[$this->dayMap[substr($day, -2)]];
 
 
             // Dayname will be something like 'wednesday'. Now we need to find
             // all wednesdays in this month.
             $dayHits = [];
 
             // workaround for missing 'first day of the month' support in hhvm
             $checkDate = new \DateTime($startDate->format('Y-m-1'));
             // workaround modify always advancing the date even if the current day is a $dayName in hhvm
             if ($checkDate->format('l') !== $dayName) {
                 $checkDate = $checkDate->modify($dayName);
             }
 
             do {
                 $dayHits[] = $checkDate->format('j');
                 $checkDate = $checkDate->modify('next ' . $dayName);
             } while ($checkDate->format('n') === $startDate->format('n'));
 
             // So now we have 'all wednesdays' for month. It is however
             // possible that the user only really wanted the 1st, 2nd or last
             // wednesday.
             if (strlen($day) > 2) {
                 $offset = (int)substr($day, 0, -2);
 
                 if ($offset > 0) {
                     // It is possible that the day does not exist, such as a
                     // 5th or 6th wednesday of the month.
                     if (isset($dayHits[$offset - 1])) {
                         $byDayResults[] = $dayHits[$offset - 1];
                     }
                 } else {
 
                     // if it was negative we count from the end of the array
                     // might not exist, fx. -5th tuesday
                     if (isset($dayHits[count($dayHits) + $offset])) {
                         $byDayResults[] = $dayHits[count($dayHits) + $offset];
                     }
                 }
             } else {
                 // There was no counter (first, second, last wednesdays), so we
                 // just need to add the all to the list).
                 $byDayResults = array_merge($byDayResults, $dayHits);
 
             }
 
         }
 
         $byMonthDayResults = [];
         if ($this->byMonthDay) foreach ($this->byMonthDay as $monthDay) {
 
             // Removing values that are out of range for this month
             if ($monthDay > $startDate->format('t') ||
                 $monthDay < 0 - $startDate->format('t')) {
                     continue;
             }
             if ($monthDay > 0) {
                 $byMonthDayResults[] = $monthDay;
             } else {
                 // Negative values
                 $byMonthDayResults[] = $startDate->format('t') + 1 + $monthDay;
             }
         }
 
         // If there was just byDay or just byMonthDay, they just specify our
         // (almost) final list. If both were provided, then byDay limits the
         // list.
         if ($this->byMonthDay && $this->byDay) {
             $result = array_intersect($byMonthDayResults, $byDayResults);
         } elseif ($this->byMonthDay) {
             $result = $byMonthDayResults;
         } else {
             $result = $byDayResults;
         }
         $result = array_unique($result);
         sort($result, SORT_NUMERIC);
 
         // The last thing that needs checking is the BYSETPOS. If it's set, it
         // means only certain items in the set survive the filter.
         if (!$this->bySetPos) {
             return $result;
         }
 
         $filteredResult = [];
         foreach ($this->bySetPos as $setPos) {
 
             if ($setPos < 0) {
                 $setPos = count($result) + ($setPos + 1);
             }
             if (isset($result[$setPos - 1])) {
                 $filteredResult[] = $result[$setPos - 1];
             }
         }
 
         sort($filteredResult, SORT_NUMERIC);
         return $filteredResult;
 
     }

Here is the caller graph for this function:

◆ getMonths()

Sabre\VObject\Recur\RRuleIterator::getMonths ( )

protected

Definition at line 1004 of file RRuleIterator.php.

References Sabre\VObject\Recur\RRuleIterator\$byMonth.

Referenced by Sabre\VObject\Recur\RRuleIterator\nextDaily().

                                    {
 
         $recurrenceMonths = [];
         foreach ($this->byMonth as $byMonth) {
             $recurrenceMonths[] = $byMonth;
         }
 
         return $recurrenceMonths;
     }

Here is the caller graph for this function:

◆ isInfinite()

Sabre\VObject\Recur\RRuleIterator::isInfinite ( )

Returns true if this recurring event never ends.

Returns: bool

Definition at line 132 of file RRuleIterator.php.

References Sabre\VObject\Recur\RRuleIterator\$until.

                           {
 
         return !$this->count && !$this->until;
 
     }

◆ key()

Sabre\VObject\Recur\RRuleIterator::key ( )

Returns the current item number.

Returns: int

Definition at line 55 of file RRuleIterator.php.

References Sabre\VObject\Recur\RRuleIterator\$counter.

                    {
 
         return $this->counter;
 
     }

◆ next()

Sabre\VObject\Recur\RRuleIterator::next ( )

Goes on to the next iteration.

Returns: void

Definition at line 94 of file RRuleIterator.php.

References Sabre\VObject\Recur\RRuleIterator\nextDaily(), Sabre\VObject\Recur\RRuleIterator\nextHourly(), Sabre\VObject\Recur\RRuleIterator\nextMonthly(), Sabre\VObject\Recur\RRuleIterator\nextWeekly(), and Sabre\VObject\Recur\RRuleIterator\nextYearly().

Referenced by Sabre\VObject\Recur\RRuleIterator\fastForward().

                     {
 
         // Otherwise, we find the next event in the normal RRULE
         // sequence.
         switch ($this->frequency) {
 
             case 'hourly' :
                 $this->nextHourly();
                 break;
 
             case 'daily' :
                 $this->nextDaily();
                 break;
 
             case 'weekly' :
                 $this->nextWeekly();
                 break;
 
             case 'monthly' :
                 $this->nextMonthly();
                 break;
 
             case 'yearly' :
                 $this->nextYearly();
                 break;
 
         }
         $this->counter++;
 
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nextDaily()

Sabre\VObject\Recur\RRuleIterator::nextDaily ( )

protected

Does the processing for advancing the iterator for daily frequency.

Returns: void

Definition at line 334 of file RRuleIterator.php.

References Sabre\VObject\Recur\RRuleIterator\getDays(), Sabre\VObject\Recur\RRuleIterator\getHours(), and Sabre\VObject\Recur\RRuleIterator\getMonths().

Referenced by Sabre\VObject\Recur\RRuleIterator\next().

                                    {
 
         if (!$this->byHour && !$this->byDay) {
             $this->currentDate = $this->currentDate->modify('+' . $this->interval . ' days');
             return;
         }
 
         if (!empty($this->byHour)) {
             $recurrenceHours = $this->getHours();
         }
 
         if (!empty($this->byDay)) {
             $recurrenceDays = $this->getDays();
         }
 
         if (!empty($this->byMonth)) {
             $recurrenceMonths = $this->getMonths();
         }
 
         do {
             if ($this->byHour) {
                 if ($this->currentDate->format('G') == '23') {
                     // to obey the interval rule
                     $this->currentDate = $this->currentDate->modify('+' . $this->interval - 1 . ' days');
                 }
 
                 $this->currentDate = $this->currentDate->modify('+1 hours');
 
             } else {
                 $this->currentDate = $this->currentDate->modify('+' . $this->interval . ' days');
 
             }
 
             // Current month of the year
             $currentMonth = $this->currentDate->format('n');
 
             // Current day of the week
             $currentDay = $this->currentDate->format('w');
 
             // Current hour of the day
             $currentHour = $this->currentDate->format('G');
 
         } while (
             ($this->byDay && !in_array($currentDay, $recurrenceDays)) ||
             ($this->byHour && !in_array($currentHour, $recurrenceHours)) ||
             ($this->byMonth && !in_array($currentMonth, $recurrenceMonths))
         );
 
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nextHourly()

Sabre\VObject\Recur\RRuleIterator::nextHourly ( )

protected

Does the processing for advancing the iterator for hourly frequency.

Returns: void

Definition at line 323 of file RRuleIterator.php.

Referenced by Sabre\VObject\Recur\RRuleIterator\next().

                                     {
 
         $this->currentDate = $this->currentDate->modify('+' . $this->interval . ' hours');
 
     }

Here is the caller graph for this function:

◆ nextMonthly()

Sabre\VObject\Recur\RRuleIterator::nextMonthly ( )

protected

Does the processing for advancing the iterator for monthly frequency.

Returns: void

Definition at line 441 of file RRuleIterator.php.

References Sabre\VObject\Recur\RRuleIterator\$currentDate, and Sabre\VObject\Recur\RRuleIterator\getMonthlyOccurrences().

Referenced by Sabre\VObject\Recur\RRuleIterator\next().

                                      {
 
         $currentDayOfMonth = $this->currentDate->format('j');
         if (!$this->byMonthDay && !$this->byDay) {
 
             // If the current day is higher than the 28th, rollover can
             // occur to the next month. We Must skip these invalid
             // entries.
             if ($currentDayOfMonth < 29) {
                 $this->currentDate = $this->currentDate->modify('+' . $this->interval . ' months');
             } else {
                 $increase = 0;
                 do {
                     $increase++;
                     $tempDate = clone $this->currentDate;
                     $tempDate = $tempDate->modify('+ ' . ($this->interval * $increase) . ' months');
                 } while ($tempDate->format('j') != $currentDayOfMonth);
                 $this->currentDate = $tempDate;
             }
             return;
         }
 
         while (true) {
 
             $occurrences = $this->getMonthlyOccurrences();
 
             foreach ($occurrences as $occurrence) {
 
                 // The first occurrence thats higher than the current
                 // day of the month wins.
                 if ($occurrence > $currentDayOfMonth) {
                     break 2;
                 }
 
             }
 
             // If we made it all the way here, it means there were no
             // valid occurrences, and we need to advance to the next
             // month.
             //
             // This line does not currently work in hhvm. Temporary workaround
             // follows:
             // $this->currentDate->modify('first day of this month');
             $this->currentDate = new DateTimeImmutable($this->currentDate->format('Y-m-1 H:i:s'), $this->currentDate->getTimezone());
             // end of workaround
             $this->currentDate = $this->currentDate->modify('+ ' . $this->interval . ' months');
 
             // This goes to 0 because we need to start counting at the
             // beginning.
             $currentDayOfMonth = 0;
 
         }
 
         $this->currentDate = $this->currentDate->setDate(
             (int)$this->currentDate->format('Y'),
             (int)$this->currentDate->format('n'),
             (int)$occurrence
         );
 
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nextWeekly()

Sabre\VObject\Recur\RRuleIterator::nextWeekly ( )

protected

Does the processing for advancing the iterator for weekly frequency.

Returns: void

Definition at line 389 of file RRuleIterator.php.

References Sabre\VObject\Recur\RRuleIterator\$weekStart, Sabre\VObject\Recur\RRuleIterator\getDays(), and Sabre\VObject\Recur\RRuleIterator\getHours().

Referenced by Sabre\VObject\Recur\RRuleIterator\next().

                                     {
 
         if (!$this->byHour && !$this->byDay) {
             $this->currentDate = $this->currentDate->modify('+' . $this->interval . ' weeks');
             return;
         }
 
         if ($this->byHour) {
             $recurrenceHours = $this->getHours();
         }
 
         if ($this->byDay) {
             $recurrenceDays = $this->getDays();
         }
 
         // First day of the week:
         $firstDay = $this->dayMap[$this->weekStart];
 
         do {
 
             if ($this->byHour) {
                 $this->currentDate = $this->currentDate->modify('+1 hours');
             } else {
                 $this->currentDate = $this->currentDate->modify('+1 days');
             }
 
             // Current day of the week
             $currentDay = (int)$this->currentDate->format('w');
 
             // Current hour of the day
             $currentHour = (int)$this->currentDate->format('G');
 
             // We need to roll over to the next week
             if ($currentDay === $firstDay && (!$this->byHour || $currentHour == '0')) {
                 $this->currentDate = $this->currentDate->modify('+' . $this->interval - 1 . ' weeks');
 
                 // We need to go to the first day of this week, but only if we
                 // are not already on this first day of this week.
                 if ($this->currentDate->format('w') != $firstDay) {
                     $this->currentDate = $this->currentDate->modify('last ' . $this->dayNames[$this->dayMap[$this->weekStart]]);
                 }
             }
 
             // We have a match
         } while (($this->byDay && !in_array($currentDay, $recurrenceDays)) || ($this->byHour && !in_array($currentHour, $recurrenceHours)));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nextYearly()

Sabre\VObject\Recur\RRuleIterator::nextYearly ( )

protected

Does the processing for advancing the iterator for yearly frequency.

Returns: void

Definition at line 507 of file RRuleIterator.php.

References Sabre\VObject\Recur\RRuleIterator\$byDay, Sabre\VObject\Recur\RRuleIterator\$byWeekNo, Sabre\VObject\Recur\RRuleIterator\$byYearDay, Sabre\VObject\Recur\RRuleIterator\$counter, Sabre\VObject\Recur\RRuleIterator\$currentDate, Sabre\VObject\Recur\RRuleIterator\$interval, and Sabre\VObject\Recur\RRuleIterator\getMonthlyOccurrences().

Referenced by Sabre\VObject\Recur\RRuleIterator\next().

                                     {
 
         $currentMonth = $this->currentDate->format('n');
         $currentYear = $this->currentDate->format('Y');
         $currentDayOfMonth = $this->currentDate->format('j');
 
         // No sub-rules, so we just advance by year
         if (empty($this->byMonth)) {
 
             // Unless it was a leap day!
             if ($currentMonth == 2 && $currentDayOfMonth == 29) {
 
                 $counter = 0;
                 do {
                     $counter++;
                     // Here we increase the year count by the interval, until
                     // we hit a date that's also in a leap year.
                     //
                     // We could just find the next interval that's dividable by
                     // 4, but that would ignore the rule that there's no leap
                     // year every year that's dividable by a 100, but not by
                     // 400. (1800, 1900, 2100). So we just rely on the datetime
                     // functions instead.
                     $nextDate = clone $this->currentDate;
                     $nextDate = $nextDate->modify('+ ' . ($this->interval * $counter) . ' years');
                 } while ($nextDate->format('n') != 2);
 
                 $this->currentDate = $nextDate;
 
                 return;
 
             }
 
             if ($this->byWeekNo !== null) { // byWeekNo is an array with values from -53 to -1, or 1 to 53
                 $dayOffsets = [];
                 if ($this->byDay) {
                     foreach ($this->byDay as $byDay) {
                         $dayOffsets[] = $this->dayMap[$byDay];
                     }
                 } else {   // default is Monday
                     $dayOffsets[] = 1;
                 }
 
                 $currentYear = $this->currentDate->format('Y');
 
                 while (true) {
                     $checkDates = [];
 
                     // loop through all WeekNo and Days to check all the combinations
                     foreach ($this->byWeekNo as $byWeekNo) {
                         foreach ($dayOffsets as $dayOffset) {
                             $date = clone $this->currentDate;
                             $date->setISODate($currentYear, $byWeekNo, $dayOffset);
 
                             if ($date > $this->currentDate) {
                                 $checkDates[] = $date;
                             }
                         }
                     }
 
                     if (count($checkDates) > 0) {
                         $this->currentDate = min($checkDates);
                         return;
                     }
 
                     // if there is no date found, check the next year
                     $currentYear += $this->interval;
                 }
             }
 
             if ($this->byYearDay !== null) { // byYearDay is an array with values from -366 to -1, or 1 to 366
                 $dayOffsets = [];
                 if ($this->byDay) {
                     foreach ($this->byDay as $byDay) {
                         $dayOffsets[] = $this->dayMap[$byDay];
                     }
                 } else {   // default is Monday-Sunday
                     $dayOffsets = [1,2,3,4,5,6,7];
                 }
 
                 $currentYear = $this->currentDate->format('Y');
 
                 while (true) {
                     $checkDates = [];
 
                     // loop through all YearDay and Days to check all the combinations
                     foreach ($this->byYearDay as $byYearDay) {
                         $date = clone $this->currentDate;
                         $date = $date->setDate($currentYear, 1, 1);
                         if ($byYearDay > 0) {
                             $date = $date->add(new \DateInterval('P' . $byYearDay . 'D'));
                         } else {
                             $date = $date->sub(new \DateInterval('P' . abs($byYearDay) . 'D'));
                         }
 
                         if ($date > $this->currentDate && in_array($date->format('N'), $dayOffsets)) {
                             $checkDates[] = $date;
                         }
                     }
 
                     if (count($checkDates) > 0) {
                         $this->currentDate = min($checkDates);
                         return;
                     }
 
                     // if there is no date found, check the next year
                     $currentYear += $this->interval;
                 }
             }
 
             // The easiest form
             $this->currentDate = $this->currentDate->modify('+' . $this->interval . ' years');
             return;
 
         }
 
         $currentMonth = $this->currentDate->format('n');
         $currentYear = $this->currentDate->format('Y');
         $currentDayOfMonth = $this->currentDate->format('j');
 
         $advancedToNewMonth = false;
 
         // If we got a byDay or getMonthDay filter, we must first expand
         // further.
         if ($this->byDay || $this->byMonthDay) {
 
             while (true) {
 
                 $occurrences = $this->getMonthlyOccurrences();
 
                 foreach ($occurrences as $occurrence) {
 
                     // The first occurrence that's higher than the current
                     // day of the month wins.
                     // If we advanced to the next month or year, the first
                     // occurrence is always correct.
                     if ($occurrence > $currentDayOfMonth || $advancedToNewMonth) {
                         break 2;
                     }
 
                 }
 
                 // If we made it here, it means we need to advance to
                 // the next month or year.
                 $currentDayOfMonth = 1;
                 $advancedToNewMonth = true;
                 do {
 
                     $currentMonth++;
                     if ($currentMonth > 12) {
                         $currentYear += $this->interval;
                         $currentMonth = 1;
                     }
                 } while (!in_array($currentMonth, $this->byMonth));
 
                 $this->currentDate = $this->currentDate->setDate(
                     (int)$currentYear,
                     (int)$currentMonth,
                     (int)$currentDayOfMonth
                 );
 
             }
 
             // If we made it here, it means we got a valid occurrence
             $this->currentDate = $this->currentDate->setDate(
                 (int)$currentYear,
                 (int)$currentMonth,
                 (int)$occurrence
             );
             return;
 
         } else {
 
             // These are the 'byMonth' rules, if there are no byDay or
             // byMonthDay sub-rules.
             do {
 
                 $currentMonth++;
                 if ($currentMonth > 12) {
                     $currentYear += $this->interval;
                     $currentMonth = 1;
                 }
             } while (!in_array($currentMonth, $this->byMonth));
             $this->currentDate = $this->currentDate->setDate(
                 (int)$currentYear,
                 (int)$currentMonth,
                 (int)$currentDayOfMonth
             );
 
             return;
 
         }
 
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseRRule()

Sabre\VObject\Recur\RRuleIterator::parseRRule ( $rrule )

protected

This method receives a string from an RRULE property, and populates this class with all the values.

Parameters

string | array $rrule

Returns: void

Definition at line 712 of file RRuleIterator.php.

References Sabre\VObject\Recur\RRuleIterator\$byMonth, Sabre\VObject\Recur\RRuleIterator\$byWeekNo, Sabre\VObject\Recur\RRuleIterator\$byYearDay, $key, Sabre\VObject\Recur\RRuleIterator\$startDate, Sabre\VObject\DateTimeParser\parse(), and Sabre\VObject\Property\ICalendar\Recur\stringToArray().

Referenced by Sabre\VObject\Recur\RRuleIterator\__construct().

                                           {
 
         if (is_string($rrule)) {
             $rrule = Property\ICalendar\Recur::stringToArray($rrule);
         }
 
         foreach ($rrule as $key => $value) {
 
             $key = strtoupper($key);
             switch ($key) {
 
                 case 'FREQ' :
                     $value = strtolower($value);
                     if (!in_array(
                         $value,
                         ['secondly', 'minutely', 'hourly', 'daily', 'weekly', 'monthly', 'yearly']
                     )) {
                         throw new InvalidDataException('Unknown value for FREQ=' . strtoupper($value));
                     }
                     $this->frequency = $value;
                     break;
 
                 case 'UNTIL' :
                     $this->until = DateTimeParser::parse($value, $this->startDate->getTimezone());
 
                     // In some cases events are generated with an UNTIL=
                     // parameter before the actual start of the event.
                     //
                     // Not sure why this is happening. We assume that the
                     // intention was that the event only recurs once.
                     //
                     // So we are modifying the parameter so our code doesn't
                     // break.
                     if ($this->until < $this->startDate) {
                         $this->until = $this->startDate;
                     }
                     break;
 
                 case 'INTERVAL' :
                     // No break
 
                 case 'COUNT' :
                     $val = (int)$value;
                     if ($val < 1) {
                         throw new InvalidDataException(strtoupper($key) . ' in RRULE must be a positive integer!');
                     }
                     $key = strtolower($key);
                     $this->$key = $val;
                     break;
 
                 case 'BYSECOND' :
                     $this->bySecond = (array)$value;
                     break;
 
                 case 'BYMINUTE' :
                     $this->byMinute = (array)$value;
                     break;
 
                 case 'BYHOUR' :
                     $this->byHour = (array)$value;
                     break;
 
                 case 'BYDAY' :
                     $value = (array)$value;
                     foreach ($value as $part) {
                         if (!preg_match('#^  (-|\+)? ([1-5])? (MO|TU|WE|TH|FR|SA|SU) $# xi', $part)) {
                             throw new InvalidDataException('Invalid part in BYDAY clause: ' . $part);
                         }
                     }
                     $this->byDay = $value;
                     break;
 
                 case 'BYMONTHDAY' :
                     $this->byMonthDay = (array)$value;
                     break;
 
                 case 'BYYEARDAY' :
                     $this->byYearDay = (array)$value;
                     foreach ($this->byYearDay as $byYearDay) {
                         if (!is_numeric($byYearDay) || (int)$byYearDay < -366 || (int)$byYearDay == 0 || (int)$byYearDay > 366) {
                             throw new InvalidDataException('BYYEARDAY in RRULE must have value(s) from 1 to 366, or -366 to -1!');
                         }
                     }
                     break;
 
                 case 'BYWEEKNO' :
                     $this->byWeekNo = (array)$value;
                     foreach ($this->byWeekNo as $byWeekNo) {
                         if (!is_numeric($byWeekNo) || (int)$byWeekNo < -53 || (int)$byWeekNo == 0 || (int)$byWeekNo > 53) {
                             throw new InvalidDataException('BYWEEKNO in RRULE must have value(s) from 1 to 53, or -53 to -1!');
                         }
                     }
                     break;
 
                 case 'BYMONTH' :
                     $this->byMonth = (array)$value;
                     foreach ($this->byMonth as $byMonth) {
                         if (!is_numeric($byMonth) || (int)$byMonth < 1 || (int)$byMonth > 12) {
                             throw new InvalidDataException('BYMONTH in RRULE must have value(s) betweeen 1 and 12!');
                         }
                     }
                     break;
 
                 case 'BYSETPOS' :
                     $this->bySetPos = (array)$value;
                     break;
 
                 case 'WKST' :
                     $this->weekStart = strtoupper($value);
                     break;
 
                 default:
                     throw new InvalidDataException('Not supported: ' . strtoupper($key));
 
             }
 
         }
 
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rewind()

Sabre\VObject\Recur\RRuleIterator::rewind ( )

Resets the iterator.

Returns: void

Definition at line 82 of file RRuleIterator.php.

References Sabre\VObject\Recur\RRuleIterator\$startDate.

                       {
 
         $this->currentDate = clone $this->startDate;
         $this->counter = 0;
 
     }

◆ valid()

Sabre\VObject\Recur\RRuleIterator::valid ( )

Returns whether the current item is a valid item for the recurrence iterator.

This will return false if we've gone beyond the UNTIL or COUNT statements.

Returns: bool

Definition at line 68 of file RRuleIterator.php.

References Sabre\VObject\Recur\RRuleIterator\$count, and Sabre\VObject\Recur\RRuleIterator\$until.

Referenced by Sabre\VObject\Recur\RRuleIterator\current(), and Sabre\VObject\Recur\RRuleIterator\fastForward().

                      {
 
         if (!is_null($this->count)) {
             return $this->counter < $this->count;
         }
         return is_null($this->until) || $this->currentDate <= $this->until;
 
     }

Here is the caller graph for this function:

Field Documentation

◆ $byDay

Sabre\VObject\Recur\RRuleIterator::$byDay

protected

Definition at line 251 of file RRuleIterator.php.

Referenced by Sabre\VObject\Recur\RRuleIterator\getDays(), and Sabre\VObject\Recur\RRuleIterator\nextYearly().

◆ $byHour

Sabre\VObject\Recur\RRuleIterator::$byHour

protected

Definition at line 228 of file RRuleIterator.php.

Referenced by Sabre\VObject\Recur\RRuleIterator\getHours().

◆ $byMinute

Sabre\VObject\Recur\RRuleIterator::$byMinute

protected

Definition at line 219 of file RRuleIterator.php.

◆ $byMonth

Sabre\VObject\Recur\RRuleIterator::$byMonth

protected

Definition at line 291 of file RRuleIterator.php.

Referenced by Sabre\VObject\Recur\RRuleIterator\getMonths(), and Sabre\VObject\Recur\RRuleIterator\parseRRule().

◆ $byMonthDay

Sabre\VObject\Recur\RRuleIterator::$byMonthDay

protected

Definition at line 261 of file RRuleIterator.php.

◆ $bySecond

Sabre\VObject\Recur\RRuleIterator::$bySecond

protected

Definition at line 210 of file RRuleIterator.php.

◆ $bySetPos

Sabre\VObject\Recur\RRuleIterator::$bySetPos

protected

Definition at line 307 of file RRuleIterator.php.

◆ $byWeekNo

Sabre\VObject\Recur\RRuleIterator::$byWeekNo

protected

Definition at line 282 of file RRuleIterator.php.

Referenced by Sabre\VObject\Recur\RRuleIterator\nextYearly(), and Sabre\VObject\Recur\RRuleIterator\parseRRule().

◆ $byYearDay

Sabre\VObject\Recur\RRuleIterator::$byYearDay

protected

Definition at line 272 of file RRuleIterator.php.

Referenced by Sabre\VObject\Recur\RRuleIterator\nextYearly(), and Sabre\VObject\Recur\RRuleIterator\parseRRule().

◆ $count

Sabre\VObject\Recur\RRuleIterator::$count

protected

Definition at line 184 of file RRuleIterator.php.

Referenced by Sabre\VObject\Recur\RRuleIterator\valid().

◆ $counter

Sabre\VObject\Recur\RRuleIterator::$counter = 0

protected

Definition at line 237 of file RRuleIterator.php.

Referenced by Sabre\VObject\Recur\RRuleIterator\key(), and Sabre\VObject\Recur\RRuleIterator\nextYearly().

◆ $currentDate

Sabre\VObject\Recur\RRuleIterator::$currentDate

protected

Definition at line 169 of file RRuleIterator.php.

Referenced by Sabre\VObject\Recur\RRuleIterator\current(), Sabre\VObject\Recur\RRuleIterator\getMonthlyOccurrences(), Sabre\VObject\Recur\RRuleIterator\nextMonthly(), and Sabre\VObject\Recur\RRuleIterator\nextYearly().

◆ $dayMap

Sabre\VObject\Recur\RRuleIterator::$dayMap

protected

Initial value:

= [

'SU' => 0

Definition at line 969 of file RRuleIterator.php.

◆ $dayNames

Sabre\VObject\Recur\RRuleIterator::$dayNames

protected

Initial value:

= [

0 => 'Sunday'

Definition at line 837 of file RRuleIterator.php.

◆ $frequency

Sabre\VObject\Recur\RRuleIterator::$frequency

protected

Definition at line 177 of file RRuleIterator.php.

◆ $interval

Sabre\VObject\Recur\RRuleIterator::$interval = 1

protected

Definition at line 194 of file RRuleIterator.php.

Referenced by Sabre\VObject\Recur\RRuleIterator\nextYearly().

◆ $startDate

Sabre\VObject\Recur\RRuleIterator::$startDate

protected

Definition at line 161 of file RRuleIterator.php.

Referenced by Sabre\VObject\Recur\RRuleIterator\__construct(), Sabre\VObject\Recur\RRuleIterator\getMonthlyOccurrences(), Sabre\VObject\Recur\RRuleIterator\parseRRule(), and Sabre\VObject\Recur\RRuleIterator\rewind().

◆ $until

Sabre\VObject\Recur\RRuleIterator::$until

protected

Definition at line 201 of file RRuleIterator.php.

Referenced by Sabre\VObject\Recur\RRuleIterator\isInfinite(), and Sabre\VObject\Recur\RRuleIterator\valid().

◆ $weekStart

Sabre\VObject\Recur\RRuleIterator::$weekStart = 'MO'

protected

Definition at line 314 of file RRuleIterator.php.

Referenced by Sabre\VObject\Recur\RRuleIterator\nextWeekly().

The documentation for this class was generated from the following file:

libs/composer/vendor/sabre/vobject/lib/Recur/RRuleIterator.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ current()

◆ fastForward()

◆ getDays()

◆ getHours()

◆ getMonthlyOccurrences()

◆ getMonths()

◆ isInfinite()

◆ key()

◆ next()

◆ nextDaily()

◆ nextHourly()

◆ nextMonthly()

◆ nextWeekly()

◆ nextYearly()

◆ parseRRule()

◆ rewind()

◆ valid()

Field Documentation

◆ $byDay

◆ $byHour

◆ $byMinute

◆ $byMonth

◆ $byMonthDay

◆ $bySecond

◆ $bySetPos

◆ $byWeekNo

◆ $byYearDay

◆ $count

◆ $counter

◆ $currentDate

◆ $dayMap

◆ $dayNames

◆ $frequency

◆ $interval

◆ $startDate

◆ $until

◆ $weekStart