interface IntervalItemInterface in Interval Field 8

Hierarchy

• interface \Drupal\interval\IntervalItemInterface

2 files declare their use of IntervalItemInterface

IntervalFormatterBase.php in src/Plugin/Field/FieldFormatter/IntervalFormatterBase.php

IntervalItem.php in src/Plugin/Field/FieldType/IntervalItem.php

File

src/IntervalItemInterface.php, line 5

Namespace

Drupal\interval

interface IntervalItemInterface {

  /**
   * Gets the interval value for this item.
   *
   * @return int
   *   The interval for this item
   */
  public function getInterval();

  /**
   * Gets the period value for this item.
   *
   * @return int
   *   The period for this item
   */
  public function getPeriod();

  /**
   * Gets the interval plugin for this item.
   *
   * @return \Drupal\interval\IntervalInterface
   *   The interval plugin.
   */
  public function getIntervalPlugin();

  /**
   * Applies an interval to a date object.
   *
   * @param \DateTime $date
   *   A DateTime object to which the interval needs to be applied
   * @param bool $limit
   *   When calling the interval apply function with months or a month
   *   multiplier, keep the date in the last day of the month if this was
   *   exceeded. Example, with $limit set to TRUE, January 31st +1 month will
   *   result in February 28th.
   *
   * @throws \Drupal\interval\InvalidIntervalException
   */
  public function applyInterval(\DateTime $date, $limit = FALSE);

  /**
   * Builds a php date interval string from the plugin properties.
   *
   * @return string
   *   The interval translated to a php string compatible with
   *   \DateTime::modify.
   */
  public function buildPHPString();

}

Members

Name	Modifiers	Type	Description	Overrides
IntervalItemInterface::applyInterval	public	function	Applies an interval to a date object.	1
IntervalItemInterface::buildPHPString	public	function	Builds a php date interval string from the plugin properties.	1
IntervalItemInterface::getInterval	public	function	Gets the interval value for this item.	1
IntervalItemInterface::getIntervalPlugin	public	function	Gets the interval plugin for this item.	1
IntervalItemInterface::getPeriod	public	function	Gets the period value for this item.	1