ShippingQuoteMethodListBuilder.php in Ubercart 8.4

Namespace

Drupal\uc_quote

File

shipping/uc_quote/src/ShippingQuoteMethodListBuilder.php

<?php

namespace Drupal\uc_quote;

use Drupal\Core\Config\Entity\DraggableListBuilder;
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Entity\EntityStorageInterface;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Url;
use Drupal\uc_quote\Plugin\ShippingQuotePluginManager;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Provides a listing of shipping quote method entities.
 */
class ShippingQuoteMethodListBuilder extends DraggableListBuilder {

  /**
   * The shipping quote plugin manager.
   *
   * @var \Drupal\uc_quote\Plugin\ShippingQuotePluginManager
   */
  protected $shippingQuotePluginManager;

  /**
   * Constructs a new ShippingQuoteMethodListBuilder object.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type definition.
   * @param \Drupal\Core\Entity\EntityStorageInterface $storage
   *   The entity storage class.
   * @param \Drupal\uc_quote\Plugin\ShippingQuotePluginManager $shipping_quote_plugin_manager
   *   The shipping quote plugin manager.
   */
  public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, ShippingQuotePluginManager $shipping_quote_plugin_manager) {
    parent::__construct($entity_type, $storage);
    $this->shippingQuotePluginManager = $shipping_quote_plugin_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
    return new static($entity_type, $container
      ->get('entity_type.manager')
      ->getStorage($entity_type
      ->id()), $container
      ->get('plugin.manager.uc_quote.method'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'uc_quote_methods_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header['label'] = [
      'data' => $this
        ->t('Shipping quote method'),
    ];
    $header['description'] = [
      'data' => $this
        ->t('Description'),
      'class' => [
        RESPONSIVE_PRIORITY_LOW,
      ],
    ];
    $header['status'] = [
      'data' => $this
        ->t('Status'),
    ];
    return $header + parent::buildHeader();
  }

  /**
   * {@inheritdoc}
   */
  public function buildRow(EntityInterface $entity) {
    $plugin = $this->shippingQuotePluginManager
      ->createInstance($entity
      ->getPluginId(), $entity
      ->getPluginConfiguration());
    $row['label'] = $entity
      ->label();
    $row['description']['#markup'] = $plugin
      ->getDescription();
    $row['status']['#markup'] = $entity
      ->status() ? $this
      ->t('Enabled') : $this
      ->t('Disabled');
    return $row + parent::buildRow($entity);
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $options = array_map(function ($definition) {
      return $definition['admin_label'];
    }, $this->shippingQuotePluginManager
      ->getDefinitions());
    uasort($options, 'strnatcasecmp');
    $form['add'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Add shipping method'),
      '#open' => TRUE,
      '#attributes' => [
        'class' => [
          'container-inline',
        ],
      ],
    ];
    $form['add']['plugin'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Type'),
      '#empty_option' => $this
        ->t('- Choose -'),
      '#options' => $options,
    ];
    $form['add']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Add shipping method'),
      '#validate' => [
        '::validateAddMethod',
      ],
      '#submit' => [
        '::submitAddMethod',
      ],
      '#limit_validation_errors' => [
        [
          'plugin',
        ],
      ],
    ];
    $form = parent::buildForm($form, $form_state);
    $form[$this->entitiesKey]['#empty'] = $this
      ->t('No shipping methods have been configured yet.');
    $form['actions']['#type'] = 'actions';
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Save configuration'),
      '#button_type' => 'primary',
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $this
      ->messenger()
      ->addMessage($this
      ->t('The configuration options have been saved.'));
  }

  /**
   * Form validation handler for adding a new method.
   */
  public function validateAddMethod(array &$form, FormStateInterface $form_state) {
    if ($form_state
      ->isValueEmpty('plugin')) {
      $form_state
        ->setErrorByName('plugin', $this
        ->t('You must select the new shipping method.'));
    }
  }

  /**
   * Form submission handler for adding a new method.
   */
  public function submitAddMethod(array &$form, FormStateInterface $form_state) {
    $form_state
      ->setRedirect('entity.uc_quote_method.add_form', [
      'plugin_id' => $form_state
        ->getValue('plugin'),
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function render() {
    $build['description'] = [
      '#markup' => '<p>' . $this
        ->t('By default, only "Flat rate", "Percentage rate" and "Weight quote" shipping methods are listed here. To see additional shipping methods you must <a href=":install">install additional modules</a>. For more information about shipping methods and settings please read the <a href=":doc">Ubercart Documentation</a>.', [
        ':install' => Url::fromRoute('system.modules_list', [], [
          'fragment' => 'edit-modules-ubercart-shipping',
        ])
          ->toString(),
        ':doc' => Url::fromUri('https://www.drupal.org/docs/8/modules/ubercart')
          ->toString(),
      ]) . '</p><p>' . $this
        ->t('The order of methods shown below is the order those methods will appear on the checkout page. To re-order, drag the method to its desired location using the drag icon then save the configuration using the button at the bottom of the page.') . '</p>',
    ];
    $build += parent::render();
    return $build;
  }

}

Classes

Name	Description
ShippingQuoteMethodListBuilder	Provides a listing of shipping quote method entities.