You are here

public function DateRecurOccurrenceHandlerInterface::getOccurrencesForDisplay in Recurring Dates Field 8

Get a list of occurrences for display.

Must return an empty array for non-recurring dates. For recurring dates, an array of occurrences must be returned, each defining at least the following keys:

  • value - DrupalDateTime
  • end_value - DrupalDateTime

Additional keys may be included and may be supported by specific formatters.

Parameters

null|\DateTime|DrupalDateTime $start:

null|\DateTime|DrupalDateTime $end:

int $num:

Return value

array

1 method overrides DateRecurOccurrenceHandlerInterface::getOccurrencesForDisplay()
DefaultDateRecurOccurrenceHandler::getOccurrencesForDisplay in src/Plugin/DateRecurOccurrenceHandler/DefaultDateRecurOccurrenceHandler.php
Get a list of occurrences for display.

File

src/Plugin/DateRecurOccurrenceHandlerInterface.php, line 50

Class

DateRecurOccurrenceHandlerInterface
Defines an interface for Date recur occurrence handler plugins.

Namespace

Drupal\date_recur\Plugin

Code

public function getOccurrencesForDisplay($start = NULL, $end = NULL, $num = NULL);