Core/GatewayFactory.php at 2.x · Payum/Core · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
<?php

namespace Payum\Core;

use Payum\Core\Bridge\Spl\ArrayObject;
use Payum\Core\DI\ContainerConfiguration;
use Payum\Core\Legacy\LegacyFactoryScope;
use function trigger_deprecation;

class GatewayFactory implements GatewayFactoryInterface /* , ContainerConfiguration */ // This class will implement ContainerConfiguration from version 3.0, and will remove the GatewayFactoryInterface
{
    /**
     * @var GatewayFactoryInterface
     */
    protected $coreGatewayFactory;

    /**
     * @var array
     */
    protected $defaultConfig;

    public function __construct(array $defaultConfig = [], ?GatewayFactoryInterface $coreGatewayFactory = null)
    {
        $this->coreGatewayFactory = $coreGatewayFactory ?: new CoreGatewayFactory();
        $this->defaultConfig = $defaultConfig;
    }

    public function create(array $config = [])
    {
        $this->reportLegacyFactory();

        return LegacyFactoryScope::run(fn () => $this->coreGatewayFactory->create($this->createConfig($config)));
    }

    public function createConfig(array $config = [])
    {
        $this->reportLegacyFactory();

        return LegacyFactoryScope::run(fn (): array => $this->buildConfig($config));
    }

    /**
     * @return mixed|void
     */
    protected function populateConfig(ArrayObject $config)
    {
    }

    /**
     * @param array<string, mixed> $config
     *
     * @return array<string, mixed>
     */
    private function buildConfig(array $config): array
    {
        $config = ArrayObject::ensureArrayObject($config);
        $config->defaults($this->defaultConfig);
        $config->defaults($this->coreGatewayFactory->createConfig((array) $config));

        $this->populateConfig($config);

        return (array) $config;
    }

    private function reportLegacyFactory(): void
    {
        if (! LegacyFactoryScope::isActive()) {
            trigger_deprecation('payum/core', '2.0.0', '%s is a 1.x gateway factory, which is deprecated and will not be supported in 3.0. It needs to implement %s.', static::class, ContainerConfiguration::class);
        }
    }
}