interface StockEventTypeInterface in Commerce Stock 8

Defines an interface for Stock Event Type plugins.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface
  • interface \Drupal\commerce_stock\Plugin\Commerce\StockEventType\StockEventTypeInterface

2 files declare their use of StockEventTypeInterface

CoreStockEventsBase.php in src/Plugin/StockEvents/CoreStockEventsBase.php

OrderEventSubscriber.php in src/EventSubscriber/OrderEventSubscriber.php

File

src/Plugin/Commerce/StockEventType/StockEventTypeInterface.php, line 10

Namespace

Drupal\commerce_stock\Plugin\Commerce\StockEventType

interface StockEventTypeInterface extends PluginInspectionInterface {

  /**
   * Gets the stock event type label.
   *
   * @return string
   *   The stock event type  label.
   */
  public function getLabel();

  /**
   * Gets the stock event type display label.
   *
   * For enventually use in UI.
   *
   * @return string
   *   The stock event type  display label.
   */
  public function getDisplayLabel();

  /**
   * Gets the stock event type default transaction message.
   *
   * @return string
   *   The stock event type transaction message.
   */
  public function getDefaultMessage();

}

Members

Name	Modifiers	Type	Description	Overrides
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
StockEventTypeInterface::getDefaultMessage	public	function	Gets the stock event type default transaction message.	1
StockEventTypeInterface::getDisplayLabel	public	function	Gets the stock event type display label.	1
StockEventTypeInterface::getLabel	public	function	Gets the stock event type label.	1