File: IniConfigDefinitionSource.php

package info (click to toggle)
matomo 5.8.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 95,068 kB
  • sloc: php: 289,425; xml: 127,249; javascript: 112,130; python: 202; sh: 178; makefile: 20; sql: 10
file content (111 lines) | stat: -rw-r--r-- 2,619 bytes parent folder | download
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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
<?php

/**
 * Matomo - free/libre analytics platform
 *
 * @link    https://matomo.org
 * @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
 */

namespace Piwik\Container;

use DI\Definition\Exception\InvalidDefinition;
use DI\Definition\Source\DefinitionSource;
use DI\Definition\ValueDefinition;
use Piwik\Application\Kernel\GlobalSettingsProvider;

/**
 * Expose the INI config into PHP-DI.
 *
 * The INI config can be used by prefixing `ini.` before the setting we want to get:
 *
 *     $maintenanceMode = $container->get('ini.General.maintenance_mode');
 */
class IniConfigDefinitionSource implements DefinitionSource
{
    /**
     * @var GlobalSettingsProvider
     */
    private $config;

    /**
     * @var string
     */
    private $prefix;

    /**
     * @param string $prefix Prefix for the container entries.
     */
    public function __construct(GlobalSettingsProvider $config, $prefix = 'ini.')
    {
        $this->config = $config;
        $this->prefix = $prefix;
    }

    /**
     * {@inheritdoc}
     */
    public function getDefinition(?string $name): ?\DI\Definition\Definition
    {
        if (strpos($name, $this->prefix) !== 0) {
            return null;
        }

        list($sectionName, $configKey) = $this->parseEntryName($name);

        $section = $this->getSection($sectionName);

        if ($configKey === null) {
            $value = new ValueDefinition($section);
            $value->setName($name);
            return $value;
        }

        if (! array_key_exists($configKey, $section)) {
            return null;
        }

        $value = new ValueDefinition($section[$configKey]);
        $value->setName($name);
        return $value;
    }

    public function getDefinitions(): array
    {
        $result = [];
        foreach ($this->config as $section) {
            $value = new ValueDefinition($this->getSection($section));
            $value->setName($section);

            $result[$section] = $value;
        }
        return $result;
    }

    private function parseEntryName($name)
    {
        $parts = explode('.', $name, 3);

        array_shift($parts);

        if (! isset($parts[1])) {
            $parts[1] = null;
        }

        return $parts;
    }

    private function getSection($sectionName)
    {
        $section = $this->config->getSection($sectionName);

        if (!is_array($section)) {
            throw new InvalidDefinition(sprintf(
                'IniFileChain did not return an array for the config section %s',
                $section
            ));
        }

        return $section;
    }
}