class OnsitePaymentAddForm 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\OnsitePaymentAddForm

File

modules/payment/src/PluginForm/OnsitePaymentAddForm.php, line 8

Namespace

Drupal\commerce_payment\PluginForm

class OnsitePaymentAddForm extends PaymentGatewayFormBase {

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

    /** @var \Drupal\commerce_payment\Entity\PaymentInterface $payment */
    $payment = $this->entity;
    $order = $payment
      ->getOrder();
    if (!$order) {
      throw new \InvalidArgumentException('Payment entity with no order reference given to PaymentAddForm.');
    }

    // The payment amount should not exceed the remaining order balance.
    $balance = $order
      ->getBalance();
    $amount = $balance
      ->isPositive() ? $balance : $balance
      ->multiply(0);
    $form['amount'] = [
      '#type' => 'commerce_price',
      '#title' => $this
        ->t('Amount'),
      '#default_value' => $amount
        ->toArray(),
      '#required' => TRUE,
    ];
    $form['transaction_type'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Transaction type'),
      '#title_display' => 'invisible',
      '#options' => [
        'authorize' => $this
          ->t('Authorize only'),
        'capture' => $this
          ->t('Authorize and capture'),
      ],
      '#default_value' => 'capture',
      '#access' => $this->plugin instanceof SupportsAuthorizationsInterface,
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    $values = $form_state
      ->getValue($form['#parents']);
    $capture = $values['transaction_type'] == 'capture';

    /** @var \Drupal\commerce_payment\Entity\PaymentInterface $payment */
    $payment = $this->entity;
    $payment->amount = $values['amount'];

    /** @var \Drupal\commerce_payment\Plugin\Commerce\PaymentGateway\OnsitePaymentGatewayInterface $payment_gateway_plugin */
    $payment_gateway_plugin = $this->plugin;
    $payment_gateway_plugin
      ->createPayment($payment, $capture);
  }

}

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
OnsitePaymentAddForm::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm
OnsitePaymentAddForm::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
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
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
PluginFormBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm	2
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.