OrderWorkflowForm.php in Ubercart 8.4

Namespace

Drupal\uc_order\Form

File

uc_order/src/Form/OrderWorkflowForm.php

<?php

namespace Drupal\uc_order\Form;

use Drupal\Core\Form\ConfigFormBase;
use Drupal\Core\Form\FormStateInterface;
use Drupal\uc_order\Entity\OrderStatus;

/**
 * Displays the order workflow form for order state and status customization.
 */
class OrderWorkflowForm extends ConfigFormBase {

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

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'uc_order.settings',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $states = uc_order_state_options_list();
    $statuses = OrderStatus::loadMultiple();
    $form['order_states'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Order states'),
    ];
    $form['order_states']['order_states'] = [
      '#type' => 'table',
      '#header' => [
        $this
          ->t('State'),
        $this
          ->t('Default order status'),
      ],
    ];
    foreach ($states as $state_id => $title) {
      $form['order_states']['order_states'][$state_id]['title'] = [
        '#markup' => $title,
      ];

      // Create the select box for specifying a default status per order state.
      $options = [];
      foreach ($statuses as $status) {
        if ($state_id == $status
          ->getState()) {
          $options[$status
            ->id()] = $status
            ->getName();
        }
      }
      if (empty($options)) {
        $form['order_states']['order_states'][$state_id]['default'] = [
          '#markup' => $this
            ->t('- N/A -'),
        ];
      }
      else {
        $form['order_states']['order_states'][$state_id]['default'] = [
          '#type' => 'select',
          '#options' => $options,
          '#default_value' => uc_order_state_default($state_id),
        ];
      }
    }
    $form['order_statuses'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Order statuses'),
      '#open' => TRUE,
    ];
    $form['order_statuses']['order_statuses'] = [
      '#type' => 'table',
      '#header' => [
        $this
          ->t('ID'),
        $this
          ->t('Title'),
        $this
          ->t('List position'),
        $this
          ->t('State'),
        $this
          ->t('Remove'),
      ],
    ];
    foreach ($statuses as $status) {
      $form['order_statuses']['order_statuses'][$status
        ->id()]['id'] = [
        '#markup' => $status
          ->id(),
      ];
      $form['order_statuses']['order_statuses'][$status
        ->id()]['name'] = [
        '#type' => 'textfield',
        '#default_value' => $status
          ->getName(),
        '#size' => 32,
        '#required' => TRUE,
      ];
      $form['order_statuses']['order_statuses'][$status
        ->id()]['weight'] = [
        '#type' => 'weight',
        '#delta' => 20,
        '#default_value' => $status
          ->getWeight(),
      ];
      if ($status
        ->isLocked()) {
        $form['order_statuses']['order_statuses'][$status
          ->id()]['state'] = [
          '#markup' => $states[$status
            ->getState()],
        ];
      }
      else {
        $form['order_statuses']['order_statuses'][$status
          ->id()]['state'] = [
          '#type' => 'select',
          '#options' => $states,
          '#default_value' => $status
            ->getState(),
        ];
        $form['order_statuses']['order_statuses'][$status
          ->id()]['remove'] = [
          '#type' => 'checkbox',
        ];
      }
    }
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('uc_order.settings');
    foreach ($form_state
      ->getValue('order_states') as $key => $value) {
      $config
        ->set("default_state.{$key}", $value['default']);
    }
    $config
      ->save();
    foreach ($form_state
      ->getValue('order_statuses') as $id => $value) {
      $status = OrderStatus::load($id);
      if (!empty($value['remove'])) {
        $status
          ->delete();
        $this
          ->messenger()
          ->addMessage($this
          ->t('Order status %status removed.', [
          '%status' => $status
            ->getName(),
        ]));
      }
      else {
        $status
          ->setName($value['name']);
        $status
          ->setWeight((int) $value['weight']);

        // The state cannot be changed if the status is locked.
        if (!$status
          ->isLocked()) {
          $status
            ->setState($value['state']);
        }
        $status
          ->save();
      }
    }
    parent::submitForm($form, $form_state);
  }

}

Classes

Name	Description
OrderWorkflowForm	Displays the order workflow form for order state and status customization.