OrderSettingsForm.php in Commerce Core 8.2

Namespace

Drupal\commerce_order\Form

File

modules/order/src/Form/OrderSettingsForm.php

<?php

namespace Drupal\commerce_order\Form;

use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Form\ConfigFormBase;
use Drupal\Core\Form\FormStateInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;
class OrderSettingsForm extends ConfigFormBase {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Constructs a new OrderSettingsForm object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   */
  public function __construct(ConfigFactoryInterface $config_factory, EntityTypeManagerInterface $entity_type_manager) {
    parent::__construct($config_factory);
    $this->entityTypeManager = $entity_type_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('entity_type.manager'));
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildForm($form, $form_state);
    $config = $this
      ->config('commerce_order.settings');
    $form['log_version_mismatch_wrapper'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Order version mismatch handling'),
    ];
    $form['log_version_mismatch_wrapper']['description'] = [
      '#type' => 'item',
      '#markup' => $this
        ->t('<p>Order version mismatches occur when you attempt to save an order that has been saved by some other process.<br />Permitting the save could mean overwriting newer data with old data, causing meaningful data loss.</p>'),
    ];
    $form['log_version_mismatch_wrapper']['log_version_mismatch'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('When an order save is attempted with a version mismatch...'),
      '#options' => [
        1 => $this
          ->t('Allow it to be saved and log the event for debug purposes.'),
        0 => $this
          ->t('Prevent the save and throw an exception that may cause a fatal error.'),
      ],
      '#default_value' => (int) $config
        ->get('log_version_mismatch'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $config = $this
      ->config('commerce_order.settings');
    $config
      ->set('log_version_mismatch', (bool) $form_state
      ->getValue('log_version_mismatch'));
    $config
      ->save();

    // Rebuild entity type definitions so that the commerce_order entity type
    // definition respects the `log_version_mismatch` value.
    $this->entityTypeManager
      ->clearCachedDefinitions();
  }

}

Classes

Name	Description
OrderSettingsForm