class RecurringPeriod in Recurring Time Period 8

Defines the recurring period plugin annotation object.

Plugin namespace: Plugin/RecurringPeriod.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\recurring_period\Annotation\RecurringPeriod

See also

Plugin API

3 classes are annotated with RecurringPeriod

FixedReferenceDateInterval in src/Plugin/RecurringPeriod/FixedReferenceDateInterval.php

Provides a fixed date period.

RollingInterval in src/Plugin/RecurringPeriod/RollingInterval.php

Provides a period based on a rolling interval from the start date.

Unlimited in src/Plugin/RecurringPeriod/Unlimited.php

Provides a period that never ends.

File

src/Annotation/RecurringPeriod.php, line 16

Namespace

Drupal\recurring_period\Annotation

class RecurringPeriod extends Plugin {

  /**
   * The plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * The label of the plugin.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $label;

  /**
   * The description of the plugin.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $description;

}

Members

Name	Modifiers	Type	Description	Overrides
Plugin::$definition	protected	property	The plugin definition read from the class annotation.	1
Plugin::get	public	function	Gets the value of an annotation. Overrides AnnotationInterface::get	5
Plugin::getClass	public	function	Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId	public	function	Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider	public	function	Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
Plugin::parse	protected	function	Parses an annotation into its definition.
Plugin::setClass	public	function	Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider	public	function	Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct	public	function	Constructs a Plugin object.	2
RecurringPeriod::$description	public	property	The description of the plugin.
RecurringPeriod::$id	public	property	The plugin ID.
RecurringPeriod::$label	public	property	The label of the plugin.