View source
<?php
namespace Drupal\commerce_payment\Plugin\Commerce\PaymentGateway;
use Drupal\commerce_payment\CreditCard;
use Drupal\commerce_payment\Entity\PaymentInterface;
use Drupal\commerce_payment\Entity\PaymentMethodInterface;
use Drupal\commerce_payment\Exception\HardDeclineException;
use Drupal\commerce_payment\Exception\InvalidRequestException;
use Drupal\commerce_payment\PaymentMethodTypeManager;
use Drupal\commerce_payment\PaymentTypeManager;
use Drupal\commerce_price\MinorUnitsConverterInterface;
use Drupal\commerce_price\Price;
use Drupal\Component\Datetime\TimeInterface;
use Drupal\Component\Utility\NestedArray;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\Core\Plugin\PluginBase;
use Drupal\Core\Plugin\PluginWithFormsTrait;
use Drupal\user\UserInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;
abstract class PaymentGatewayBase extends PluginBase implements PaymentGatewayInterface, ContainerFactoryPluginInterface {
use PluginWithFormsTrait;
protected $entityTypeManager;
protected $parentEntity;
protected $entityId;
protected $paymentType;
protected $paymentMethodTypes;
protected $time;
protected $minorUnitsConverter;
public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager, PaymentTypeManager $payment_type_manager, PaymentMethodTypeManager $payment_method_type_manager, TimeInterface $time, MinorUnitsConverterInterface $minor_units_converter = NULL) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this->entityTypeManager = $entity_type_manager;
$this->time = $time;
if (!$minor_units_converter instanceof MinorUnitsConverterInterface) {
@trigger_error('Calling PaymentGatewayBase::__construct() with the $minor_units_converter argument is supported in commerce:2.25 and will be required before commerce:3.0. See https://www.drupal.org/project/commerce/issues/3150917.', E_USER_DEPRECATED);
$minor_units_converter = \Drupal::service('commerce_price.minor_units_converter');
}
$this->minorUnitsConverter = $minor_units_converter;
if (array_key_exists('_entity', $configuration)) {
$this->parentEntity = $configuration['_entity'];
$this->entityId = $this->parentEntity
->id();
unset($configuration['_entity']);
}
$this->paymentType = $payment_type_manager
->createInstance($this->pluginDefinition['payment_type']);
foreach ($this->pluginDefinition['payment_method_types'] as $plugin_id) {
$this->paymentMethodTypes[$plugin_id] = $payment_method_type_manager
->createInstance($plugin_id);
}
$this->pluginDefinition['forms'] += $this
->getDefaultForms();
$this
->setConfiguration($configuration);
}
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($configuration, $plugin_id, $plugin_definition, $container
->get('entity_type.manager'), $container
->get('plugin.manager.commerce_payment_type'), $container
->get('plugin.manager.commerce_payment_method_type'), $container
->get('datetime.time'), $container
->get('commerce_price.minor_units_converter'));
}
public function __sleep() {
if (!empty($this->parentEntity)) {
$this->_parentEntityId = $this->parentEntity
->id();
unset($this->parentEntity);
}
return parent::__sleep();
}
public function __wakeup() {
parent::__wakeup();
if (!empty($this->_parentEntityId)) {
$payment_gateway_storage = $this->entityTypeManager
->getStorage('commerce_payment_gateway');
$this->parentEntity = $payment_gateway_storage
->load($this->_parentEntityId);
unset($this->_parentEntityId);
}
}
protected function getDefaultForms() {
$default_forms = [];
if ($this instanceof SupportsStoredPaymentMethodsInterface) {
$default_forms['add-payment-method'] = 'Drupal\\commerce_payment\\PluginForm\\PaymentMethodAddForm';
}
if ($this instanceof SupportsUpdatingStoredPaymentMethodsInterface) {
$default_forms['edit-payment-method'] = 'Drupal\\commerce_payment\\PluginForm\\PaymentMethodEditForm';
}
if ($this instanceof SupportsAuthorizationsInterface) {
$default_forms['capture-payment'] = 'Drupal\\commerce_payment\\PluginForm\\PaymentCaptureForm';
}
if ($this instanceof SupportsVoidsInterface) {
$default_forms['void-payment'] = 'Drupal\\commerce_payment\\PluginForm\\PaymentVoidForm';
}
if ($this instanceof SupportsRefundsInterface) {
$default_forms['refund-payment'] = 'Drupal\\commerce_payment\\PluginForm\\PaymentRefundForm';
}
return $default_forms;
}
public function getLabel() {
return $this->pluginDefinition['label'];
}
public function getDisplayLabel() {
return $this->configuration['display_label'];
}
public function getMode() {
return $this->configuration['mode'];
}
public function getSupportedModes() {
return $this->pluginDefinition['modes'];
}
public function getJsLibrary() {
$js_library = NULL;
if (!empty($this->pluginDefinition['js_library'])) {
$js_library = $this->pluginDefinition['js_library'];
}
return $js_library;
}
public function getPaymentType() {
return $this->paymentType;
}
public function getPaymentMethodTypes() {
return array_intersect_key($this->paymentMethodTypes, array_flip($this->configuration['payment_method_types']));
}
public function getDefaultPaymentMethodType() {
$default_payment_method_type = $this->pluginDefinition['default_payment_method_type'];
if (!isset($this->paymentMethodTypes[$default_payment_method_type])) {
throw new \InvalidArgumentException('Invalid default_payment_method_type specified.');
}
return $this->paymentMethodTypes[$default_payment_method_type];
}
public function getCreditCardTypes() {
return array_intersect_key(CreditCard::getTypes(), array_flip($this->pluginDefinition['credit_card_types']));
}
public function collectsBillingInformation() {
return $this->configuration['collect_billing_information'];
}
public function calculateDependencies() {
return [];
}
public function getConfiguration() {
return $this->configuration;
}
public function setConfiguration(array $configuration) {
$this->configuration = NestedArray::mergeDeep($this
->defaultConfiguration(), $configuration);
if (empty($this->configuration['payment_method_types'])) {
$this->configuration['payment_method_types'][] = 'credit_card';
}
}
public function defaultConfiguration() {
$modes = array_keys($this
->getSupportedModes());
return [
'display_label' => $this->pluginDefinition['display_label'],
'mode' => $modes ? reset($modes) : '',
'payment_method_types' => [],
'collect_billing_information' => TRUE,
];
}
public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
$modes = $this
->getSupportedModes();
$payment_method_types = array_map(function ($payment_method_type) {
return $payment_method_type
->getLabel();
}, $this->paymentMethodTypes);
$form['display_label'] = [
'#type' => 'textfield',
'#title' => $this
->t('Display name'),
'#description' => $this
->t('Shown to customers during checkout.'),
'#default_value' => $this->configuration['display_label'],
'#required' => TRUE,
];
if (count($modes) > 1) {
$form['mode'] = [
'#type' => 'radios',
'#title' => $this
->t('Mode'),
'#options' => $modes,
'#default_value' => $this->configuration['mode'],
'#required' => TRUE,
];
}
else {
$mode_names = array_keys($modes);
$form['mode'] = [
'#type' => 'value',
'#value' => reset($mode_names),
];
}
if (count($payment_method_types) > 1) {
$form['payment_method_types'] = [
'#type' => 'checkboxes',
'#title' => $this
->t('Payment method types'),
'#options' => $payment_method_types,
'#default_value' => $this->configuration['payment_method_types'],
'#required' => TRUE,
];
}
else {
$form['payment_method_types'] = [
'#type' => 'value',
'#value' => $payment_method_types,
];
}
$form['collect_billing_information'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Collect billing information'),
'#description' => $this
->t('Before disabling, make sure you are not legally required to collect billing information.'),
'#default_value' => $this->configuration['collect_billing_information'],
'#access' => !$this->pluginDefinition['requires_billing_information'],
];
return $form;
}
public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
}
public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
if (!$form_state
->getErrors()) {
$values = $form_state
->getValue($form['#parents']);
$values['payment_method_types'] = array_filter($values['payment_method_types']);
$this->configuration = [];
$this->configuration['display_label'] = $values['display_label'];
$this->configuration['mode'] = $values['mode'];
$this->configuration['payment_method_types'] = array_keys($values['payment_method_types']);
$this->configuration['collect_billing_information'] = $values['collect_billing_information'];
}
}
public function buildPaymentOperations(PaymentInterface $payment) {
$operations = [];
if ($this instanceof SupportsAuthorizationsInterface) {
$operations['capture'] = [
'title' => $this
->t('Capture'),
'page_title' => $this
->t('Capture payment'),
'plugin_form' => 'capture-payment',
'access' => $this
->canCapturePayment($payment),
];
}
if ($this instanceof SupportsVoidsInterface) {
$operations['void'] = [
'title' => $this
->t('Void'),
'page_title' => $this
->t('Void payment'),
'plugin_form' => 'void-payment',
'access' => $this
->canVoidPayment($payment),
];
}
if ($this instanceof SupportsRefundsInterface) {
$operations['refund'] = [
'title' => $this
->t('Refund'),
'page_title' => $this
->t('Refund payment'),
'plugin_form' => 'refund-payment',
'access' => $this
->canRefundPayment($payment),
];
}
return $operations;
}
public function canCapturePayment(PaymentInterface $payment) {
return $payment
->getState()
->getId() === 'authorization';
}
public function canRefundPayment(PaymentInterface $payment) {
return in_array($payment
->getState()
->getId(), [
'completed',
'partially_refunded',
], TRUE);
}
public function canVoidPayment(PaymentInterface $payment) {
return $payment
->getState()
->getId() === 'authorization';
}
public function buildAvsResponseCodeLabel($avs_response_code, $card_type) {
$avs_code_meanings = CreditCard::getAvsResponseCodeMeanings();
if (!isset($avs_code_meanings[$card_type][$avs_response_code])) {
return NULL;
}
return $avs_code_meanings[$card_type][$avs_response_code];
}
public function toMinorUnits(Price $amount) {
return $this->minorUnitsConverter
->toMinorUnits($amount);
}
protected function getRemoteCustomerId(UserInterface $account) {
$remote_id = NULL;
if ($account
->isAuthenticated()) {
$provider = $this->parentEntity
->id() . '|' . $this
->getMode();
$remote_ids = $account
->get('commerce_remote_id');
$remote_id = $remote_ids
->getByProvider($provider);
if (!$remote_id) {
$remote_id = $remote_ids
->getByProvider($this->pluginDefinition['provider']);
if ($remote_id) {
$remote_ids
->setByProvider($this->pluginDefinition['provider'], NULL);
$remote_ids
->setByProvider($provider, $remote_id);
$account
->save();
}
}
}
return $remote_id;
}
protected function setRemoteCustomerId(UserInterface $account, $remote_id) {
if ($account
->isAuthenticated()) {
$remote_ids = $account
->get('commerce_remote_id');
$remote_ids
->setByProvider($this->parentEntity
->id() . '|' . $this
->getMode(), $remote_id);
}
}
protected function assertPaymentState(PaymentInterface $payment, array $states) {
$state = $payment
->getState()
->getId();
if (!in_array($state, $states)) {
throw new \InvalidArgumentException(sprintf('The provided payment is in an invalid state ("%s").', $state));
}
}
protected function assertPaymentMethod(PaymentMethodInterface $payment_method = NULL) {
if (empty($payment_method)) {
throw new \InvalidArgumentException('The provided payment has no payment method referenced.');
}
if ($payment_method
->isExpired()) {
throw new HardDeclineException('The provided payment method has expired');
}
}
protected function assertRefundAmount(PaymentInterface $payment, Price $refund_amount) {
$balance = $payment
->getBalance();
if ($refund_amount
->greaterThan($balance)) {
throw new InvalidRequestException(sprintf("Can't refund more than %s.", $balance
->__toString()));
}
}
}