class CommerceNumberPattern in Commerce Core 8.2

Defines the number pattern plugin annotation object.

Plugin namespace: Plugin\Commerce\NumberPattern.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\commerce_number_pattern\Annotation\CommerceNumberPattern

See also

Plugin API

1 file declares its use of CommerceNumberPattern

NumberPatternManager.php in modules/number_pattern/src/NumberPatternManager.php

3 classes are annotated with CommerceNumberPattern

Infinite in modules/number_pattern/src/Plugin/Commerce/NumberPattern/Infinite.php

Provides the infinite number pattern.

Monthly in modules/number_pattern/src/Plugin/Commerce/NumberPattern/Monthly.php

Provides the monthly number pattern.

Yearly in modules/number_pattern/src/Plugin/Commerce/NumberPattern/Yearly.php

Provides a yearly number pattern.

File

modules/number_pattern/src/Annotation/CommerceNumberPattern.php, line 16

Namespace

Drupal\commerce_number_pattern\Annotation

class CommerceNumberPattern extends Plugin {

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

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

}

Members

Name	Modifiers	Type	Description	Overrides
CommerceNumberPattern::$id	public	property	The plugin ID.
CommerceNumberPattern::$label	public	property	The human-readable name of the plugin.
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