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

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\System\SalesChannel\SalesChannelContext;
  8. /**
  9.  * @method void                     add(PaymentMethodEntity $entity)
  10.  * @method void                     set(string $key, PaymentMethodEntity $entity)
  11.  * @method PaymentMethodEntity[]    getIterator()
  12.  * @method PaymentMethodEntity[]    getElements()
  13.  * @method PaymentMethodEntity|null get(string $key)
  14.  * @method PaymentMethodEntity|null first()
  15.  * @method PaymentMethodEntity|null last()
  16.  */
  17. class PaymentMethodCollection extends EntityCollection
  18. {
  19.     public function filterByActiveRules(SalesChannelContext $salesChannelContext): PaymentMethodCollection
  20.     {
  21.         return $this->filter(
  22.             function (PaymentMethodEntity $paymentMethod) use ($salesChannelContext) {
  23.                 if ($paymentMethod->getAvailabilityRuleId() === null) {
  24.                     return true;
  25.                 }
  27.                 return \in_array($paymentMethod->getAvailabilityRuleId(), $salesChannelContext->getRuleIds(), true);
  28.             }
  29.         );
  30.     }
  32.     public function getPluginIds(): array
  33.     {
  34.         return $this->fmap(function (PaymentMethodEntity $paymentMethod) {
  35.             return $paymentMethod->getPluginId();
  36.         });
  37.     }
  39.     public function filterByPluginId(string $id): self
  40.     {
  41.         return $this->filter(function (PaymentMethodEntity $paymentMethod) use ($id) {
  42.             return $paymentMethod->getPluginId() === $id;
  43.         });
  44.     }
  46.     /**
  47.      * Sorts the selected payment method first
  48.      * If a different default payment method is defined, it will be sorted second
  49.      * All other payment methods keep their respective sorting
  50.      */
  51.     public function sortPaymentMethodsByPreference(SalesChannelContext $context): void
  52.     {
  53.         $ids = array_merge(
  54.             [$context->getPaymentMethod()->getId(), $context->getSalesChannel()->getPaymentMethodId()],
  55.             $this->getIds()
  56.         );
  58.         $this->sortByIdArray($ids);
  59.     }
  61.     public function getApiAlias(): string
  62.     {
  63.         return 'payment_method_collection';
  64.     }
  66.     protected function getExpectedClass(): string
  67.     {
  68.         return PaymentMethodEntity::class;
  69.     }
  70. }