class PaymentMethodFormBase in Commerce Core 8.2

Hierarchy

• class \Drupal\Core\Plugin\PluginFormBase implements PluginAwareInterface, PluginFormInterface
  • class \Drupal\commerce_payment\PluginForm\PaymentGatewayFormBase implements PaymentGatewayFormInterface uses DependencySerializationTrait, StringTranslationTrait
    • class \Drupal\commerce_payment\PluginForm\PaymentMethodFormBase implements ContainerInjectionInterface

File

modules/payment/src/PluginForm/PaymentMethodFormBase.php, line 13

Namespace

Drupal\commerce_payment\PluginForm

class PaymentMethodFormBase extends PaymentGatewayFormBase implements ContainerInjectionInterface {

  /**
   * The current store.
   *
   * @var \Drupal\commerce_store\CurrentStoreInterface
   */
  protected $currentStore;

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

  /**
   * The inline form manager.
   *
   * @var \Drupal\commerce\InlineFormManager
   */
  protected $inlineFormManager;

  /**
   * The logger.
   *
   * @var \Psr\Log\LoggerInterface
   */
  protected $logger;

  /**
   * Constructs a new PaymentMethodFormBase.
   *
   * @param \Drupal\commerce_store\CurrentStoreInterface $current_store
   *   The current store.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\commerce\InlineFormManager $inline_form_manager
   *   The inline form manager.
   * @param \Psr\Log\LoggerInterface $logger
   *   The logger.
   */
  public function __construct(CurrentStoreInterface $current_store, EntityTypeManagerInterface $entity_type_manager, InlineFormManager $inline_form_manager, LoggerInterface $logger) {
    $this->currentStore = $current_store;
    $this->entityTypeManager = $entity_type_manager;
    $this->inlineFormManager = $inline_form_manager;
    $this->logger = $logger;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('commerce_store.current_store'), $container
      ->get('entity_type.manager'), $container
      ->get('plugin.manager.commerce_inline_form'), $container
      ->get('logger.channel.commerce_payment'));
  }

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

    /** @var \Drupal\commerce_payment\Plugin\Commerce\PaymentGateway\OnsitePaymentGatewayInterface $payment_gateway_plugin */
    $payment_gateway_plugin = $this->plugin;

    /** @var \Drupal\commerce_payment\Entity\PaymentMethodInterface $payment_method */
    $payment_method = $this->entity;
    $form['#attached']['library'][] = 'commerce_payment/payment_method_form';
    $form['#tree'] = TRUE;
    if ($payment_gateway_plugin
      ->collectsBillingInformation()) {
      $billing_profile = $payment_method
        ->getBillingProfile();
      if (!$billing_profile) {
        $profile_storage = $this->entityTypeManager
          ->getStorage('profile');
        $billing_profile = $profile_storage
          ->create([
          'type' => 'customer',
          'uid' => 0,
        ]);
      }
      $store = $this->currentStore
        ->getStore();
      $inline_form = $this->inlineFormManager
        ->createInstance('customer_profile', [
        'profile_scope' => 'billing',
        'available_countries' => $store ? $store
          ->getBillingCountries() : [],
        'address_book_uid' => $payment_method
          ->getOwnerId(),
      ], $billing_profile);
      $form['billing_information'] = [
        '#parents' => array_merge($form['#parents'], [
          'billing_information',
        ]),
        '#inline_form' => $inline_form,
      ];
      $form['billing_information'] = $inline_form
        ->buildInlineForm($form['billing_information'], $form_state);
    }
    return $form;
  }

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

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

    /** @var \Drupal\commerce_payment\Plugin\Commerce\PaymentGateway\OnsitePaymentGatewayInterface $payment_gateway_plugin */
    $payment_gateway_plugin = $this->plugin;

    /** @var \Drupal\commerce_payment\Entity\PaymentMethodInterface $payment_method */
    $payment_method = $this->entity;
    if ($payment_gateway_plugin
      ->collectsBillingInformation()) {

      /** @var \Drupal\commerce\Plugin\Commerce\InlineForm\EntityInlineFormInterface $inline_form */
      $inline_form = $form['billing_information']['#inline_form'];

      /** @var \Drupal\profile\Entity\ProfileInterface $billing_profile */
      $billing_profile = $inline_form
        ->getEntity();
      $payment_method
        ->setBillingProfile($billing_profile);
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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
PaymentGatewayFormBase::$entity	protected	property	The form entity.
PaymentGatewayFormBase::getEntity	public	function	Gets the form entity. Overrides PaymentGatewayFormInterface::getEntity
PaymentGatewayFormBase::getErrorElement	public	function	Gets the form element to which errors should be assigned. Overrides PaymentGatewayFormInterface::getErrorElement	1
PaymentGatewayFormBase::setEntity	public	function	Sets the form entity. Overrides PaymentGatewayFormInterface::setEntity
PaymentMethodFormBase::$currentStore	protected	property	The current store.
PaymentMethodFormBase::$entityTypeManager	protected	property	The entity type manager.
PaymentMethodFormBase::$inlineFormManager	protected	property	The inline form manager.
PaymentMethodFormBase::$logger	protected	property	The logger.
PaymentMethodFormBase::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm	2
PaymentMethodFormBase::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create
PaymentMethodFormBase::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm	2
PaymentMethodFormBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormBase::validateConfigurationForm	2
PaymentMethodFormBase::__construct	public	function	Constructs a new PaymentMethodFormBase.
PluginFormBase::$plugin	protected	property	The plugin this form is for.	3
PluginFormBase::setPlugin	public	function	Sets the plugin for this object. Overrides PluginAwareInterface::setPlugin	1
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.