Dolibarr / dolibarr

htdocs/includes/sabre/sabre/vobject/lib/TimezoneGuesser/GuessFromLicEntry.php

Indentation +14 added lines, -14 removed lines

@@ -13,21 +13,21 @@
  */
 class GuessFromLicEntry implements TimezoneGuesser
 {
-    public function guess(VTimeZone $vtimezone, bool $failIfUncertain = false): ?DateTimeZone
-    {
-        if (!isset($vtimezone->{'X-LIC-LOCATION'})) {
-            return null;
-        }
+	public function guess(VTimeZone $vtimezone, bool $failIfUncertain = false): ?DateTimeZone
+	{
+		if (!isset($vtimezone->{'X-LIC-LOCATION'})) {
+			return null;
+		}
 
-        $lic = (string) $vtimezone->{'X-LIC-LOCATION'};
+		$lic = (string) $vtimezone->{'X-LIC-LOCATION'};
 
-        // Libical generators may specify strings like
-        // "SystemV/EST5EDT". For those we must remove the
-        // SystemV part.
-        if ('SystemV/' === substr($lic, 0, 8)) {
-            $lic = substr($lic, 8);
-        }
+		// Libical generators may specify strings like
+		// "SystemV/EST5EDT". For those we must remove the
+		// SystemV part.
+		if ('SystemV/' === substr($lic, 0, 8)) {
+			$lic = substr($lic, 8);
+		}
 
-        return TimeZoneUtil::getTimeZone($lic, null, $failIfUncertain);
-    }
+		return TimeZoneUtil::getTimeZone($lic, null, $failIfUncertain);
+	}
 }

htdocs/includes/sabre/sabre/vobject/lib/ITip/Message.php

Indentation +105 added lines, -105 removed lines

@@ -16,121 +16,121 @@
  */
 class Message
 {
-    /**
-     * The object's UID.
-     *
-     * @var string
-     */
-    public $uid;
+	/**
+	 * The object's UID.
+	 *
+	 * @var string
+	 */
+	public $uid;
 
-    /**
-     * The component type, such as VEVENT.
-     *
-     * @var string
-     */
-    public $component;
+	/**
+	 * The component type, such as VEVENT.
+	 *
+	 * @var string
+	 */
+	public $component;
 
-    /**
-     * Contains the ITip method, which is something like REQUEST, REPLY or
-     * CANCEL.
-     *
-     * @var string
-     */
-    public $method;
+	/**
+	 * Contains the ITip method, which is something like REQUEST, REPLY or
+	 * CANCEL.
+	 *
+	 * @var string
+	 */
+	public $method;
 
-    /**
-     * The current sequence number for the event.
-     *
-     * @var int
-     */
-    public $sequence;
+	/**
+	 * The current sequence number for the event.
+	 *
+	 * @var int
+	 */
+	public $sequence;
 
-    /**
-     * The senders' email address.
-     *
-     * Note that this does not imply that this has to be used in a From: field
-     * if the message is sent by email. It may also be populated in Reply-To:
-     * or not at all.
-     *
-     * @var string
-     */
-    public $sender;
+	/**
+	 * The senders' email address.
+	 *
+	 * Note that this does not imply that this has to be used in a From: field
+	 * if the message is sent by email. It may also be populated in Reply-To:
+	 * or not at all.
+	 *
+	 * @var string
+	 */
+	public $sender;
 
-    /**
-     * The name of the sender. This is often populated from a CN parameter from
-     * either the ORGANIZER or ATTENDEE, depending on the message.
-     *
-     * @var string|null
-     */
-    public $senderName;
+	/**
+	 * The name of the sender. This is often populated from a CN parameter from
+	 * either the ORGANIZER or ATTENDEE, depending on the message.
+	 *
+	 * @var string|null
+	 */
+	public $senderName;
 
-    /**
-     * The recipient's email address.
-     *
-     * @var string
-     */
-    public $recipient;
+	/**
+	 * The recipient's email address.
+	 *
+	 * @var string
+	 */
+	public $recipient;
 
-    /**
-     * The name of the recipient. This is usually populated with the CN
-     * parameter from the ATTENDEE or ORGANIZER property, if it's available.
-     *
-     * @var string|null
-     */
-    public $recipientName;
+	/**
+	 * The name of the recipient. This is usually populated with the CN
+	 * parameter from the ATTENDEE or ORGANIZER property, if it's available.
+	 *
+	 * @var string|null
+	 */
+	public $recipientName;
 
-    /**
-     * After the message has been delivered, this should contain a string such
-     * as : 1.1;Sent or 1.2;Delivered.
-     *
-     * In case of a failure, this will hold the error status code.
-     *
-     * See:
-     * http://tools.ietf.org/html/rfc6638#section-7.3
-     *
-     * @var string
-     */
-    public $scheduleStatus;
+	/**
+	 * After the message has been delivered, this should contain a string such
+	 * as : 1.1;Sent or 1.2;Delivered.
+	 *
+	 * In case of a failure, this will hold the error status code.
+	 *
+	 * See:
+	 * http://tools.ietf.org/html/rfc6638#section-7.3
+	 *
+	 * @var string
+	 */
+	public $scheduleStatus;
 
-    /**
-     * The iCalendar / iTip body.
-     *
-     * @var \Sabre\VObject\Component\VCalendar
-     */
-    public $message;
+	/**
+	 * The iCalendar / iTip body.
+	 *
+	 * @var \Sabre\VObject\Component\VCalendar
+	 */
+	public $message;
 
-    /**
-     * This will be set to true, if the iTip broker considers the change
-     * 'significant'.
-     *
-     * In practice, this means that we'll only mark it true, if for instance
-     * DTSTART changed. This allows systems to only send iTip messages when
-     * significant changes happened. This is especially useful for iMip, as
-     * normally a ton of messages may be generated for normal calendar use.
-     *
-     * To see the list of properties that are considered 'significant', check
-     * out Sabre\VObject\ITip\Broker::$significantChangeProperties.
-     *
-     * @var bool
-     */
-    public $significantChange = true;
+	/**
+	 * This will be set to true, if the iTip broker considers the change
+	 * 'significant'.
+	 *
+	 * In practice, this means that we'll only mark it true, if for instance
+	 * DTSTART changed. This allows systems to only send iTip messages when
+	 * significant changes happened. This is especially useful for iMip, as
+	 * normally a ton of messages may be generated for normal calendar use.
+	 *
+	 * To see the list of properties that are considered 'significant', check
+	 * out Sabre\VObject\ITip\Broker::$significantChangeProperties.
+	 *
+	 * @var bool
+	 */
+	public $significantChange = true;
 
-    /**
-     * Returns the schedule status as a string.
-     *
-     * For example:
-     * 1.2
-     *
-     * @return mixed bool|string
-     */
-    public function getScheduleStatus()
-    {
-        if (!$this->scheduleStatus) {
-            return false;
-        } else {
-            list($scheduleStatus) = explode(';', $this->scheduleStatus);
+	/**
+	 * Returns the schedule status as a string.
+	 *
+	 * For example:
+	 * 1.2
+	 *
+	 * @return mixed bool|string
+	 */
+	public function getScheduleStatus()
+	{
+		if (!$this->scheduleStatus) {
+			return false;
+		} else {
+			list($scheduleStatus) = explode(';', $this->scheduleStatus);
 
-            return $scheduleStatus;
-        }
-    }
+			return $scheduleStatus;
+		}
+	}
 }

htdocs/includes/sabre/sabre/vobject/lib/Writer.php

Indentation +42 added lines, -42 removed lines

@@ -16,53 +16,53 @@
  */
 class Writer
 {
-    /**
-     * Serializes a vCard or iCalendar object.
-     *
-     * @return string
-     */
-    public static function write(Component $component)
-    {
-        return $component->serialize();
-    }
+	/**
+	 * Serializes a vCard or iCalendar object.
+	 *
+	 * @return string
+	 */
+	public static function write(Component $component)
+	{
+		return $component->serialize();
+	}
 
-    /**
-     * Serializes a jCal or jCard object.
-     *
-     * @param int $options
-     *
-     * @return string
-     */
-    public static function writeJson(Component $component, $options = 0)
-    {
-        return json_encode($component, $options);
-    }
+	/**
+	 * Serializes a jCal or jCard object.
+	 *
+	 * @param int $options
+	 *
+	 * @return string
+	 */
+	public static function writeJson(Component $component, $options = 0)
+	{
+		return json_encode($component, $options);
+	}
 
-    /**
-     * Serializes a xCal or xCard object.
-     *
-     * @return string
-     */
-    public static function writeXml(Component $component)
-    {
-        $writer = new Xml\Writer();
-        $writer->openMemory();
-        $writer->setIndent(true);
+	/**
+	 * Serializes a xCal or xCard object.
+	 *
+	 * @return string
+	 */
+	public static function writeXml(Component $component)
+	{
+		$writer = new Xml\Writer();
+		$writer->openMemory();
+		$writer->setIndent(true);
 
-        $writer->startDocument('1.0', 'utf-8');
+		$writer->startDocument('1.0', 'utf-8');
 
-        if ($component instanceof Component\VCalendar) {
-            $writer->startElement('icalendar');
-            $writer->writeAttribute('xmlns', Parser\XML::XCAL_NAMESPACE);
-        } else {
-            $writer->startElement('vcards');
-            $writer->writeAttribute('xmlns', Parser\XML::XCARD_NAMESPACE);
-        }
+		if ($component instanceof Component\VCalendar) {
+			$writer->startElement('icalendar');
+			$writer->writeAttribute('xmlns', Parser\XML::XCAL_NAMESPACE);
+		} else {
+			$writer->startElement('vcards');
+			$writer->writeAttribute('xmlns', Parser\XML::XCARD_NAMESPACE);
+		}
 
-        $component->xmlSerialize($writer);
+		$component->xmlSerialize($writer);
 
-        $writer->endElement();
+		$writer->endElement();
 
-        return $writer->outputMemory();
-    }
+		return $writer->outputMemory();
+	}
 }

htdocs/includes/sabre/sabre/vobject/lib/ElementList.php

Indentation +25 added lines, -25 removed lines

@@ -17,32 +17,32 @@
  */
 class ElementList extends ArrayIterator
 {
-    /* {{{ ArrayAccess Interface */
+	/* {{{ ArrayAccess Interface */
 
-    /**
-     * Sets an item through ArrayAccess.
-     *
-     * @param int   $offset
-     * @param mixed $value
-     */
-    #[\ReturnTypeWillChange]
-    public function offsetSet($offset, $value)
-    {
-        throw new LogicException('You can not add new objects to an ElementList');
-    }
+	/**
+	 * Sets an item through ArrayAccess.
+	 *
+	 * @param int   $offset
+	 * @param mixed $value
+	 */
+	#[\ReturnTypeWillChange]
+	public function offsetSet($offset, $value)
+	{
+		throw new LogicException('You can not add new objects to an ElementList');
+	}
 
-    /**
-     * Sets an item through ArrayAccess.
-     *
-     * This method just forwards the request to the inner iterator
-     *
-     * @param int $offset
-     */
-    #[\ReturnTypeWillChange]
-    public function offsetUnset($offset)
-    {
-        throw new LogicException('You can not remove objects from an ElementList');
-    }
+	/**
+	 * Sets an item through ArrayAccess.
+	 *
+	 * This method just forwards the request to the inner iterator
+	 *
+	 * @param int $offset
+	 */
+	#[\ReturnTypeWillChange]
+	public function offsetUnset($offset)
+	{
+		throw new LogicException('You can not remove objects from an ElementList');
+	}
 
-    /* }}} */
+	/* }}} */
 }

htdocs/includes/sabre/sabre/vobject/lib/Settings.php

Indentation +33 added lines, -33 removed lines

@@ -17,39 +17,39 @@
  */
 class Settings
 {
-    /**
-     * The minimum date we accept for various calculations with dates, such as
-     * recurrences.
-     *
-     * The choice of 1900 is pretty arbitrary, but it covers most common
-     * use-cases. In particular, it covers birthdates for virtually everyone
-     * alive on earth, which is less than 5 people at the time of writing.
-     */
-    public static $minDate = '1900-01-01';
+	/**
+	 * The minimum date we accept for various calculations with dates, such as
+	 * recurrences.
+	 *
+	 * The choice of 1900 is pretty arbitrary, but it covers most common
+	 * use-cases. In particular, it covers birthdates for virtually everyone
+	 * alive on earth, which is less than 5 people at the time of writing.
+	 */
+	public static $minDate = '1900-01-01';
 
-    /**
-     * The maximum date we accept for various calculations with dates, such as
-     * recurrences.
-     *
-     * The choice of 2100 is pretty arbitrary, but should cover most
-     * appointments made for many years to come.
-     */
-    public static $maxDate = '2100-01-01';
+	/**
+	 * The maximum date we accept for various calculations with dates, such as
+	 * recurrences.
+	 *
+	 * The choice of 2100 is pretty arbitrary, but should cover most
+	 * appointments made for many years to come.
+	 */
+	public static $maxDate = '2100-01-01';
 
-    /**
-     * The maximum number of recurrences that will be generated.
-     *
-     * This setting limits the maximum of recurring events that this library
-     * generates in its recurrence iterators.
-     *
-     * This is a security measure. Without this, it would be possible to craft
-     * specific events that recur many, many times, potentially DDOSing the
-     * server.
-     *
-     * The default (3500) allows creation of a daily event that goes on for 10
-     * years, which is hopefully long enough for most.
-     *
-     * Set this value to -1 to disable this control altogether.
-     */
-    public static $maxRecurrences = 3500;
+	/**
+	 * The maximum number of recurrences that will be generated.
+	 *
+	 * This setting limits the maximum of recurring events that this library
+	 * generates in its recurrence iterators.
+	 *
+	 * This is a security measure. Without this, it would be possible to craft
+	 * specific events that recur many, many times, potentially DDOSing the
+	 * server.
+	 *
+	 * The default (3500) allows creation of a daily event that goes on for 10
+	 * years, which is hopefully long enough for most.
+	 *
+	 * Set this value to -1 to disable this control altogether.
+	 */
+	public static $maxRecurrences = 3500;
 }

htdocs/includes/sabre/sabre/vobject/lib/Reader.php

Indentation +71 added lines, -71 removed lines

@@ -14,82 +14,82 @@
  */
 class Reader
 {
-    /**
-     * If this option is passed to the reader, it will be less strict about the
-     * validity of the lines.
-     */
-    const OPTION_FORGIVING = 1;
+	/**
+	 * If this option is passed to the reader, it will be less strict about the
+	 * validity of the lines.
+	 */
+	const OPTION_FORGIVING = 1;
 
-    /**
-     * If this option is turned on, any lines we cannot parse will be ignored
-     * by the reader.
-     */
-    const OPTION_IGNORE_INVALID_LINES = 2;
+	/**
+	 * If this option is turned on, any lines we cannot parse will be ignored
+	 * by the reader.
+	 */
+	const OPTION_IGNORE_INVALID_LINES = 2;
 
-    /**
-     * Parses a vCard or iCalendar object, and returns the top component.
-     *
-     * The options argument is a bitfield. Pass any of the OPTIONS constant to
-     * alter the parsers' behaviour.
-     *
-     * You can either supply a string, or a readable stream for input.
-     *
-     * @param string|resource $data
-     * @param int             $options
-     * @param string          $charset
-     *
-     * @return Document
-     */
-    public static function read($data, $options = 0, $charset = 'UTF-8')
-    {
-        $parser = new Parser\MimeDir();
-        $parser->setCharset($charset);
-        $result = $parser->parse($data, $options);
+	/**
+	 * Parses a vCard or iCalendar object, and returns the top component.
+	 *
+	 * The options argument is a bitfield. Pass any of the OPTIONS constant to
+	 * alter the parsers' behaviour.
+	 *
+	 * You can either supply a string, or a readable stream for input.
+	 *
+	 * @param string|resource $data
+	 * @param int             $options
+	 * @param string          $charset
+	 *
+	 * @return Document
+	 */
+	public static function read($data, $options = 0, $charset = 'UTF-8')
+	{
+		$parser = new Parser\MimeDir();
+		$parser->setCharset($charset);
+		$result = $parser->parse($data, $options);
 
-        return $result;
-    }
+		return $result;
+	}
 
-    /**
-     * Parses a jCard or jCal object, and returns the top component.
-     *
-     * The options argument is a bitfield. Pass any of the OPTIONS constant to
-     * alter the parsers' behaviour.
-     *
-     * You can either a string, a readable stream, or an array for its input.
-     * Specifying the array is useful if json_decode was already called on the
-     * input.
-     *
-     * @param string|resource|array $data
-     * @param int                   $options
-     *
-     * @return Document
-     */
-    public static function readJson($data, $options = 0)
-    {
-        $parser = new Parser\Json();
-        $result = $parser->parse($data, $options);
+	/**
+	 * Parses a jCard or jCal object, and returns the top component.
+	 *
+	 * The options argument is a bitfield. Pass any of the OPTIONS constant to
+	 * alter the parsers' behaviour.
+	 *
+	 * You can either a string, a readable stream, or an array for its input.
+	 * Specifying the array is useful if json_decode was already called on the
+	 * input.
+	 *
+	 * @param string|resource|array $data
+	 * @param int                   $options
+	 *
+	 * @return Document
+	 */
+	public static function readJson($data, $options = 0)
+	{
+		$parser = new Parser\Json();
+		$result = $parser->parse($data, $options);
 
-        return $result;
-    }
+		return $result;
+	}
 
-    /**
-     * Parses a xCard or xCal object, and returns the top component.
-     *
-     * The options argument is a bitfield. Pass any of the OPTIONS constant to
-     * alter the parsers' behaviour.
-     *
-     * You can either supply a string, or a readable stream for input.
-     *
-     * @param string|resource $data
-     * @param int             $options
-     *
-     * @return Document
-     */
-    public static function readXML($data, $options = 0)
-    {
-        $parser = new Parser\XML();
-        $result = $parser->parse($data, $options);
+	/**
+	 * Parses a xCard or xCal object, and returns the top component.
+	 *
+	 * The options argument is a bitfield. Pass any of the OPTIONS constant to
+	 * alter the parsers' behaviour.
+	 *
+	 * You can either supply a string, or a readable stream for input.
+	 *
+	 * @param string|resource $data
+	 * @param int             $options
+	 *
+	 * @return Document
+	 */
+	public static function readXML($data, $options = 0)
+	{
+		$parser = new Parser\XML();
+		$result = $parser->parse($data, $options);
 
-        return $result;
-    }
+		return $result;
+	}
 }

htdocs/includes/sabre/sabre/vobject/lib/StringUtil.php

Indentation +33 added lines, -33 removed lines

@@ -11,40 +11,40 @@
  */
 class StringUtil
 {
-    /**
-     * Returns true or false depending on if a string is valid UTF-8.
-     *
-     * @param string $str
-     *
-     * @return bool
-     */
-    public static function isUTF8($str)
-    {
-        // Control characters
-        if (preg_match('%[\x00-\x08\x0B-\x0C\x0E\x0F]%', $str)) {
-            return false;
-        }
+	/**
+	 * Returns true or false depending on if a string is valid UTF-8.
+	 *
+	 * @param string $str
+	 *
+	 * @return bool
+	 */
+	public static function isUTF8($str)
+	{
+		// Control characters
+		if (preg_match('%[\x00-\x08\x0B-\x0C\x0E\x0F]%', $str)) {
+			return false;
+		}
 
-        return (bool) preg_match('%%u', $str);
-    }
+		return (bool) preg_match('%%u', $str);
+	}
 
-    /**
-     * This method tries its best to convert the input string to UTF-8.
-     *
-     * Currently only ISO-5991-1 input and UTF-8 input is supported, but this
-     * may be expanded upon if we receive other examples.
-     *
-     * @param string $str
-     *
-     * @return string
-     */
-    public static function convertToUTF8($str)
-    {
-        if (!mb_check_encoding($str, 'UTF-8') && mb_check_encoding($str, 'ISO-8859-1')) {
-            $str = mb_convert_encoding($str, 'UTF-8', 'ISO-8859-1');
-        }
+	/**
+	 * This method tries its best to convert the input string to UTF-8.
+	 *
+	 * Currently only ISO-5991-1 input and UTF-8 input is supported, but this
+	 * may be expanded upon if we receive other examples.
+	 *
+	 * @param string $str
+	 *
+	 * @return string
+	 */
+	public static function convertToUTF8($str)
+	{
+		if (!mb_check_encoding($str, 'UTF-8') && mb_check_encoding($str, 'ISO-8859-1')) {
+			$str = mb_convert_encoding($str, 'UTF-8', 'ISO-8859-1');
+		}
 
-        // Removing any control characters
-        return preg_replace('%(?:[\x00-\x08\x0B-\x0C\x0E-\x1F\x7F])%', '', $str);
-    }
+		// Removing any control characters
+		return preg_replace('%(?:[\x00-\x08\x0B-\x0C\x0E-\x1F\x7F])%', '', $str);
+	}
 }

htdocs/includes/sabre/sabre/vobject/lib/BirthdayCalendarGenerator.php

Indentation +156 added lines, -156 removed lines

@@ -13,160 +13,160 @@
  */
 class BirthdayCalendarGenerator
 {
-    /**
-     * Input objects.
-     *
-     * @var array
-     */
-    protected $objects = [];
-
-    /**
-     * Default year.
-     * Used for dates without a year.
-     */
-    const DEFAULT_YEAR = 2000;
-
-    /**
-     * Output format for the SUMMARY.
-     *
-     * @var string
-     */
-    protected $format = '%1$s\'s Birthday';
-
-    /**
-     * Creates the generator.
-     *
-     * Check the setTimeRange and setObjects methods for details about the
-     * arguments.
-     *
-     * @param mixed $objects
-     */
-    public function __construct($objects = null)
-    {
-        if ($objects) {
-            $this->setObjects($objects);
-        }
-    }
-
-    /**
-     * Sets the input objects.
-     *
-     * You must either supply a vCard as a string or as a Component/VCard object.
-     * It's also possible to supply an array of strings or objects.
-     *
-     * @param mixed $objects
-     */
-    public function setObjects($objects)
-    {
-        if (!is_array($objects)) {
-            $objects = [$objects];
-        }
-
-        $this->objects = [];
-        foreach ($objects as $object) {
-            if (is_string($object)) {
-                $vObj = Reader::read($object);
-                if (!$vObj instanceof Component\VCard) {
-                    throw new \InvalidArgumentException('String could not be parsed as \\Sabre\\VObject\\Component\\VCard by setObjects');
-                }
-
-                $this->objects[] = $vObj;
-            } elseif ($object instanceof Component\VCard) {
-                $this->objects[] = $object;
-            } else {
-                throw new \InvalidArgumentException('You can only pass strings or \\Sabre\\VObject\\Component\\VCard arguments to setObjects');
-            }
-        }
-    }
-
-    /**
-     * Sets the output format for the SUMMARY.
-     *
-     * @param string $format
-     */
-    public function setFormat($format)
-    {
-        $this->format = $format;
-    }
-
-    /**
-     * Parses the input data and returns a VCALENDAR.
-     *
-     * @return Component/VCalendar
-     */
-    public function getResult()
-    {
-        $calendar = new VCalendar();
-
-        foreach ($this->objects as $object) {
-            // Skip if there is no BDAY property.
-            if (!$object->select('BDAY')) {
-                continue;
-            }
-
-            // We've seen clients (ez-vcard) putting "BDAY:" properties
-            // without a value into vCards. If we come across those, we'll
-            // skip them.
-            if (empty($object->BDAY->getValue())) {
-                continue;
-            }
-
-            // We're always converting to vCard 4.0 so we can rely on the
-            // VCardConverter handling the X-APPLE-OMIT-YEAR property for us.
-            $object = $object->convert(Document::VCARD40);
-
-            // Skip if the card has no FN property.
-            if (!isset($object->FN)) {
-                continue;
-            }
-
-            // Skip if the BDAY property is not of the right type.
-            if (!$object->BDAY instanceof Property\VCard\DateAndOrTime) {
-                continue;
-            }
-
-            // Skip if we can't parse the BDAY value.
-            try {
-                $dateParts = DateTimeParser::parseVCardDateTime($object->BDAY->getValue());
-            } catch (InvalidDataException $e) {
-                continue;
-            }
-
-            // Set a year if it's not set.
-            $unknownYear = false;
-
-            if (!$dateParts['year']) {
-                $object->BDAY = self::DEFAULT_YEAR.'-'.$dateParts['month'].'-'.$dateParts['date'];
-
-                $unknownYear = true;
-            }
-
-            // Create event.
-            $event = $calendar->add('VEVENT', [
-                'SUMMARY' => sprintf($this->format, $object->FN->getValue()),
-                'DTSTART' => new \DateTime($object->BDAY->getValue()),
-                'RRULE' => 'FREQ=YEARLY',
-                'TRANSP' => 'TRANSPARENT',
-            ]);
-
-            // add VALUE=date
-            $event->DTSTART['VALUE'] = 'DATE';
-
-            // Add X-SABRE-BDAY property.
-            if ($unknownYear) {
-                $event->add('X-SABRE-BDAY', 'BDAY', [
-                    'X-SABRE-VCARD-UID' => $object->UID->getValue(),
-                    'X-SABRE-VCARD-FN' => $object->FN->getValue(),
-                    'X-SABRE-OMIT-YEAR' => self::DEFAULT_YEAR,
-                ]);
-            } else {
-                $event->add('X-SABRE-BDAY', 'BDAY', [
-                    'X-SABRE-VCARD-UID' => $object->UID->getValue(),
-                    'X-SABRE-VCARD-FN' => $object->FN->getValue(),
-                ]);
-            }
-        }
-
-        return $calendar;
-    }
+	/**
+	 * Input objects.
+	 *
+	 * @var array
+	 */
+	protected $objects = [];
+
+	/**
+	 * Default year.
+	 * Used for dates without a year.
+	 */
+	const DEFAULT_YEAR = 2000;
+
+	/**
+	 * Output format for the SUMMARY.
+	 *
+	 * @var string
+	 */
+	protected $format = '%1$s\'s Birthday';
+
+	/**
+	 * Creates the generator.
+	 *
+	 * Check the setTimeRange and setObjects methods for details about the
+	 * arguments.
+	 *
+	 * @param mixed $objects
+	 */
+	public function __construct($objects = null)
+	{
+		if ($objects) {
+			$this->setObjects($objects);
+		}
+	}
+
+	/**
+	 * Sets the input objects.
+	 *
+	 * You must either supply a vCard as a string or as a Component/VCard object.
+	 * It's also possible to supply an array of strings or objects.
+	 *
+	 * @param mixed $objects
+	 */
+	public function setObjects($objects)
+	{
+		if (!is_array($objects)) {
+			$objects = [$objects];
+		}
+
+		$this->objects = [];
+		foreach ($objects as $object) {
+			if (is_string($object)) {
+				$vObj = Reader::read($object);
+				if (!$vObj instanceof Component\VCard) {
+					throw new \InvalidArgumentException('String could not be parsed as \\Sabre\\VObject\\Component\\VCard by setObjects');
+				}
+
+				$this->objects[] = $vObj;
+			} elseif ($object instanceof Component\VCard) {
+				$this->objects[] = $object;
+			} else {
+				throw new \InvalidArgumentException('You can only pass strings or \\Sabre\\VObject\\Component\\VCard arguments to setObjects');
+			}
+		}
+	}
+
+	/**
+	 * Sets the output format for the SUMMARY.
+	 *
+	 * @param string $format
+	 */
+	public function setFormat($format)
+	{
+		$this->format = $format;
+	}
+
+	/**
+	 * Parses the input data and returns a VCALENDAR.
+	 *
+	 * @return Component/VCalendar
+	 */
+	public function getResult()
+	{
+		$calendar = new VCalendar();
+
+		foreach ($this->objects as $object) {
+			// Skip if there is no BDAY property.
+			if (!$object->select('BDAY')) {
+				continue;
+			}
+
+			// We've seen clients (ez-vcard) putting "BDAY:" properties
+			// without a value into vCards. If we come across those, we'll
+			// skip them.
+			if (empty($object->BDAY->getValue())) {
+				continue;
+			}
+
+			// We're always converting to vCard 4.0 so we can rely on the
+			// VCardConverter handling the X-APPLE-OMIT-YEAR property for us.
+			$object = $object->convert(Document::VCARD40);
+
+			// Skip if the card has no FN property.
+			if (!isset($object->FN)) {
+				continue;
+			}
+
+			// Skip if the BDAY property is not of the right type.
+			if (!$object->BDAY instanceof Property\VCard\DateAndOrTime) {
+				continue;
+			}
+
+			// Skip if we can't parse the BDAY value.
+			try {
+				$dateParts = DateTimeParser::parseVCardDateTime($object->BDAY->getValue());
+			} catch (InvalidDataException $e) {
+				continue;
+			}
+
+			// Set a year if it's not set.
+			$unknownYear = false;
+
+			if (!$dateParts['year']) {
+				$object->BDAY = self::DEFAULT_YEAR.'-'.$dateParts['month'].'-'.$dateParts['date'];
+
+				$unknownYear = true;
+			}
+
+			// Create event.
+			$event = $calendar->add('VEVENT', [
+				'SUMMARY' => sprintf($this->format, $object->FN->getValue()),
+				'DTSTART' => new \DateTime($object->BDAY->getValue()),
+				'RRULE' => 'FREQ=YEARLY',
+				'TRANSP' => 'TRANSPARENT',
+			]);
+
+			// add VALUE=date
+			$event->DTSTART['VALUE'] = 'DATE';
+
+			// Add X-SABRE-BDAY property.
+			if ($unknownYear) {
+				$event->add('X-SABRE-BDAY', 'BDAY', [
+					'X-SABRE-VCARD-UID' => $object->UID->getValue(),
+					'X-SABRE-VCARD-FN' => $object->FN->getValue(),
+					'X-SABRE-OMIT-YEAR' => self::DEFAULT_YEAR,
+				]);
+			} else {
+				$event->add('X-SABRE-BDAY', 'BDAY', [
+					'X-SABRE-VCARD-UID' => $object->UID->getValue(),
+					'X-SABRE-VCARD-FN' => $object->FN->getValue(),
+				]);
+			}
+		}
+
+		return $calendar;
+	}
 }

htdocs/includes/sabre/sabre/vobject/lib/Recur/EventIterator.php

Indentation +434 added lines, -434 removed lines

@@ -60,438 +60,438 @@
  */
 class EventIterator implements \Iterator
 {
-    /**
-     * Reference timeZone for floating dates and times.
-     *
-     * @var DateTimeZone
-     */
-    protected $timeZone;
-
-    /**
-     * True if we're iterating an all-day event.
-     *
-     * @var bool
-     */
-    protected $allDay = false;
-
-    /**
-     * Creates the iterator.
-     *
-     * There's three ways to set up the iterator.
-     *
-     * 1. You can pass a VCALENDAR component and a UID.
-     * 2. You can pass an array of VEVENTs (all UIDS should match).
-     * 3. You can pass a single VEVENT component.
-     *
-     * Only the second method is recommended. The other 1 and 3 will be removed
-     * at some point in the future.
-     *
-     * The $uid parameter is only required for the first method.
-     *
-     * @param Component|array $input
-     * @param string|null     $uid
-     * @param DateTimeZone    $timeZone reference timezone for floating dates and
-     *                                  times
-     */
-    public function __construct($input, $uid = null, DateTimeZone $timeZone = null)
-    {
-        if (is_null($timeZone)) {
-            $timeZone = new DateTimeZone('UTC');
-        }
-        $this->timeZone = $timeZone;
-
-        if (is_array($input)) {
-            $events = $input;
-        } elseif ($input instanceof VEvent) {
-            // Single instance mode.
-            $events = [$input];
-        } else {
-            // Calendar + UID mode.
-            $uid = (string) $uid;
-            if (!$uid) {
-                throw new InvalidArgumentException('The UID argument is required when a VCALENDAR is passed to this constructor');
-            }
-            if (!isset($input->VEVENT)) {
-                throw new InvalidArgumentException('No events found in this calendar');
-            }
-            $events = $input->getByUID($uid);
-        }
-
-        foreach ($events as $vevent) {
-            if (!isset($vevent->{'RECURRENCE-ID'})) {
-                $this->masterEvent = $vevent;
-            } else {
-                $this->exceptions[
-                    $vevent->{'RECURRENCE-ID'}->getDateTime($this->timeZone)->getTimeStamp()
-                ] = true;
-                $this->overriddenEvents[] = $vevent;
-            }
-        }
-
-        if (!$this->masterEvent) {
-            // No base event was found. CalDAV does allow cases where only
-            // overridden instances are stored.
-            //
-            // In this particular case, we're just going to grab the first
-            // event and use that instead. This may not always give the
-            // desired result.
-            if (!count($this->overriddenEvents)) {
-                throw new InvalidArgumentException('This VCALENDAR did not have an event with UID: '.$uid);
-            }
-            $this->masterEvent = array_shift($this->overriddenEvents);
-        }
-
-        $this->startDate = $this->masterEvent->DTSTART->getDateTime($this->timeZone);
-        $this->allDay = !$this->masterEvent->DTSTART->hasTime();
-
-        if (isset($this->masterEvent->EXDATE)) {
-            foreach ($this->masterEvent->EXDATE as $exDate) {
-                foreach ($exDate->getDateTimes($this->timeZone) as $dt) {
-                    $this->exceptions[$dt->getTimeStamp()] = true;
-                }
-            }
-        }
-
-        if (isset($this->masterEvent->DTEND)) {
-            $this->eventDuration =
-                $this->masterEvent->DTEND->getDateTime($this->timeZone)->getTimeStamp() -
-                $this->startDate->getTimeStamp();
-        } elseif (isset($this->masterEvent->DURATION)) {
-            $duration = $this->masterEvent->DURATION->getDateInterval();
-            $end = clone $this->startDate;
-            $end = $end->add($duration);
-            $this->eventDuration = $end->getTimeStamp() - $this->startDate->getTimeStamp();
-        } elseif ($this->allDay) {
-            $this->eventDuration = 3600 * 24;
-        } else {
-            $this->eventDuration = 0;
-        }
-
-        if (isset($this->masterEvent->RDATE)) {
-            $this->recurIterator = new RDateIterator(
-                $this->masterEvent->RDATE->getParts(),
-                $this->startDate
-            );
-        } elseif (isset($this->masterEvent->RRULE)) {
-            $this->recurIterator = new RRuleIterator(
-                $this->masterEvent->RRULE->getParts(),
-                $this->startDate
-            );
-        } else {
-            $this->recurIterator = new RRuleIterator(
-                [
-                    'FREQ' => 'DAILY',
-                    'COUNT' => 1,
-                ],
-                $this->startDate
-            );
-        }
-
-        $this->rewind();
-        if (!$this->valid()) {
-            throw new NoInstancesException('This recurrence rule does not generate any valid instances');
-        }
-    }
-
-    /**
-     * Returns the date for the current position of the iterator.
-     *
-     * @return DateTimeImmutable
-     */
-    #[\ReturnTypeWillChange]
-    public function current()
-    {
-        if ($this->currentDate) {
-            return clone $this->currentDate;
-        }
-    }
-
-    /**
-     * This method returns the start date for the current iteration of the
-     * event.
-     *
-     * @return DateTimeImmutable
-     */
-    public function getDtStart()
-    {
-        if ($this->currentDate) {
-            return clone $this->currentDate;
-        }
-    }
-
-    /**
-     * This method returns the end date for the current iteration of the
-     * event.
-     *
-     * @return DateTimeImmutable
-     */
-    public function getDtEnd()
-    {
-        if (!$this->valid()) {
-            return;
-        }
-        if ($this->currentOverriddenEvent && $this->currentOverriddenEvent->DTEND) {
-            return $this->currentOverriddenEvent->DTEND->getDateTime($this->timeZone);
-        } else {
-            $end = clone $this->currentDate;
-
-            return $end->modify('+'.$this->eventDuration.' seconds');
-        }
-    }
-
-    /**
-     * Returns a VEVENT for the current iterations of the event.
-     *
-     * This VEVENT will have a recurrence id, and its DTSTART and DTEND
-     * altered.
-     *
-     * @return VEvent
-     */
-    public function getEventObject()
-    {
-        if ($this->currentOverriddenEvent) {
-            return $this->currentOverriddenEvent;
-        }
-
-        $event = clone $this->masterEvent;
-
-        // Ignoring the following block, because PHPUnit's code coverage
-        // ignores most of these lines, and this messes with our stats.
-        //
-        // @codeCoverageIgnoreStart
-        unset(
-            $event->RRULE,
-            $event->EXDATE,
-            $event->RDATE,
-            $event->EXRULE,
-            $event->{'RECURRENCE-ID'}
-        );
-        // @codeCoverageIgnoreEnd
-
-        $event->DTSTART->setDateTime($this->getDtStart(), $event->DTSTART->isFloating());
-        if (isset($event->DTEND)) {
-            $event->DTEND->setDateTime($this->getDtEnd(), $event->DTEND->isFloating());
-        }
-        $recurid = clone $event->DTSTART;
-        $recurid->name = 'RECURRENCE-ID';
-        $event->add($recurid);
-
-        return $event;
-    }
-
-    /**
-     * Returns the current position of the iterator.
-     *
-     * This is for us simply a 0-based index.
-     *
-     * @return int
-     */
-    #[\ReturnTypeWillChange]
-    public function key()
-    {
-        // The counter is always 1 ahead.
-        return $this->counter - 1;
-    }
-
-    /**
-     * This is called after next, to see if the iterator is still at a valid
-     * position, or if it's at the end.
-     *
-     * @return bool
-     */
-    #[\ReturnTypeWillChange]
-    public function valid()
-    {
-        if ($this->counter > Settings::$maxRecurrences && -1 !== Settings::$maxRecurrences) {
-            throw new MaxInstancesExceededException('Recurring events are only allowed to generate '.Settings::$maxRecurrences);
-        }
-
-        return (bool) $this->currentDate;
-    }
-
-    /**
-     * Sets the iterator back to the starting point.
-     *
-     * @return void
-     */
-    #[\ReturnTypeWillChange]
-    public function rewind()
-    {
-        $this->recurIterator->rewind();
-        // re-creating overridden event index.
-        $index = [];
-        foreach ($this->overriddenEvents as $key => $event) {
-            $stamp = $event->DTSTART->getDateTime($this->timeZone)->getTimeStamp();
-            $index[$stamp][] = $key;
-        }
-        krsort($index);
-        $this->counter = 0;
-        $this->overriddenEventsIndex = $index;
-        $this->currentOverriddenEvent = null;
-
-        $this->nextDate = null;
-        $this->currentDate = clone $this->startDate;
-
-        $this->next();
-    }
-
-    /**
-     * Advances the iterator with one step.
-     *
-     * @return void
-     */
-    #[\ReturnTypeWillChange]
-    public function next()
-    {
-        $this->currentOverriddenEvent = null;
-        ++$this->counter;
-        if ($this->nextDate) {
-            // We had a stored value.
-            $nextDate = $this->nextDate;
-            $this->nextDate = null;
-        } else {
-            // We need to ask rruleparser for the next date.
-            // We need to do this until we find a date that's not in the
-            // exception list.
-            do {
-                if (!$this->recurIterator->valid()) {
-                    $nextDate = null;
-                    break;
-                }
-                $nextDate = $this->recurIterator->current();
-                $this->recurIterator->next();
-            } while (isset($this->exceptions[$nextDate->getTimeStamp()]));
-        }
-
-        // $nextDate now contains what rrule thinks is the next one, but an
-        // overridden event may cut ahead.
-        if ($this->overriddenEventsIndex) {
-            $offsets = end($this->overriddenEventsIndex);
-            $timestamp = key($this->overriddenEventsIndex);
-            $offset = end($offsets);
-            if (!$nextDate || $timestamp < $nextDate->getTimeStamp()) {
-                // Overridden event comes first.
-                $this->currentOverriddenEvent = $this->overriddenEvents[$offset];
-
-                // Putting the rrule next date aside.
-                $this->nextDate = $nextDate;
-                $this->currentDate = $this->currentOverriddenEvent->DTSTART->getDateTime($this->timeZone);
-
-                // Ensuring that this item will only be used once.
-                array_pop($this->overriddenEventsIndex[$timestamp]);
-                if (!$this->overriddenEventsIndex[$timestamp]) {
-                    array_pop($this->overriddenEventsIndex);
-                }
-
-                // Exit point!
-                return;
-            }
-        }
-
-        $this->currentDate = $nextDate;
-    }
-
-    /**
-     * Quickly jump to a date in the future.
-     */
-    public function fastForward(DateTimeInterface $dateTime)
-    {
-        while ($this->valid() && $this->getDtEnd() <= $dateTime) {
-            $this->next();
-        }
-    }
-
-    /**
-     * Returns true if this recurring event never ends.
-     *
-     * @return bool
-     */
-    public function isInfinite()
-    {
-        return $this->recurIterator->isInfinite();
-    }
-
-    /**
-     * RRULE parser.
-     *
-     * @var RRuleIterator
-     */
-    protected $recurIterator;
-
-    /**
-     * The duration, in seconds, of the master event.
-     *
-     * We use this to calculate the DTEND for subsequent events.
-     */
-    protected $eventDuration;
-
-    /**
-     * A reference to the main (master) event.
-     *
-     * @var VEVENT
-     */
-    protected $masterEvent;
-
-    /**
-     * List of overridden events.
-     *
-     * @var array
-     */
-    protected $overriddenEvents = [];
-
-    /**
-     * Overridden event index.
-     *
-     * Key is timestamp, value is the list of indexes of the item in the $overriddenEvent
-     * property.
-     *
-     * @var array
-     */
-    protected $overriddenEventsIndex;
-
-    /**
-     * A list of recurrence-id's that are either part of EXDATE, or are
-     * overridden.
-     *
-     * @var array
-     */
-    protected $exceptions = [];
-
-    /**
-     * Internal event counter.
-     *
-     * @var int
-     */
-    protected $counter;
-
-    /**
-     * The very start of the iteration process.
-     *
-     * @var DateTimeImmutable
-     */
-    protected $startDate;
-
-    /**
-     * Where we are currently in the iteration process.
-     *
-     * @var DateTimeImmutable
-     */
-    protected $currentDate;
-
-    /**
-     * The next date from the rrule parser.
-     *
-     * Sometimes we need to temporary store the next date, because an
-     * overridden event came before.
-     *
-     * @var DateTimeImmutable
-     */
-    protected $nextDate;
-
-    /**
-     * The event that overwrites the current iteration.
-     *
-     * @var VEVENT
-     */
-    protected $currentOverriddenEvent;
+	/**
+	 * Reference timeZone for floating dates and times.
+	 *
+	 * @var DateTimeZone
+	 */
+	protected $timeZone;
+
+	/**
+	 * True if we're iterating an all-day event.
+	 *
+	 * @var bool
+	 */
+	protected $allDay = false;
+
+	/**
+	 * Creates the iterator.
+	 *
+	 * There's three ways to set up the iterator.
+	 *
+	 * 1. You can pass a VCALENDAR component and a UID.
+	 * 2. You can pass an array of VEVENTs (all UIDS should match).
+	 * 3. You can pass a single VEVENT component.
+	 *
+	 * Only the second method is recommended. The other 1 and 3 will be removed
+	 * at some point in the future.
+	 *
+	 * The $uid parameter is only required for the first method.
+	 *
+	 * @param Component|array $input
+	 * @param string|null     $uid
+	 * @param DateTimeZone    $timeZone reference timezone for floating dates and
+	 *                                  times
+	 */
+	public function __construct($input, $uid = null, DateTimeZone $timeZone = null)
+	{
+		if (is_null($timeZone)) {
+			$timeZone = new DateTimeZone('UTC');
+		}
+		$this->timeZone = $timeZone;
+
+		if (is_array($input)) {
+			$events = $input;
+		} elseif ($input instanceof VEvent) {
+			// Single instance mode.
+			$events = [$input];
+		} else {
+			// Calendar + UID mode.
+			$uid = (string) $uid;
+			if (!$uid) {
+				throw new InvalidArgumentException('The UID argument is required when a VCALENDAR is passed to this constructor');
+			}
+			if (!isset($input->VEVENT)) {
+				throw new InvalidArgumentException('No events found in this calendar');
+			}
+			$events = $input->getByUID($uid);
+		}
+
+		foreach ($events as $vevent) {
+			if (!isset($vevent->{'RECURRENCE-ID'})) {
+				$this->masterEvent = $vevent;
+			} else {
+				$this->exceptions[
+					$vevent->{'RECURRENCE-ID'}->getDateTime($this->timeZone)->getTimeStamp()
+				] = true;
+				$this->overriddenEvents[] = $vevent;
+			}
+		}
+
+		if (!$this->masterEvent) {
+			// No base event was found. CalDAV does allow cases where only
+			// overridden instances are stored.
+			//
+			// In this particular case, we're just going to grab the first
+			// event and use that instead. This may not always give the
+			// desired result.
+			if (!count($this->overriddenEvents)) {
+				throw new InvalidArgumentException('This VCALENDAR did not have an event with UID: '.$uid);
+			}
+			$this->masterEvent = array_shift($this->overriddenEvents);
+		}
+
+		$this->startDate = $this->masterEvent->DTSTART->getDateTime($this->timeZone);
+		$this->allDay = !$this->masterEvent->DTSTART->hasTime();
+
+		if (isset($this->masterEvent->EXDATE)) {
+			foreach ($this->masterEvent->EXDATE as $exDate) {
+				foreach ($exDate->getDateTimes($this->timeZone) as $dt) {
+					$this->exceptions[$dt->getTimeStamp()] = true;
+				}
+			}
+		}
+
+		if (isset($this->masterEvent->DTEND)) {
+			$this->eventDuration =
+				$this->masterEvent->DTEND->getDateTime($this->timeZone)->getTimeStamp() -
+				$this->startDate->getTimeStamp();
+		} elseif (isset($this->masterEvent->DURATION)) {
+			$duration = $this->masterEvent->DURATION->getDateInterval();
+			$end = clone $this->startDate;
+			$end = $end->add($duration);
+			$this->eventDuration = $end->getTimeStamp() - $this->startDate->getTimeStamp();
+		} elseif ($this->allDay) {
+			$this->eventDuration = 3600 * 24;
+		} else {
+			$this->eventDuration = 0;
+		}
+
+		if (isset($this->masterEvent->RDATE)) {
+			$this->recurIterator = new RDateIterator(
+				$this->masterEvent->RDATE->getParts(),
+				$this->startDate
+			);
+		} elseif (isset($this->masterEvent->RRULE)) {
+			$this->recurIterator = new RRuleIterator(
+				$this->masterEvent->RRULE->getParts(),
+				$this->startDate
+			);
+		} else {
+			$this->recurIterator = new RRuleIterator(
+				[
+					'FREQ' => 'DAILY',
+					'COUNT' => 1,
+				],
+				$this->startDate
+			);
+		}
+
+		$this->rewind();
+		if (!$this->valid()) {
+			throw new NoInstancesException('This recurrence rule does not generate any valid instances');
+		}
+	}
+
+	/**
+	 * Returns the date for the current position of the iterator.
+	 *
+	 * @return DateTimeImmutable
+	 */
+	#[\ReturnTypeWillChange]
+	public function current()
+	{
+		if ($this->currentDate) {
+			return clone $this->currentDate;
+		}
+	}
+
+	/**
+	 * This method returns the start date for the current iteration of the
+	 * event.
+	 *
+	 * @return DateTimeImmutable
+	 */
+	public function getDtStart()
+	{
+		if ($this->currentDate) {
+			return clone $this->currentDate;
+		}
+	}
+
+	/**
+	 * This method returns the end date for the current iteration of the
+	 * event.
+	 *
+	 * @return DateTimeImmutable
+	 */
+	public function getDtEnd()
+	{
+		if (!$this->valid()) {
+			return;
+		}
+		if ($this->currentOverriddenEvent && $this->currentOverriddenEvent->DTEND) {
+			return $this->currentOverriddenEvent->DTEND->getDateTime($this->timeZone);
+		} else {
+			$end = clone $this->currentDate;
+
+			return $end->modify('+'.$this->eventDuration.' seconds');
+		}
+	}
+
+	/**
+	 * Returns a VEVENT for the current iterations of the event.
+	 *
+	 * This VEVENT will have a recurrence id, and its DTSTART and DTEND
+	 * altered.
+	 *
+	 * @return VEvent
+	 */
+	public function getEventObject()
+	{
+		if ($this->currentOverriddenEvent) {
+			return $this->currentOverriddenEvent;
+		}
+
+		$event = clone $this->masterEvent;
+
+		// Ignoring the following block, because PHPUnit's code coverage
+		// ignores most of these lines, and this messes with our stats.
+		//
+		// @codeCoverageIgnoreStart
+		unset(
+			$event->RRULE,
+			$event->EXDATE,
+			$event->RDATE,
+			$event->EXRULE,
+			$event->{'RECURRENCE-ID'}
+		);
+		// @codeCoverageIgnoreEnd
+
+		$event->DTSTART->setDateTime($this->getDtStart(), $event->DTSTART->isFloating());
+		if (isset($event->DTEND)) {
+			$event->DTEND->setDateTime($this->getDtEnd(), $event->DTEND->isFloating());
+		}
+		$recurid = clone $event->DTSTART;
+		$recurid->name = 'RECURRENCE-ID';
+		$event->add($recurid);
+
+		return $event;
+	}
+
+	/**
+	 * Returns the current position of the iterator.
+	 *
+	 * This is for us simply a 0-based index.
+	 *
+	 * @return int
+	 */
+	#[\ReturnTypeWillChange]
+	public function key()
+	{
+		// The counter is always 1 ahead.
+		return $this->counter - 1;
+	}
+
+	/**
+	 * This is called after next, to see if the iterator is still at a valid
+	 * position, or if it's at the end.
+	 *
+	 * @return bool
+	 */
+	#[\ReturnTypeWillChange]
+	public function valid()
+	{
+		if ($this->counter > Settings::$maxRecurrences && -1 !== Settings::$maxRecurrences) {
+			throw new MaxInstancesExceededException('Recurring events are only allowed to generate '.Settings::$maxRecurrences);
+		}
+
+		return (bool) $this->currentDate;
+	}
+
+	/**
+	 * Sets the iterator back to the starting point.
+	 *
+	 * @return void
+	 */
+	#[\ReturnTypeWillChange]
+	public function rewind()
+	{
+		$this->recurIterator->rewind();
+		// re-creating overridden event index.
+		$index = [];
+		foreach ($this->overriddenEvents as $key => $event) {
+			$stamp = $event->DTSTART->getDateTime($this->timeZone)->getTimeStamp();
+			$index[$stamp][] = $key;
+		}
+		krsort($index);
+		$this->counter = 0;
+		$this->overriddenEventsIndex = $index;
+		$this->currentOverriddenEvent = null;
+
+		$this->nextDate = null;
+		$this->currentDate = clone $this->startDate;
+
+		$this->next();
+	}
+
+	/**
+	 * Advances the iterator with one step.
+	 *
+	 * @return void
+	 */
+	#[\ReturnTypeWillChange]
+	public function next()
+	{
+		$this->currentOverriddenEvent = null;
+		++$this->counter;
+		if ($this->nextDate) {
+			// We had a stored value.
+			$nextDate = $this->nextDate;
+			$this->nextDate = null;
+		} else {
+			// We need to ask rruleparser for the next date.
+			// We need to do this until we find a date that's not in the
+			// exception list.
+			do {
+				if (!$this->recurIterator->valid()) {
+					$nextDate = null;
+					break;
+				}
+				$nextDate = $this->recurIterator->current();
+				$this->recurIterator->next();
+			} while (isset($this->exceptions[$nextDate->getTimeStamp()]));
+		}
+
+		// $nextDate now contains what rrule thinks is the next one, but an
+		// overridden event may cut ahead.
+		if ($this->overriddenEventsIndex) {
+			$offsets = end($this->overriddenEventsIndex);
+			$timestamp = key($this->overriddenEventsIndex);
+			$offset = end($offsets);
+			if (!$nextDate || $timestamp < $nextDate->getTimeStamp()) {
+				// Overridden event comes first.
+				$this->currentOverriddenEvent = $this->overriddenEvents[$offset];
+
+				// Putting the rrule next date aside.
+				$this->nextDate = $nextDate;
+				$this->currentDate = $this->currentOverriddenEvent->DTSTART->getDateTime($this->timeZone);
+
+				// Ensuring that this item will only be used once.
+				array_pop($this->overriddenEventsIndex[$timestamp]);
+				if (!$this->overriddenEventsIndex[$timestamp]) {
+					array_pop($this->overriddenEventsIndex);
+				}
+
+				// Exit point!
+				return;
+			}
+		}
+
+		$this->currentDate = $nextDate;
+	}
+
+	/**
+	 * Quickly jump to a date in the future.
+	 */
+	public function fastForward(DateTimeInterface $dateTime)
+	{
+		while ($this->valid() && $this->getDtEnd() <= $dateTime) {
+			$this->next();
+		}
+	}
+
+	/**
+	 * Returns true if this recurring event never ends.
+	 *
+	 * @return bool
+	 */
+	public function isInfinite()
+	{
+		return $this->recurIterator->isInfinite();
+	}
+
+	/**
+	 * RRULE parser.
+	 *
+	 * @var RRuleIterator
+	 */
+	protected $recurIterator;
+
+	/**
+	 * The duration, in seconds, of the master event.
+	 *
+	 * We use this to calculate the DTEND for subsequent events.
+	 */
+	protected $eventDuration;
+
+	/**
+	 * A reference to the main (master) event.
+	 *
+	 * @var VEVENT
+	 */
+	protected $masterEvent;
+
+	/**
+	 * List of overridden events.
+	 *
+	 * @var array
+	 */
+	protected $overriddenEvents = [];
+
+	/**
+	 * Overridden event index.
+	 *
+	 * Key is timestamp, value is the list of indexes of the item in the $overriddenEvent
+	 * property.
+	 *
+	 * @var array
+	 */
+	protected $overriddenEventsIndex;
+
+	/**
+	 * A list of recurrence-id's that are either part of EXDATE, or are
+	 * overridden.
+	 *
+	 * @var array
+	 */
+	protected $exceptions = [];
+
+	/**
+	 * Internal event counter.
+	 *
+	 * @var int
+	 */
+	protected $counter;
+
+	/**
+	 * The very start of the iteration process.
+	 *
+	 * @var DateTimeImmutable
+	 */
+	protected $startDate;
+
+	/**
+	 * Where we are currently in the iteration process.
+	 *
+	 * @var DateTimeImmutable
+	 */
+	protected $currentDate;
+
+	/**
+	 * The next date from the rrule parser.
+	 *
+	 * Sometimes we need to temporary store the next date, because an
+	 * overridden event came before.
+	 *
+	 * @var DateTimeImmutable
+	 */
+	protected $nextDate;
+
+	/**
+	 * The event that overwrites the current iteration.
+	 *
+	 * @var VEVENT
+	 */
+	protected $currentOverriddenEvent;
 }