vendor/shopware/core/Checkout/Payment/PaymentMethodEntity.php line 19

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Checkout\Payment;
  5. use Shopware\Core\Checkout\Customer\CustomerCollection;
  6. use Shopware\Core\Checkout\Order\Aggregate\OrderTransaction\OrderTransactionCollection;
  7. use Shopware\Core\Checkout\Payment\Aggregate\PaymentMethodTranslation\PaymentMethodTranslationCollection;
  8. use Shopware\Core\Content\Media\MediaEntity;
  9. use Shopware\Core\Content\Rule\RuleEntity;
  10. use Shopware\Core\Framework\App\Aggregate\AppPaymentMethod\AppPaymentMethodEntity;
  11. use Shopware\Core\Framework\DataAbstractionLayer\Entity;
  12. use Shopware\Core\Framework\DataAbstractionLayer\EntityCustomFieldsTrait;
  13. use Shopware\Core\Framework\DataAbstractionLayer\EntityIdTrait;
  14. use Shopware\Core\Framework\Log\Package;
  15. use Shopware\Core\Framework\Plugin\PluginEntity;
  16. use Shopware\Core\System\SalesChannel\SalesChannelCollection;
  18. #[Package('checkout')]
  19. class PaymentMethodEntity extends Entity
  20. {
  21.     use EntityIdTrait;
  22.     use EntityCustomFieldsTrait;
  24.     /**
  25.      * @var string|null
  26.      */
  27.     protected $pluginId;
  29.     /**
  30.      * @var string
  31.      */
  32.     protected $handlerIdentifier;
  34.     /**
  35.      * @var string|null
  36.      */
  37.     protected $name;
  39.     /**
  40.      * @var string|null
  41.      */
  42.     protected $distinguishableName;
  44.     /**
  45.      * @var string|null
  46.      */
  47.     protected $description;
  49.     /**
  50.      * @var int
  51.      */
  52.     protected $position;
  54.     /**
  55.      * @var bool
  56.      */
  57.     protected $active;
  59.     /**
  60.      * @var bool
  61.      */
  62.     protected $afterOrderEnabled;
  64.     /**
  65.      * @var PluginEntity|null
  66.      */
  67.     protected $plugin;
  69.     /**
  70.      * @var PaymentMethodTranslationCollection|null
  71.      */
  72.     protected $translations;
  74.     /**
  75.      * @var OrderTransactionCollection|null
  76.      */
  77.     protected $orderTransactions;
  79.     /**
  80.      * @var CustomerCollection|null
  81.      */
  82.     protected $customers;
  84.     /**
  85.      * @var SalesChannelCollection|null
  86.      */
  87.     protected $salesChannelDefaultAssignments;
  89.     /**
  90.      * @var SalesChannelCollection|null
  91.      */
  92.     protected $salesChannels;
  94.     /**
  95.      * @var RuleEntity|null
  96.      */
  97.     protected $availabilityRule;
  99.     /**
  100.      * @var string|null
  101.      */
  102.     protected $availabilityRuleId;
  104.     /**
  105.      * @var string|null
  106.      */
  107.     protected $mediaId;
  109.     /**
  110.      * @var MediaEntity|null
  111.      */
  112.     protected $media;
  114.     /**
  115.      * @var string
  116.      */
  117.     protected $formattedHandlerIdentifier;
  119.     /**
  120.      * @var string|null
  121.      */
  122.     protected $shortName;
  124.     /**
  125.      * @var AppPaymentMethodEntity|null
  126.      */
  127.     protected $appPaymentMethod;
  129.     protected bool $synchronous = false;
  131.     protected bool $asynchronous = false;
  133.     protected bool $prepared = false;
  135.     protected bool $refundable = false;
  137.     public function getPluginId(): ?string
  138.     {
  139.         return $this->pluginId;
  140.     }
  142.     public function setPluginId(?string $pluginId): void
  143.     {
  144.         $this->pluginId = $pluginId;
  145.     }
  147.     public function getHandlerIdentifier(): string
  148.     {
  149.         return $this->handlerIdentifier;
  150.     }
  152.     public function setHandlerIdentifier(string $handlerIdentifier): void
  153.     {
  154.         $this->handlerIdentifier = $handlerIdentifier;
  155.     }
  157.     public function setFormattedHandlerIdentifier(string $formattedHandlerIdentifier): void
  158.     {
  159.         $this->formattedHandlerIdentifier = $formattedHandlerIdentifier;
  160.     }
  162.     public function getFormattedHandlerIdentifier(): string
  163.     {
  164.         return $this->formattedHandlerIdentifier;
  165.     }
  167.     public function getName(): ?string
  168.     {
  169.         return $this->name;
  170.     }
  172.     public function setName(string $name): void
  173.     {
  174.         $this->name = $name;
  175.     }
  177.     public function getDistinguishableName(): ?string
  178.     {
  179.         return $this->distinguishableName;
  180.     }
  182.     public function setDistinguishableName(?string $distinguishableName): void
  183.     {
  184.         $this->distinguishableName = $distinguishableName;
  185.     }
  187.     public function getDescription(): ?string
  188.     {
  189.         return $this->description;
  190.     }
  192.     public function setDescription(?string $description): void
  193.     {
  194.         $this->description = $description;
  195.     }
  197.     public function getPosition(): int
  198.     {
  199.         return $this->position;
  200.     }
  202.     public function setPosition(int $position): void
  203.     {
  204.         $this->position = $position;
  205.     }
  207.     public function getActive(): bool
  208.     {
  209.         return $this->active;
  210.     }
  212.     public function setActive(bool $active): void
  213.     {
  214.         $this->active = $active;
  215.     }
  217.     public function getPlugin(): ?PluginEntity
  218.     {
  219.         return $this->plugin;
  220.     }
  222.     public function setPlugin(PluginEntity $plugin): void
  223.     {
  224.         $this->plugin = $plugin;
  225.     }
  227.     public function getTranslations(): ?PaymentMethodTranslationCollection
  228.     {
  229.         return $this->translations;
  230.     }
  232.     public function setTranslations(PaymentMethodTranslationCollection $translations): void
  233.     {
  234.         $this->translations = $translations;
  235.     }
  237.     public function getOrderTransactions(): ?OrderTransactionCollection
  238.     {
  239.         return $this->orderTransactions;
  240.     }
  242.     public function setOrderTransactions(OrderTransactionCollection $orderTransactions): void
  243.     {
  244.         $this->orderTransactions = $orderTransactions;
  245.     }
  247.     public function getCustomers(): ?CustomerCollection
  248.     {
  249.         return $this->customers;
  250.     }
  252.     public function setCustomers(CustomerCollection $customers): void
  253.     {
  254.         $this->customers = $customers;
  255.     }
  257.     public function getSalesChannelDefaultAssignments(): ?SalesChannelCollection
  258.     {
  259.         return $this->salesChannelDefaultAssignments;
  260.     }
  262.     public function setSalesChannelDefaultAssignments(SalesChannelCollection $salesChannelDefaultAssignments): void
  263.     {
  264.         $this->salesChannelDefaultAssignments = $salesChannelDefaultAssignments;
  265.     }
  267.     public function getSalesChannels(): ?SalesChannelCollection
  268.     {
  269.         return $this->salesChannels;
  270.     }
  272.     public function setSalesChannels(SalesChannelCollection $salesChannels): void
  273.     {
  274.         $this->salesChannels = $salesChannels;
  275.     }
  277.     public function getAvailabilityRule(): ?RuleEntity
  278.     {
  279.         return $this->availabilityRule;
  280.     }
  282.     public function setAvailabilityRule(?RuleEntity $availabilityRule): void
  283.     {
  284.         $this->availabilityRule = $availabilityRule;
  285.     }
  287.     public function getAvailabilityRuleId(): ?string
  288.     {
  289.         return $this->availabilityRuleId;
  290.     }
  292.     public function setAvailabilityRuleId(?string $availabilityRuleId): void
  293.     {
  294.         $this->availabilityRuleId = $availabilityRuleId;
  295.     }
  297.     public function getMediaId(): ?string
  298.     {
  299.         return $this->mediaId;
  300.     }
  302.     public function setMediaId(?string $mediaId): void
  303.     {
  304.         $this->mediaId = $mediaId;
  305.     }
  307.     public function getMedia(): ?MediaEntity
  308.     {
  309.         return $this->media;
  310.     }
  312.     public function setMedia(?MediaEntity $media): void
  313.     {
  314.         $this->media = $media;
  315.     }
  317.     public function getAfterOrderEnabled(): bool
  318.     {
  319.         return $this->afterOrderEnabled;
  320.     }
  322.     public function setAfterOrderEnabled(bool $afterOrderEnabled): void
  323.     {
  324.         $this->afterOrderEnabled = $afterOrderEnabled;
  325.     }
  327.     public function getShortName(): ?string
  328.     {
  329.         return $this->shortName;
  330.     }
  332.     public function setShortName(?string $shortName): void
  333.     {
  334.         $this->shortName = $shortName;
  335.     }
  337.     public function getAppPaymentMethod(): ?AppPaymentMethodEntity
  338.     {
  339.         return $this->appPaymentMethod;
  340.     }
  342.     public function setAppPaymentMethod(?AppPaymentMethodEntity $appPaymentMethod): void
  343.     {
  344.         $this->appPaymentMethod = $appPaymentMethod;
  345.     }
  347.     public function isSynchronous(): bool
  348.     {
  349.         return $this->synchronous;
  350.     }
  352.     public function setSynchronous(bool $synchronous): void
  353.     {
  354.         $this->synchronous = $synchronous;
  355.     }
  357.     public function isAsynchronous(): bool
  358.     {
  359.         return $this->asynchronous;
  360.     }
  362.     public function setAsynchronous(bool $asynchronous): void
  363.     {
  364.         $this->asynchronous = $asynchronous;
  365.     }
  367.     public function isPrepared(): bool
  368.     {
  369.         return $this->prepared;
  370.     }
  372.     public function setPrepared(bool $prepared): void
  373.     {
  374.         $this->prepared = $prepared;
  375.     }
  377.     public function isRefundable(): bool
  378.     {
  379.         return $this->refundable;
  380.     }
  382.     public function setRefundable(bool $refundable): void
  383.     {
  384.         $this->refundable = $refundable;
  385.     }
  386. }