Should `quickpay` be a constant somewhere?

[loevgaard]

It's used for the Payum factory name for example.

Context

The quickpay gateway factory name is a magic string in seven places today:

PHP (can use a constant):

• src/Controller/NotifyAction.php — findBy(['factoryName' => 'quickpay']) for the per-gateway order-prefix resolution
• src/Provider/PendingPaymentProvider.php — ->setParameter('factoryName', 'quickpay')
• tests/Controller/NotifyActionTest.php, tests/StateMachine/PaymentProcessorTest.php

services.xml (cannot use a constant — XML tag attributes take literals only):

• <tag name="payum.action" factory="quickpay">
• <tag name="sylius.gateway_configuration_type" type="quickpay">
• <tag name="payum.gateway_factory_builder" factory="quickpay"/>

And the list is about to grow: the RefundPlugin integration (#104) needs the factory name in the sylius_refund.supported_gateways parameter and in "is this a Quickpay method?" guards, and the admin features (#105, #107) need the same guard. Other plugins solved this the same way — e.g. Sylius/MolliePlugin guards its handlers with MollieGatewayFactory::FACTORY_NAME.

The constant is added upstream

The authority on the name is setono/payum-quickpay — the constant is being added there as QuickpayGatewayFactory::NAME: Setono/payum-quickpay#54. This issue tracks the plugin side only.

Tasks

• Once Expose the gateway factory name as a constant (QuickpayGatewayFactory::NAME) payum-quickpay#54 ships, bump the constraint and replace the literal at the PHP call sites (prod + tests)
• services.xml tag attributes stay literal (XML limitation) — they're covered by the container/integration tests, which will use the constant

[loevgaard]

Unblocked: payum-quickpay v2.0.0-beta.1 ships QuickpayGatewayFactory::NAME (Setono/payum-quickpay#55). The constraint bump is #117 — the four literal swaps can ride along in that PR.