blob: f44960e123f9c373c3744bf659037c902660bb87 (
plain) (
tree)
|
|
<?php
namespace Sabre\VObject\Recur;
use DateTimeInterface;
use Iterator;
use Sabre\VObject\DateTimeParser;
/**
* 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/)
* @license http://sabre.io/license/ Modified BSD License
*/
class RDateIterator implements Iterator {
/**
* Creates the Iterator.
*
* @param string|array $rrule
* @param DateTimeInterface $start
*/
function __construct($rrule, DateTimeInterface $start) {
$this->startDate = $start;
$this->parseRDate($rrule);
$this->currentDate = clone $this->startDate;
}
/* Implementation of the Iterator interface {{{ */
function current() {
if (!$this->valid()) return;
return clone $this->currentDate;
}
/**
* Returns the current item number.
*
* @return int
*/
function key() {
return $this->counter;
}
/**
* Returns whether the current item is a valid item for the recurrence
* iterator.
*
* @return bool
*/
function valid() {
return ($this->counter <= count($this->dates));
}
/**
* Resets the iterator.
*
* @return void
*/
function rewind() {
$this->currentDate = clone $this->startDate;
$this->counter = 0;
}
/**
* Goes on to the next iteration.
*
* @return void
*/
function next() {
$this->counter++;
if (!$this->valid()) return;
$this->currentDate =
DateTimeParser::parse(
$this->dates[$this->counter - 1],
$this->startDate->getTimezone()
);
}
/* End of Iterator implementation }}} */
/**
* Returns true if this recurring event never ends.
*
* @return bool
*/
function isInfinite() {
return false;
}
/**
* This method allows you to quickly go to the next occurrence after the
* specified date.
*
* @param DateTimeInterface $dt
*
* @return void
*/
function fastForward(DateTimeInterface $dt) {
while ($this->valid() && $this->currentDate < $dt) {
$this->next();
}
}
/**
* The reference start date/time for the rrule.
*
* All calculations are based on this initial date.
*
* @var DateTimeInterface
*/
protected $startDate;
/**
* The date of the current iteration. You can get this by calling
* ->current().
*
* @var DateTimeInterface
*/
protected $currentDate;
/**
* The current item in the list.
*
* You can get this number with the key() method.
*
* @var int
*/
protected $counter = 0;
/* }}} */
/**
* This method receives a string from an RRULE property, and populates this
* class with all the values.
*
* @param string|array $rrule
*
* @return void
*/
protected function parseRDate($rdate) {
if (is_string($rdate)) {
$rdate = explode(',', $rdate);
}
$this->dates = $rdate;
}
/**
* Array with the RRULE dates
*
* @var array
*/
protected $dates = [];
}
|
