Sabre\VObject\Recur\RDateIterator Class Reference

RRuleParser. More...

Inheritance diagram for Sabre\VObject\Recur\RDateIterator:

Collaboration diagram for Sabre\VObject\Recur\RDateIterator:

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
	parseRDate ($rdate)
	This method receives a string from an RRULE property, and populates this class with all the values. More...

Protected Attributes
	$startDate
	$currentDate
	$counter = 0
	$dates = []

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 22 of file RDateIterator.php.

Constructor & Destructor Documentation

__construct()

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

Creates the Iterator.

Parameters

string | array	$rrule
DateTimeInterface	$start

Definition at line 30 of file RDateIterator.php.

References $start, Sabre\VObject\Recur\RDateIterator\$startDate, and Sabre\VObject\Recur\RDateIterator\parseRDate().

                                                           {

        $this->startDate = $start;
        $this->parseRDate($rrule);
        $this->currentDate = clone $this->startDate;

    }

Here is the call graph for this function:

Member Function Documentation

current()

Sabre\VObject\Recur\RDateIterator::current

(

)

Definition at line 40 of file RDateIterator.php.

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

                       {

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

    }

Here is the call graph for this function:

fastForward()

Sabre\VObject\Recur\RDateIterator::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 121 of file RDateIterator.php.

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

                                                {

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

    }

Here is the call graph for this function:

isInfinite()

Sabre\VObject\Recur\RDateIterator::isInfinite

(

)

Returns true if this recurring event never ends.

Returns

bool

Definition at line 107 of file RDateIterator.php.

                          {

        return false;

    }

key()

Sabre\VObject\Recur\RDateIterator::key

(

)

Returns the current item number.

Returns

int

Definition at line 52 of file RDateIterator.php.

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

                   {

        return $this->counter;

    }

next()

Sabre\VObject\Recur\RDateIterator::next

(

)

Goes on to the next iteration.

Returns

void

Definition at line 87 of file RDateIterator.php.

References Sabre\VObject\DateTimeParser\parse(), and Sabre\VObject\Recur\RDateIterator\valid().

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

                    {

        $this->counter++;
        if (!$this->valid()) return;

        $this->currentDate =
            DateTimeParser::parse(
                $this->dates[$this->counter - 1],
                $this->startDate->getTimezone()
            );

    }

Here is the call graph for this function:

Here is the caller graph for this function:

parseRDate()

Sabre\VObject\Recur\RDateIterator::parseRDate (   $rdate )

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 165 of file RDateIterator.php.

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

                                          {

        if (is_string($rdate)) {
            $rdate = explode(',', $rdate);
        }

        $this->dates = $rdate;

    }

Here is the caller graph for this function:

rewind()

Sabre\VObject\Recur\RDateIterator::rewind

(

)

Resets the iterator.

Returns

void

Definition at line 75 of file RDateIterator.php.

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

                      {

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

    }

valid()

Sabre\VObject\Recur\RDateIterator::valid

(

)

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

Returns

bool

Definition at line 64 of file RDateIterator.php.

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

                     {

        return ($this->counter <= count($this->dates));

    }

Here is the caller graph for this function:

Field Documentation

$counter

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

protected

Definition at line 153 of file RDateIterator.php.

Referenced by Sabre\VObject\Recur\RDateIterator\key().

$currentDate

Sabre\VObject\Recur\RDateIterator::$currentDate

protected

Definition at line 144 of file RDateIterator.php.

Referenced by Sabre\VObject\Recur\RDateIterator\current().

$dates

Sabre\VObject\Recur\RDateIterator::$dates = []

protected

Definition at line 180 of file RDateIterator.php.

$startDate

Sabre\VObject\Recur\RDateIterator::$startDate

protected

Definition at line 136 of file RDateIterator.php.

Referenced by Sabre\VObject\Recur\RDateIterator\__construct(), and Sabre\VObject\Recur\RDateIterator\rewind().

---

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

• libs/composer/vendor/sabre/vobject/lib/Recur/RDateIterator.php