You are here

Home » API reference » Ubercart 8.4 » NewShipmentForm.php

class NewShipmentForm in Ubercart 8.4

Sets up a new shipment with the chosen packages.

Hierarchy

Expanded class hierarchy of NewShipmentForm

1 string reference to 'NewShipmentForm'
uc_fulfillment.routing.yml in shipping/uc_fulfillment/uc_fulfillment.routing.yml
shipping/uc_fulfillment/uc_fulfillment.routing.yml

File

shipping/uc_fulfillment/src/Form/NewShipmentForm.php, line 15

Namespace

Drupal\uc_fulfillment\Form
View source 
class NewShipmentForm extends FormBase {

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, OrderInterface $uc_order = NULL, Request $request = NULL) {
    $checked_pkgs = $request->query
      ->has('pkgs') ? (array) $request->query
      ->get('pkgs') : [];
    $form['#tree'] = TRUE;
    $form['#attached']['library'][] = 'uc_fulfillment/uc_fulfillment.scripts';
    $units = $this
      ->config('uc_store.settings')
      ->get('weight.units');
    $header = [
      // Fake out tableselect JavaScript into operating on our table.
      [
        'data' => '',
        'class' => [
          'select-all',
        ],
      ],
      'package' => $this
        ->t('Package'),
      'product' => $this
        ->t('Products'),
      'weight' => $this
        ->t('Weight'),
    ];
    $packages_by_type = [];
    $packages = Package::loadByOrder($uc_order
      ->id());
    foreach ($packages as $package) {
      if (!empty($package
        ->getSid())) {

        // This package is already part of a shipment.
        break;
      }
      $packages_by_type[$package
        ->getShippingType()][$package
        ->id()] = $package;
    }

    // Find FulfillmentMethod plugins.
    $methods = FulfillmentMethod::loadMultiple();
    uasort($methods, 'Drupal\\uc_fulfillment\\Entity\\FulfillmentMethod::sort');
    foreach ($methods as $method) {

      // Available fulfillment methods indexed by package type.
      $shipping_methods_by_type[$method
        ->getPackageType()][] = $method;
    }
    $pkgs_exist = FALSE;
    $option_methods = [];
    $shipping_types = uc_quote_get_shipping_types();
    foreach ($packages_by_type as $shipping_type => $packages) {
      $form['shipping_types'][$shipping_type] = [
        '#type' => 'fieldset',
        '#title' => $shipping_types[$shipping_type]['title'],
      ];
      $rows = [];
      $form['shipping_types'][$shipping_type]['table'] = [
        '#type' => 'table',
        '#header' => $header,
        '#empty' => $this
          ->t('There are no packages available to ship.'),
      ];
      foreach ($packages as $package) {
        $pkgs_exist = TRUE;
        $row = [];
        $row['checked'] = [
          '#type' => 'checkbox',
          '#default_value' => in_array($package
            ->id(), $checked_pkgs) ? 1 : 0,
        ];
        $row['package_id'] = [
          '#markup' => $package
            ->id(),
        ];
        $product_list = [];
        foreach ($package
          ->getProducts() as $product) {
          $product_list[] = $product->qty . ' x ' . $product->model;
        }
        $row['products'] = [
          '#theme' => 'item_list',
          '#items' => $product_list,
        ];
        $row['weight'] = [
          '#markup' => uc_weight_format($package
            ->getWeight(), $units),
        ];
        $form['shipping_types'][$shipping_type]['table'][$package
          ->id()] = $row;
      }
      if (isset($shipping_methods_by_type[$shipping_type])) {
        foreach ($shipping_methods_by_type[$shipping_type] as $method) {
          $option_methods += [
            $method
              ->id() => $method
              ->label(),
          ];
        }
      }
    }
    $form['order_id'] = [
      '#type' => 'hidden',
      '#value' => $uc_order
        ->id(),
    ];
    if ($pkgs_exist) {

      // uc_fulfillment has a default plugin to provide the "Manual" method.
      $form['method'] = [
        '#type' => 'select',
        '#title' => $this
          ->t('Shipping method'),
        '#options' => $option_methods,
        '#default_value' => 'manual',
      ];
      $form['actions'] = [
        '#type' => 'actions',
      ];
      $form['actions']['ship'] = [
        '#type' => 'submit',
        '#value' => $this
          ->t('Ship packages'),
      ];
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $packages = [];
    $i = 1;
    foreach ($form_state
      ->getValue('shipping_types') as $shipping_type) {
      if (is_array($shipping_type['table'])) {
        foreach ($shipping_type['table'] as $id => $input) {
          if ($input['checked']) {
            $packages[$i++] = $id;
          }
        }
      }
    }
    $form_state
      ->setRedirect('uc_fulfillment.make_shipment', [
      'uc_order' => $form_state
        ->getValue('order_id'),
    ], [
      'query' => array_merge([
        'method_id' => $form_state
          ->getValue('method'),
      ], $packages),
    ]);

    //$form_state['redirect'] = 'admin/store/orders/{uc_order}/ship/' . $form_state->getValue('method') . '/' . implode('/', $packages);
  }

}

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
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
FormBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 87
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
NewShipmentForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
NewShipmentForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
NewShipmentForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
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.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.