public function DateRecurHelperInterface::getOccurrences in Recurring Dates Field 3.1.x

Same name and namespace in other branches

1. 8.2 src/DateRecurHelperInterface.php \Drupal\date_recur\DateRecurHelperInterface::getOccurrences()
2. 3.x src/DateRecurHelperInterface.php \Drupal\date_recur\DateRecurHelperInterface::getOccurrences()
3. 3.0.x src/DateRecurHelperInterface.php \Drupal\date_recur\DateRecurHelperInterface::getOccurrences()

Get all occurrences.

A limit and/or range-end must be passed.

Parameters

\DateTimeInterface|null $rangeStart: The start of the range, or start with the first available occurrence.

\DateTimeInterface|null $rangeEnd: The end of the range.

int|null $limit: A limit.

Return value

\Drupal\date_recur\DateRange[] The occurrences.

Throws

\InvalidArgumentException Exceptions thrown if ranges are invalid or undefined.

3 methods override DateRecurHelperInterface::getOccurrences()

DateRecurHelper::getOccurrences in src/DateRecurHelper.php

Get all occurrences.

DateRecurNonRecurringHelper::getOccurrences in src/DateRecurNonRecurringHelper.php

Get all occurrences.

RlHelper::getOccurrences in src/Rl/RlHelper.php

Get all occurrences.

File

src/DateRecurHelperInterface.php, line 76

Class

DateRecurHelperInterface

Interface for recurring rule helper.

Namespace

Drupal\date_recur

Code

public function getOccurrences(\DateTimeInterface $rangeStart = NULL, ?\DateTimeInterface $rangeEnd = NULL, ?int $limit = NULL) : array;