PaymentMethodConfigurationForm.php in Payment 8.2

Namespace

Drupal\payment\Entity\PaymentMethodConfiguration

File

src/Entity/PaymentMethodConfiguration/PaymentMethodConfigurationForm.php

<?php

namespace Drupal\payment\Entity\PaymentMethodConfiguration;

use Drupal\Component\Plugin\PluginHelper;
use Drupal\Core\Entity\EntityForm;
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Entity\EntityStorageInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Session\AccountInterface;
use Drupal\Core\StringTranslation\TranslationInterface;
use Drupal\payment\Plugin\Payment\MethodConfiguration\PaymentMethodConfigurationManagerInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Provides the payment method configuration form.
 */
class PaymentMethodConfigurationForm extends EntityForm {

  /**
   * The current user.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $currentUser;

  /**
   * The payment method configuration manager.
   *
   * @var \Drupal\payment\Plugin\Payment\MethodConfiguration\PaymentMethodConfigurationManagerInterface
   */
  protected $paymentMethodConfigurationManager;

  /**
   * The payment method configuration storage.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $paymentMethodConfigurationStorage;

  /**
   * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
   *   The string translator.
   * @param \Drupal\Core\Session\AccountInterface $current_user
   *   The current user.
   * @param \Drupal\Core\Entity\EntityStorageInterface $payment_method_configuration_storage
   *   The payment method configuration storage.
   * @param \Drupal\payment\Plugin\Payment\MethodConfiguration\PaymentMethodConfigurationManagerInterface $payment_method_configuration_manager
   *   The payment method configuration manager.
   */
  function __construct(TranslationInterface $string_translation, AccountInterface $current_user, EntityStorageInterface $payment_method_configuration_storage, PaymentMethodConfigurationManagerInterface $payment_method_configuration_manager) {
    $this->currentUser = $current_user;
    $this->paymentMethodConfigurationManager = $payment_method_configuration_manager;
    $this->paymentMethodConfigurationStorage = $payment_method_configuration_storage;
    $this->stringTranslation = $string_translation;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {

    /** @var \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager */
    $entity_type_manager = $container
      ->get('entity_type.manager');
    return new static($container
      ->get('string_translation'), $container
      ->get('current_user'), $entity_type_manager
      ->getStorage('payment_method_configuration'), $container
      ->get('plugin.manager.payment.method_configuration'));
  }

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

    /** @var \Drupal\payment\Entity\PaymentMethodConfigurationInterface $payment_method_configuration */
    $payment_method_configuration = $this
      ->getEntity();
    $definition = $this->paymentMethodConfigurationManager
      ->getDefinition($payment_method_configuration
      ->getPluginId());
    $form['type'] = array(
      '#type' => 'item',
      '#title' => $this
        ->t('Type'),
      '#markup' => $definition['label'],
    );
    $form['status'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enabled'),
      '#default_value' => $payment_method_configuration
        ->status(),
    );
    $form['label'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Label'),
      '#default_value' => $payment_method_configuration
        ->label(),
      '#maxlength' => 255,
      '#required' => TRUE,
    );
    $form['id'] = array(
      '#type' => 'machine_name',
      '#default_value' => $payment_method_configuration
        ->id(),
      '#maxlength' => 255,
      '#required' => TRUE,
      '#machine_name' => array(
        'source' => array(
          'label',
        ),
        'exists' => array(
          $this,
          'paymentMethodConfigurationIdExists',
        ),
      ),
      '#disabled' => !$payment_method_configuration
        ->isNew(),
    );
    $form['owner'] = array(
      '#target_type' => 'user',
      '#type' => 'entity_autocomplete',
      '#title' => $this
        ->t('Owner'),
      '#default_value' => $payment_method_configuration
        ->getOwner() ? $payment_method_configuration
        ->getOwner() : $this->currentUser,
      '#required' => TRUE,
    );
    if ($form_state
      ->has('payment_method_configuration')) {
      $payment_method_configuration_plugin = $form_state
        ->get('payment_method_configuration');
    }
    else {
      $payment_method_configuration_plugin = $this->paymentMethodConfigurationManager
        ->createInstance($payment_method_configuration
        ->getPluginId(), $payment_method_configuration
        ->getPluginConfiguration());
      $form_state
        ->set('payment_method_configuration', $payment_method_configuration_plugin);
    }
    $form['plugin_form'] = array(
      '#tree' => TRUE,
    ) + $payment_method_configuration_plugin
      ->buildConfigurationForm([], $form_state);
    return parent::form($form, $form_state);
  }

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

    /** @var \Drupal\payment\Plugin\Payment\MethodConfiguration\PaymentMethodConfigurationInterface $payment_method_configuration */
    $payment_method_configuration = $form_state
      ->get('payment_method_configuration');
    $payment_method_configuration
      ->validateConfigurationForm($form['plugin_form'], $form_state);
  }

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

    /** @var \Drupal\payment\Plugin\Payment\MethodConfiguration\PaymentMethodConfigurationInterface $payment_method_configuration */
    $payment_method_configuration = $form_state
      ->get('payment_method_configuration');
    $payment_method_configuration
      ->submitConfigurationForm($form['plugin_form'], $form_state);
    parent::submitForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  protected function copyFormValuesToEntity(EntityInterface $payment_method_configuration, array $form, FormStateInterface $form_state) {

    /** @var \Drupal\payment\Entity\PaymentMethodConfigurationInterface $payment_method_configuration */
    parent::copyFormValuesToEntity($payment_method_configuration, $form, $form_state);
    $values = $form_state
      ->getValues();

    /** @var \Drupal\payment\Plugin\Payment\MethodConfiguration\PaymentMethodConfigurationInterface $payment_method_configuration_plugin */
    $payment_method_configuration_plugin = $form_state
      ->get('payment_method_configuration');
    $payment_method_configuration
      ->setLabel($values['label']);
    $payment_method_configuration
      ->setStatus($values['status']);
    $payment_method_configuration
      ->setOwnerId($values['owner']);
    $payment_method_configuration
      ->setPluginConfiguration(PluginHelper::isConfigurable($payment_method_configuration_plugin) ? $payment_method_configuration_plugin
      ->getConfiguration() : []);
  }

  /**
   * {@inheritdoc}
   */
  public function save(array $form, FormStateInterface $form_state) {
    parent::save($form, $form_state);
    $payment_method_configuration = $this
      ->getEntity();
    $this
      ->messenger()
      ->addMessage($this
      ->t('@label has been saved.', array(
      '@label' => $payment_method_configuration
        ->label(),
    )));
    $form_state
      ->setRedirectUrl($payment_method_configuration
      ->toUrl('collection'));
  }

  /**
   * Checks if a payment method with a particular ID already exists.
   *
   * @param string $id
   *
   * @return bool
   */
  public function paymentMethodConfigurationIdExists($id) {
    return (bool) $this->paymentMethodConfigurationStorage
      ->load($id);
  }

}

Classes

Name	Description
PaymentMethodConfigurationForm	Provides the payment method configuration form.