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

File

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

Namespace

Drupal\commerce_payment\PluginForm

class PaymentRefundForm extends PaymentGatewayFormBase {

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

    /** @var \Drupal\commerce_payment\Entity\PaymentInterface $payment */
    $payment = $this->entity;
    $form['#success_message'] = $this
      ->t('Payment refunded.');
    $form['amount'] = [
      '#type' => 'commerce_price',
      '#title' => $this
        ->t('Amount'),
      '#default_value' => $payment
        ->getBalance()
        ->toArray(),
      '#required' => TRUE,
      '#available_currencies' => [
        $payment
          ->getAmount()
          ->getCurrencyCode(),
      ],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
    $values = $form_state
      ->getValue($form['#parents']);
    $amount = Price::fromArray($values['amount']);

    /** @var \Drupal\commerce_payment\Entity\PaymentInterface $payment */
    $payment = $this->entity;
    $balance = $payment
      ->getBalance();
    if ($amount
      ->greaterThan($balance)) {
      $form_state
        ->setError($form['amount'], $this
        ->t("Can't refund more than @amount.", [
        '@amount' => $balance
          ->__toString(),
      ]));
    }
  }

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

    /** @var \Drupal\commerce_payment\Entity\PaymentInterface $payment */
    $payment = $this->entity;

    /** @var \Drupal\commerce_payment\Plugin\Commerce\PaymentGateway\SupportsRefundsInterface $payment_gateway_plugin */
    $payment_gateway_plugin = $this->plugin;
    $payment_gateway_plugin
      ->refundPayment($payment, $amount);
  }

}

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