interface NumberPatternInterface in Commerce Core 8.2

Defines the interface for number patterns.

Hierarchy

• interface \Drupal\Component\Plugin\ConfigurableInterface; interface \Drupal\Component\Plugin\PluginInspectionInterface
  • interface \Drupal\commerce_number_pattern\Plugin\Commerce\NumberPattern\NumberPatternInterface

See also

\Drupal\commerce_number_pattern\Plugin\Commerce\NumberPattern\SequentialNumberPatternInterface

2 files declare their use of NumberPatternInterface

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

NumberPatternTest.php in modules/number_pattern/tests/src/Kernel/Entity/NumberPatternTest.php

File

modules/number_pattern/src/Plugin/Commerce/NumberPattern/NumberPatternInterface.php, line 14

Namespace

Drupal\commerce_number_pattern\Plugin\Commerce\NumberPattern

interface NumberPatternInterface extends ConfigurableInterface, PluginInspectionInterface {

  /**
   * Generates a number for the given content entity.
   *
   * @param \Drupal\Core\Entity\ContentEntityInterface $entity
   *   The content entity.
   *
   * @return string
   *   The generated number.
   */
  public function generate(ContentEntityInterface $entity);

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurableInterface::defaultConfiguration	public	function	Gets default configuration for this plugin.	11
ConfigurableInterface::getConfiguration	public	function	Gets this plugin's configuration.	12
ConfigurableInterface::setConfiguration	public	function	Sets the configuration for this plugin instance.	12
NumberPatternInterface::generate	public	function	Generates a number for the given content entity.	1
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2