interface DateRecurRuleInterface in Recurring Dates Field 3.1.x

Defines an interface for a single rule.

Normalizes rule class implementations.

Hierarchy

• interface \Drupal\date_recur\DateRecurRuleInterface

1 file declares its use of DateRecurRuleInterface

RlDateRecurRule.php in src/Rl/RlDateRecurRule.php

File

src/DateRecurRuleInterface.php, line 12

Namespace

Drupal\date_recur

interface DateRecurRuleInterface {

  /**
   * Get the frequency for the rule.
   *
   * @return string
   *   The frequency for the rule.
   */
  public function getFrequency() : string;

  /**
   * Get the RULE parts.
   *
   * For example, "FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR;" will return:
   *
   * @code
   *
   * [
   *   'BYDAY' => 'MO,TU,WE,TH,FR',
   *   'DTSTART' => \DateTime(...),
   *   'FREQ' => 'WEEKLY',
   * ]
   *
   * @endcode
   *
   * @return array
   *   The parts of the RRULE.
   */
  public function getParts() : array;

}

Members

Name	Modifiers	Type	Description	Overrides
DateRecurRuleInterface::getFrequency	public	function	Get the frequency for the rule.	1
DateRecurRuleInterface::getParts	public	function	Get the RULE parts.	1