You are here

public function RecurringPeriodBase::getPeriodLabel in Recurring Time Period 8

Gets a label for the period starting from the given date.

This produces a generic label. It may be desirable to override this method in a replacement plugin class.

Parameters

\DateTimeImmutable $start: The date and time to begin the period from.

\DateTimeImmutable $end: The date and time on which the period ends.

Return value

\Drupal\Core\StringTranslation\TranslatableMarkup The label.

Overrides RecurringPeriodInterface::getPeriodLabel

2 calls to RecurringPeriodBase::getPeriodLabel()
RecurringPeriodBase::getPeriodContainingDate in src/Plugin/RecurringPeriod/RecurringPeriodBase.php
Gets a period object that contains the given date.
RecurringPeriodBase::getPeriodFromDate in src/Plugin/RecurringPeriod/RecurringPeriodBase.php
Gets a period object that begins on a given date.
1 method overrides RecurringPeriodBase::getPeriodLabel()
RollingInterval::getPeriodLabel in src/Plugin/RecurringPeriod/RollingInterval.php
Gets a label for the period starting from the given date.

File

src/Plugin/RecurringPeriod/RecurringPeriodBase.php, line 143

Class

RecurringPeriodBase
Base class for recurring period plugins.

Namespace

Drupal\recurring_period\Plugin\RecurringPeriod

Code

public function getPeriodLabel(\DateTimeImmutable $start, \DateTimeImmutable $end) {
  return '';
}