You are here

ShippingQuotePluginInterface.php in Ubercart 8.4

Namespace

Drupal\uc_quote

File

shipping/uc_quote/src/ShippingQuotePluginInterface.php
View source
<?php

namespace Drupal\uc_quote;

use Drupal\Component\Plugin\ConfigurableInterface;
use Drupal\Component\Plugin\PluginInspectionInterface;
use Drupal\Core\Plugin\PluginFormInterface;
use Drupal\uc_order\OrderInterface;

/**
 * Defines an interface for shipping quote plugins.
 */
interface ShippingQuotePluginInterface extends PluginInspectionInterface, ConfigurableInterface, PluginFormInterface {

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

  /**
   * Returns the shipping quote method label with logo.
   *
   * @param string $label
   *   The shipping quote method label to be styled.
   *
   * @return array
   *   A render array containing the formatted shipping quote method label.
   */
  public function getDisplayLabel($label);

  /**
   * Retrieves shipping quotes for this method.
   *
   * @param \Drupal\uc_order\OrderInterface $order
   *   The order to retrieve the quotes for.
   *
   * @return array
   *   An array of shipping quotes.
   */
  public function getQuotes(OrderInterface $order);

}

Interfaces

Namesort descending Description
ShippingQuotePluginInterface Defines an interface for shipping quote plugins.