You are here

Home » API reference » Ubercart 8.4 » PackageCancelForm.php

class PackageCancelForm in Ubercart 8.4

Confirms cancellation of a package's shipment.

Hierarchy

Expanded class hierarchy of PackageCancelForm

1 string reference to 'PackageCancelForm'
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/PackageCancelForm.php, line 17

Namespace

Drupal\uc_fulfillment\Form
View source 
class PackageCancelForm extends ConfirmFormBase {

  /**
   * The order id.
   *
   * @var \Drupal\uc_order\OrderInterface
   */
  protected $order_id;

  /**
   * The package.
   *
   * @var \Drupal\uc_fulfillment\PackageInterface
   */
  protected $package;

  /**
   * The module handler.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * Form constructor.
   *
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler.
   */
  public function __construct(ModuleHandlerInterface $module_handler) {
    $this->moduleHandler = $module_handler;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('module_handler'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {
    return $this
      ->t('Are you sure you want to cancel the shipment of this package?');
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    return $this
      ->t('It will be available for reshipment.');
  }

  /**
   * {@inheritdoc}
   */
  public function getConfirmText() {
    return $this
      ->t('Cancel shipment');
  }

  /**
   * {@inheritdoc}
   */
  public function getCancelText() {
    return $this
      ->t('Nevermind');
  }

  /**
   * {@inheritdoc}
   */
  public function getCancelUrl() {
    return Url::fromRoute('uc_fulfillment.packages', [
      'uc_order' => $this->order_id,
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, OrderInterface $uc_order = NULL, PackageInterface $uc_package = NULL) {
    $this->order_id = $uc_order
      ->id();
    $this->package = $uc_package;
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $shipment = Shipment::load($this->package
      ->getSid());
    $methods = $this->moduleHandler
      ->invokeAll('uc_fulfillment_method');

    // The notion of "cancel" is specific to the fulfillment method, therefore
    // we delegate all the work to the plugin.
    // @todo Replace this with calls to the plugin cancel method instead of hooks.
    if (isset($methods[$shipment
      ->getShippingMethod()]['cancel']) && function_exists($methods[$shipment
      ->getShippingMethod()]['cancel'])) {
      $result = call_user_func($methods[$shipment
        ->getShippingMethod()]['cancel'], $shipment
        ->getTrackingNumber(), [
        $this->package
          ->getTrackingNumber(),
      ]);
      if ($result) {
        \Drupal::database()
          ->update('uc_packages')
          ->fields([
          'sid' => NULL,
          'label_image' => NULL,
          'tracking_number' => NULL,
        ])
          ->condition('package_id', $this->package
          ->id())
          ->execute();
        if ($this->package
          ->getLabelImage()) {
          file_usage_delete($this->package
            ->getLabelImage(), 'uc_fulfillment', 'package', $this->package
            ->id());
          file_delete($this->package
            ->getLabelImage());
          $this->package
            ->setLabelImage('');
        }
        unset($shipment->packages[$this->package
          ->id()]);
        if (!count($shipment
          ->getPackages())) {
          $shipment
            ->delete();
        }
      }
    }
    $form_state
      ->setRedirectUrl($this
      ->getCancelUrl());
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfirmFormBase::getFormName public function Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface::getFormName
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::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.
PackageCancelForm::$moduleHandler protected property The module handler.
PackageCancelForm::$order_id protected property The order id.
PackageCancelForm::$package protected property The package.
PackageCancelForm::buildForm public function Form constructor. Overrides ConfirmFormBase::buildForm
PackageCancelForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
PackageCancelForm::getCancelText public function Returns a caption for the link which cancels the action. Overrides ConfirmFormBase::getCancelText
PackageCancelForm::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
PackageCancelForm::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
PackageCancelForm::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormBase::getDescription
PackageCancelForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
PackageCancelForm::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
PackageCancelForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
PackageCancelForm::__construct public function Form constructor.
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.