You are here

interface FulfillmentMethodPluginInterface in Ubercart 8.4

Defines an interface for fulfillment method plugins.

Hierarchy

Expanded class hierarchy of FulfillmentMethodPluginInterface

All classes that implement FulfillmentMethodPluginInterface

1 file declares its use of FulfillmentMethodPluginInterface
FulfillmentMethodPluginManager.php in shipping/uc_fulfillment/src/Plugin/FulfillmentMethodPluginManager.php

File

shipping/uc_fulfillment/src/FulfillmentMethodPluginInterface.php, line 13

Namespace

Drupal\uc_fulfillment
View source
interface FulfillmentMethodPluginInterface extends PluginInspectionInterface, ConfigurableInterface, PluginFormInterface {

  /**
   * Returns a description of this shipping method.
   *
   * @return string
   *   The description.
   */
  public function getDescription();

  /**
   * Fulfills the order using this method.
   *
   * @param \Drupal\uc_order\OrderInterface $order
   *   The order to fulfill.
   * @param array $package_ids
   *   An array of package ids to shipped.
   *
   * @return \Drupal\Core\Form\FormInterface
   *   A form to process the order fulfillment.
   */
  public function fulfillOrder(OrderInterface $order, array $package_ids);

}

Members

Namesort descending 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
FulfillmentMethodPluginInterface::fulfillOrder public function Fulfills the order using this method. 1
FulfillmentMethodPluginInterface::getDescription public function Returns a description of this shipping method. 1
PluginFormInterface::buildConfigurationForm public function Form constructor. 36
PluginFormInterface::submitConfigurationForm public function Form submission handler. 32
PluginFormInterface::validateConfigurationForm public function Form validation handler. 18
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