OrderTypeForm.php in Commerce Core 8.2

Namespace

Drupal\commerce_order\Form

File

modules/order/src/Form/OrderTypeForm.php

<?php

namespace Drupal\commerce_order\Form;

use Drupal\commerce\EntityHelper;
use Drupal\commerce\EntityTraitManagerInterface;
use Drupal\commerce_order\Entity\OrderType;
use Drupal\commerce\Form\CommerceBundleEntityFormBase;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\entity\Form\EntityDuplicateFormTrait;
use Drupal\state_machine\WorkflowManagerInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Provides an order type form.
 */
class OrderTypeForm extends CommerceBundleEntityFormBase {
  use EntityDuplicateFormTrait;

  /**
   * The workflow manager.
   *
   * @var \Drupal\state_machine\WorkflowManagerInterface
   */
  protected $workflowManager;

  /**
   * Constructs a new OrderTypeForm object.
   *
   * @param \Drupal\commerce\EntityTraitManagerInterface $trait_manager
   *   The entity trait manager.
   * @param \Drupal\state_machine\WorkflowManagerInterface $workflow_manager
   *   The workflow manager.
   */
  public function __construct(EntityTraitManagerInterface $trait_manager, WorkflowManagerInterface $workflow_manager) {
    parent::__construct($trait_manager);
    $this->workflowManager = $workflow_manager;
  }

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

  /**
   * {@inheritdoc}
   */
  public function form(array $form, FormStateInterface $form_state) {
    $form = parent::form($form, $form_state);

    /** @var \Drupal\commerce_order\Entity\OrderTypeInterface $order_type */
    $order_type = $this->entity;
    $workflows = $this->workflowManager
      ->getGroupedLabels('commerce_order');
    $number_pattern_storage = $this->entityTypeManager
      ->getStorage('commerce_number_pattern');
    $number_patterns = $number_pattern_storage
      ->loadByProperties([
      'targetEntityType' => 'commerce_order',
    ]);
    $form['#tree'] = TRUE;
    $form['label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Label'),
      '#maxlength' => 255,
      '#default_value' => $order_type
        ->label(),
      '#required' => TRUE,
    ];
    $form['id'] = [
      '#type' => 'machine_name',
      '#default_value' => $order_type
        ->id(),
      '#machine_name' => [
        'exists' => '\\Drupal\\commerce_order\\Entity\\OrderType::load',
        'source' => [
          'label',
        ],
      ],
      '#maxlength' => EntityTypeInterface::BUNDLE_MAX_LENGTH,
      '#disabled' => !$order_type
        ->isNew(),
    ];
    $form['workflow'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Workflow'),
      '#options' => $workflows,
      '#default_value' => $order_type
        ->getWorkflowId(),
      '#description' => $this
        ->t('Used by all orders of this type.'),
    ];
    $form['generate_number'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Generate a sequential order number when the order is placed'),
      '#default_value' => (bool) $order_type
        ->getNumberPatternId(),
    ];
    $form['numberPattern'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Number pattern'),
      '#default_value' => $order_type
        ->getNumberPatternId(),
      '#options' => EntityHelper::extractLabels($number_patterns),
      '#states' => [
        'visible' => [
          ':input[name="generate_number"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form = $this
      ->buildTraitForm($form, $form_state);
    $form['refresh'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Order refresh'),
      '#weight' => 5,
      '#open' => TRUE,
      '#tree' => FALSE,
    ];
    $form['refresh']['refresh_intro'] = [
      '#markup' => '<p>' . $this
        ->t('These settings let you control how draft orders are refreshed, the process during which prices are recalculated.') . '</p>',
    ];
    $form['refresh']['refresh_mode'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Order refresh mode'),
      '#options' => [
        OrderType::REFRESH_ALWAYS => $this
          ->t('Refresh a draft order when it is loaded regardless of who it belongs to.'),
        OrderType::REFRESH_CUSTOMER => $this
          ->t('Only refresh a draft order when it is loaded if it belongs to the current user.'),
      ],
      '#default_value' => $order_type
        ->isNew() ? OrderType::REFRESH_CUSTOMER : $order_type
        ->getRefreshMode(),
    ];
    $form['refresh']['refresh_frequency'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Order refresh frequency'),
      '#description' => $this
        ->t('Draft orders will only be refreshed if more than the specified number of seconds have passed since they were last refreshed.'),
      '#default_value' => $order_type
        ->isNew() ? 300 : $order_type
        ->getRefreshFrequency(),
      '#required' => TRUE,
      '#min' => 1,
      '#size' => 10,
      '#field_suffix' => $this
        ->t('seconds'),
    ];
    $form['emails'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Emails'),
      '#weight' => 5,
      '#open' => TRUE,
      '#collapsible' => TRUE,
      '#tree' => FALSE,
    ];
    $form['emails']['notice'] = [
      '#markup' => '<p>' . $this
        ->t('Emails are sent in the HTML format. You will need a module such as <a href="https://www.drupal.org/project/swiftmailer">Swiftmailer</a> to send HTML emails.') . '</p>',
    ];
    $form['emails']['sendReceipt'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Email the customer a receipt when an order is placed'),
      '#default_value' => $order_type
        ->isNew() ? TRUE : $order_type
        ->shouldSendReceipt(),
    ];
    $form['emails']['receiptBcc'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Send a copy of the receipt to this email:'),
      '#default_value' => $order_type
        ->isNew() ? '' : $order_type
        ->getReceiptBcc(),
      '#states' => [
        'visible' => [
          ':input[name="sendReceipt"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {

    /** @var \Drupal\state_machine\Plugin\Workflow\WorkflowInterface $workflow */
    $workflow = $this->workflowManager
      ->createInstance($form_state
      ->getValue('workflow'));

    // Verify "Place" transition.
    if (!$workflow
      ->getTransition('place')) {
      $form_state
        ->setError($form['workflow'], $this
        ->t('The @workflow workflow does not have a "Place" transition.', [
        '@workflow' => $workflow
          ->getLabel(),
      ]));
    }

    // Verify "draft" state.
    if (!$workflow
      ->getState('draft')) {
      $form_state
        ->setError($form['workflow'], $this
        ->t('The @workflow workflow does not have a "Draft" state.', [
        '@workflow' => $workflow
          ->getLabel(),
      ]));
    }

    // Remove the number pattern if the checkbox was unchecked.
    if (!$form_state
      ->getValue('generate_number')) {
      $form_state
        ->setValue('numberPattern', NULL);
    }
    $this
      ->validateTraitForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function save(array $form, FormStateInterface $form_state) {
    $this->entity
      ->save();
    $this
      ->postSave($this->entity, $this->operation);
    $this
      ->submitTraitForm($form, $form_state);
    $this
      ->messenger()
      ->addMessage($this
      ->t('Saved the %label order type.', [
      '%label' => $this->entity
        ->label(),
    ]));
    $form_state
      ->setRedirect('entity.commerce_order_type.collection');
  }

}

Classes

Name	Description
OrderTypeForm	Provides an order type form.