You are here

Home » API reference » Ubercart 8.4 » PackageController.php

class PackageController in Ubercart 8.4

Controller routines for packaging.

Hierarchy

Expanded class hierarchy of PackageController

File

shipping/uc_fulfillment/src/Controller/PackageController.php, line 15

Namespace

Drupal\uc_fulfillment\Controller
View source 
class PackageController extends ControllerBase {

  /**
   * Displays a list of an order's packaged products.
   *
   * @param \Drupal\uc_order\OrderInterface $uc_order
   *   The order.
   *
   * @return array|\Symfony\Component\HttpFoundation\RedirectResponse
   *   A render array, or a redirect response if there are no packaged products.
   */
  public function listOrderPackages(OrderInterface $uc_order) {
    $shipping_type_options = uc_quote_shipping_type_options();
    $header = [
      $this
        ->t('Package ID'),
      $this
        ->t('Products'),
      $this
        ->t('Shipping type'),
      $this
        ->t('Package type'),
      $this
        ->t('Shipment ID'),
      $this
        ->t('Tracking number'),
      $this
        ->t('Labels'),
      $this
        ->t('Actions'),
    ];
    $rows = [];
    $packages = Package::loadByOrder($uc_order
      ->id());
    foreach ($packages as $package) {
      $row = [];

      // Package ID.
      $row[] = [
        'data' => [
          '#plain_text' => $package
            ->id(),
        ],
      ];
      $product_list = [];
      foreach ($package
        ->getProducts() as $product) {
        $product_list[] = $product->qty . ' x ' . $product->model;
      }

      // Products.
      $row[] = [
        'data' => [
          '#theme' => 'item_list',
          '#items' => $product_list,
        ],
      ];

      // Shipping type.
      $row[] = isset($shipping_type_options[$package
        ->getShippingType()]) ? $shipping_type_options[$package
        ->getShippingType()] : strtr($package
        ->getShippingType(), '_', ' ');

      // Package type.
      $row[] = [
        'data' => [
          '#plain_text' => $package
            ->getPackageType(),
        ],
      ];

      // Shipment ID.
      $row[] = $package
        ->getSid() ? [
        'data' => [
          '#type' => 'link',
          '#title' => $package
            ->getSid(),
          '#url' => Url::fromRoute('uc_fulfillment.view_shipment', [
            'uc_order' => $uc_order
              ->id(),
            'uc_shipment' => $package
              ->getSid(),
          ]),
        ],
      ] : '';

      // Tracking number.
      $row[] = $package
        ->getTrackingNumber() ? [
        'data' => [
          '#plain_text' => $package
            ->getTrackingNumber(),
        ],
      ] : '';
      if ($package
        ->getLabelImage() && ($image = file_load($package
        ->getLabelImage()))) {
        $package
          ->setLabelImage($image);
      }
      else {
        $package
          ->setLabelImage('');
      }

      // Shipping label.
      if ($package
        ->getSid() && $package
        ->getLabelImage()) {
        $shipment = Shipment::load($package
          ->getSid());
        $row[] = Link::fromTextAndUrl("image goes here", Url::fromUri('base:admin/store/orders/' . $uc_order
          ->id() . '/shipments/labels/' . $shipment
          ->getShippingMethod() . '/' . $package
          ->getLabelImage()->uri, [
          'uc_order' => $uc_order
            ->id(),
          'method' => $shipment
            ->getShippingMethod(),
          'image_uri' => $package
            ->getLabelImage()->uri,
        ]))
          ->toString();
      }
      else {
        $row[] = '';
      }

      // Operations.
      $ops = [
        '#type' => 'operations',
        '#links' => [
          'edit' => [
            'title' => $this
              ->t('Edit'),
            'url' => Url::fromRoute('uc_fulfillment.edit_package', [
              'uc_order' => $uc_order
                ->id(),
              'uc_package' => $package
                ->id(),
            ]),
          ],
          'ship' => [
            'title' => $this
              ->t('Ship'),
            'url' => Url::fromRoute('uc_fulfillment.new_shipment', [
              'uc_order' => $uc_order
                ->id(),
            ], [
              'query' => [
                'pkgs' => $package
                  ->id(),
              ],
            ]),
          ],
          'delete' => [
            'title' => $this
              ->t('Delete'),
            'url' => Url::fromRoute('uc_fulfillment.delete_package', [
              'uc_order' => $uc_order
                ->id(),
              'uc_package' => $package
                ->id(),
            ]),
          ],
        ],
      ];
      if ($package
        ->getSid()) {
        $ops['#links']['cancel'] = [
          'title' => $this
            ->t('Cancel'),
          'url' => Url::fromRoute('uc_fulfillment.cancel_package', [
            'uc_order' => $uc_order
              ->id(),
            'uc_package' => $package
              ->id(),
          ]),
        ];
      }
      $row[] = [
        'data' => $ops,
      ];
      $rows[] = $row;
    }
    if (empty($rows)) {
      $this
        ->messenger()
        ->addWarning($this
        ->t("This order's products have not been organized into packages."));
      return $this
        ->redirect('uc_fulfillment.new_package', [
        'uc_order' => $uc_order
          ->id(),
      ]);
    }
    $build['packages'] = [
      '#theme' => 'table',
      '#header' => $header,
      '#rows' => $rows,
    ];
    return $build;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityManager protected property The entity manager.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 2
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 40
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityManager Deprecated protected function Retrieves the entity manager service.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state protected function Returns the state storage service.
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.
PackageController::listOrderPackages public function Displays a list of an order's packaged products.
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.