You are here

Home » API reference » Ubercart 8.4 » WeightQuote.php

class WeightQuote in Ubercart 8.4

Assigns a shipping rate to products based on weight.

Plugin annotation


@UbercartShippingQuote(
  id = "weightquote",
  admin_label = @Translation("Weight quote")
)

Hierarchy

Expanded class hierarchy of WeightQuote

File

shipping/uc_quote/src/Plugin/Ubercart/ShippingQuote/WeightQuote.php, line 18

Namespace

Drupal\uc_quote\Plugin\Ubercart\ShippingQuote
View source 
class WeightQuote extends ShippingQuotePluginBase {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'base_rate' => 0,
      'product_rate' => 0,
      'field' => '',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $fields = [
      '' => $this
        ->t('- None -'),
    ];
    $result = \Drupal::entityQuery('field_config')
      ->condition('field_type', 'uc_price')
      ->execute();
    foreach (FieldConfig::loadMultiple($result) as $field) {
      $fields[$field
        ->getName()] = $field
        ->label();
    }
    $unit = \Drupal::config('uc_store.settings')
      ->get('weight.units');
    $form['base_rate'] = [
      '#type' => 'uc_price',
      '#title' => $this
        ->t('Base price'),
      '#description' => $this
        ->t('The starting price for weight-based shipping costs.'),
      '#default_value' => $this->configuration['base_rate'],
      '#required' => TRUE,
    ];
    $form['product_rate'] = [
      '#type' => 'uc_price',
      '#title' => $this
        ->t('Default cost adjustment per @unit', [
        '@unit' => $unit,
      ]),
      '#description' => $this
        ->t('The amount per weight unit to add to the shipping cost for an item.'),
      '#default_value' => $this->configuration['product_rate'],
      '#field_suffix' => $this
        ->t('per @unit', [
        '@unit' => $unit,
      ]),
      '#required' => TRUE,
    ];
    $form['field'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Product shipping rate override field'),
      '#description' => $this
        ->t('Overrides the default shipping rate per @unit for this shipping method, when the field is attached to a product content type and has a value.', [
        '@unit' => $unit,
      ]),
      '#options' => $fields,
      '#default_value' => $this->configuration['field'],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    $this->configuration['base_rate'] = $form_state
      ->getValue('base_rate');
    $this->configuration['product_rate'] = $form_state
      ->getValue('product_rate');
    $this->configuration['field'] = $form_state
      ->getValue('field');
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    return $this
      ->t('@base_rate + @product_rate per @unit', [
      '@base_rate' => uc_currency_format($this->configuration['base_rate']),
      '@product_rate' => uc_currency_format($this->configuration['product_rate']),
      '@unit' => \Drupal::config('uc_store.settings')
        ->get('weight.units'),
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function getQuotes(OrderInterface $order) {
    $rate = $this->configuration['base_rate'];
    $field = $this->configuration['field'];
    foreach ($order->products as $product) {
      if (isset($product->nid->entity->{$field}->value)) {
        $product_rate = $product->nid->entity->{$field}->value * $product->qty->value;
      }
      else {
        $product_rate = $this->configuration['product_rate'] * $product->qty->value;
      }
      $rate += $product_rate * $product->weight->value * uc_weight_conversion($product->weight->units);
    }
    return [
      $rate,
    ];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
ShippingQuotePluginBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ShippingQuotePluginBase::getDisplayLabel public function Returns the shipping quote method label with logo. Overrides ShippingQuotePluginInterface::getDisplayLabel 2
ShippingQuotePluginBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ShippingQuotePluginBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
ShippingQuotePluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
WeightQuote::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm
WeightQuote::defaultConfiguration public function Gets default configuration for this plugin. Overrides ShippingQuotePluginBase::defaultConfiguration
WeightQuote::getDescription public function Returns a description of this shipping quote. Overrides ShippingQuotePluginInterface::getDescription
WeightQuote::getQuotes public function Retrieves shipping quotes for this method. Overrides ShippingQuotePluginInterface::getQuotes
WeightQuote::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm