vendor/shopware/core/Checkout/Payment/PaymentMethodCollection.php line 13

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Checkout\Payment;
  5. use Shopware\Core\Framework\DataAbstractionLayer\EntityCollection;
  6. use Shopware\Core\Framework\Log\Package;
  7. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  9. /**
  10.  * @extends EntityCollection<PaymentMethodEntity>
  11.  */
  12. #[Package('checkout')]
  13. class PaymentMethodCollection extends EntityCollection
  14. {
  15.     public function filterByActiveRules(SalesChannelContext $salesChannelContext): PaymentMethodCollection
  16.     {
  17.         return $this->filter(
  18.             function (PaymentMethodEntity $paymentMethod) use ($salesChannelContext) {
  19.                 if ($paymentMethod->getAvailabilityRuleId() === null) {
  20.                     return true;
  21.                 }
  23.                 return \in_array($paymentMethod->getAvailabilityRuleId(), $salesChannelContext->getRuleIds(), true);
  24.             }
  25.         );
  26.     }
  28.     /**
  29.      * @return list<string>
  30.      */
  31.     public function getPluginIds(): array
  32.     {
  33.         return $this->fmap(function (PaymentMethodEntity $paymentMethod) {
  34.             return $paymentMethod->getPluginId();
  35.         });
  36.     }
  38.     public function filterByPluginId(string $id): self
  39.     {
  40.         return $this->filter(function (PaymentMethodEntity $paymentMethod) use ($id) {
  41.             return $paymentMethod->getPluginId() === $id;
  42.         });
  43.     }
  45.     /**
  46.      * Sorts the selected payment method first
  47.      * If a different default payment method is defined, it will be sorted second
  48.      * All other payment methods keep their respective sorting
  49.      */
  50.     public function sortPaymentMethodsByPreference(SalesChannelContext $context): void
  51.     {
  52.         $ids = array_merge(
  53.             [$context->getPaymentMethod()->getId(), $context->getSalesChannel()->getPaymentMethodId()],
  54.             $this->getIds()
  55.         );
  57.         $this->sortByIdArray($ids);
  58.     }
  60.     public function getApiAlias(): string
  61.     {
  62.         return 'payment_method_collection';
  63.     }
  65.     protected function getExpectedClass(): string
  66.     {
  67.         return PaymentMethodEntity::class;
  68.     }
  69. }