class Unlimited in Recurring Time Period 8

Provides a period that never ends.

Plugin annotation

@RecurringPeriod(
  id = "unlimited",
  label = @Translation("Unlimited"),
  description = @Translation("No end date"),
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\recurring_period\Plugin\RecurringPeriod\RecurringPeriodBase implements ContainerFactoryPluginInterface, RecurringPeriodInterface uses StringTranslationTrait
    • class \Drupal\recurring_period\Plugin\RecurringPeriod\Unlimited

File

src/Plugin/RecurringPeriod/Unlimited.php, line 16

Namespace

Drupal\recurring_period\Plugin\RecurringPeriod

class Unlimited extends RecurringPeriodBase {

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $config = $this->configuration;
    $form['description'] = [
      '#markup' => 'Unlimited.',
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDate(\DateTimeImmutable $start) {
    return self::UNLIMITED;
  }

  /**
   * {@inheritdoc}
   */
  public function calculateStart(\DateTimeImmutable $date) {
    return self::UNLIMITED;
  }

  /**
   * {@inheritdoc}
   */
  public function calculateEnd(\DateTimeImmutable $start) {
    return self::UNLIMITED;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
RecurringPeriodBase::$pluginManagerIntervals	protected	property	The Interval Plugin Manager service.
RecurringPeriodBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
RecurringPeriodBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
RecurringPeriodBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration	2
RecurringPeriodBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
RecurringPeriodBase::getDescription	public	function	Gets the plugin description. Overrides RecurringPeriodInterface::getDescription
RecurringPeriodBase::getLabel	public	function	Gets the plugin label. Overrides RecurringPeriodInterface::getLabel
RecurringPeriodBase::getNextPeriod	public	function	Calculates the period after the given period. Overrides RecurringPeriodInterface::getNextPeriod
RecurringPeriodBase::getPeriodContainingDate	public	function	Gets a period object that contains the given date. Overrides RecurringPeriodInterface::getPeriodContainingDate
RecurringPeriodBase::getPeriodFromDate	public	function	Gets a period object that begins on a given date. Overrides RecurringPeriodInterface::getPeriodFromDate
RecurringPeriodBase::getPeriodLabel	public	function	Gets a label for the period starting from the given date. Overrides RecurringPeriodInterface::getPeriodLabel	1
RecurringPeriodBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
RecurringPeriodBase::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm	2
RecurringPeriodBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
RecurringPeriodBase::__construct	public	function	Constructs a new plugin instance. Overrides PluginBase::__construct
RecurringPeriodInterface::UNLIMITED		constant	Represents an unlimited end time.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
Unlimited::buildConfigurationForm	public	function	Form constructor. Overrides RecurringPeriodBase::buildConfigurationForm
Unlimited::calculateDate	public	function	Calculates the end date and time for the period. Overrides RecurringPeriodInterface::calculateDate
Unlimited::calculateEnd	public	function	Calculates the end date and time for the period. Overrides RecurringPeriodBase::calculateEnd
Unlimited::calculateStart	public	function	Calculates the end of the previous period. Overrides RecurringPeriodBase::calculateStart