interface StockLocationInterface in Commerce Stock 8

Provides an interface for defining stock locations.

This is located under the core module to keep others module independent from commerce stock local.

Hierarchy

• interface \Drupal\commerce_stock\StockLocationInterface

5 files declare their use of StockLocationInterface

CoreStockEvents.php in src/Plugin/StockEvents/CoreStockEvents.php

DisabledStockEvents.php in src/Plugin/StockEvents/DisabledStockEvents.php

OrderEventSubscriber.php in src/EventSubscriber/OrderEventSubscriber.php

StockEventsInterface.php in src/Plugin/StockEventsInterface.php

StockLocation.php in modules/local_storage/src/Entity/StockLocation.php

File

src/StockLocationInterface.php, line 11

Namespace

Drupal\commerce_stock

interface StockLocationInterface {

  /**
   * Gets the stock location id.
   *
   * @return int
   *   The id of the location.
   */
  public function getId();

  /**
   * Gets the stock location name.
   *
   * @return string
   *   Name of the stock location.
   */
  public function getName();

  /**
   * Returns the stock location status indicator.
   *
   * @return bool
   *   TRUE if the stock location is active.
   */
  public function isActive();

}

Members

Name	Modifiers	Type	Description	Overrides
StockLocationInterface::getId	public	function	Gets the stock location id.	1
StockLocationInterface::getName	public	function	Gets the stock location name.
StockLocationInterface::isActive	public	function	Returns the stock location status indicator.