Completed
Push — master ( 4a905b...82874d )
by Michael
02:55
created

ConfigFileTrait::processConfigFile()   B

Complexity

Conditions 6
Paths 5

Size

Total Lines 19
Code Lines 12

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 42

Importance

Changes 1
Bugs 0 Features 1
Metric Value
c 1
b 0
f 1
dl 0
loc 19
ccs 0
cts 18
cp 0
rs 8.8571
cc 6
eloc 12
nc 5
nop 2
crap 42
1
<?php
2
declare(strict_types = 1);
3
/**
4
 * Contains trait ConfigFileTrait.
5
 *
6
 * PHP version 7.0+
7
 *
8
 * LICENSE:
9
 * This file is part of Yet Another Php Eve Api Library also know as Yapeal
10
 * which can be used to access the Eve Online API data and place it into a
11
 * database.
12
 * Copyright (C) 2016 Michael Cummings
13
 *
14
 * This program is free software: you can redistribute it and/or modify it
15
 * under the terms of the GNU Lesser General Public License as published by the
16
 * Free Software Foundation, either version 3 of the License, or (at your
17
 * option) any later version.
18
 *
19
 * This program is distributed in the hope that it will be useful, but WITHOUT
20
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
22
 * for more details.
23
 *
24
 * You should have received a copy of the GNU Lesser General Public License
25
 * along with this program. If not, see
26
 * <http://spdx.org/licenses/LGPL-3.0.html>.
27
 *
28
 * You should be able to find a copy of this license in the COPYING-LESSER.md
29
 * file. A copy of the GNU GPL should also be available in the COPYING.md file.
30
 *
31
 * @copyright 2016 Michael Cummings
32
 * @license   LGPL-3.0+
33
 * @author    Michael Cummings <[email protected]>
34
 */
35
namespace Yapeal\Cli;
36
37
use Symfony\Component\Console\Input\InputOption;
38
use Yapeal\Configuration\Wiring;
39
use Yapeal\Container\ContainerInterface;
40
41
/** @noinspection PhpUnnecessaryFullyQualifiedNameInspection */
42
/**
43
 * Trait ConfigFileTrait.
44
 *
45
 * @method \FilePathNormalizer\FilePathNormalizerInterface getFpn()
46
 * @method $this addOption(string $name, $shortcut = null, int $mode = null, string $description = '', $default = null)
47
 */
48
trait ConfigFileTrait
49
{
50
    /**
51
     *
52
     */
53
    protected function addConfigFileOption()
54
    {
55
        $mess = 'Configuration file to get settings from.'
56
            . ' <comment>NOTE: A (missing, unreadable, empty, etc) file will be silently ignored.</comment>';
57
        $this->addOption('configFile', 'c', InputOption::VALUE_REQUIRED, $mess);
58
    }
59
    /**
60
     * Process the configuration file gotten on the CLI.
61
     *
62
     * NOTE: All settings from this configuration file overwrite any existing values.
63
     *
64
     * @param string             $fileName
65
     * @param ContainerInterface $dic
66
     *
67
     * @throws \DomainException
68
     * @throws \Yapeal\Exception\YapealException
69
     */
70
    protected function processConfigFile(string $fileName, ContainerInterface $dic)
71
    {
72
        $fileName = trim($fileName);
73
        if ('' === $fileName) {
74
            return;
75
        }
76
        $fpn = $this->getFpn();
77
        $fileName = $fpn->normalizeFile($fileName, $fpn::ABSOLUTE_ALLOWED | $fpn::VFS_ALLOWED | $fpn::WRAPPER_ALLOWED);
78
        // Silently ignore the file if can't find it.
79
        if (!is_file($fileName) || !is_readable($fileName)) {
80
            return;
81
        }
82
        $settings = (new Wiring($dic))->parserConfigFile($fileName);
83
        if (0 !== count($settings)) {
84
            foreach ($settings as $key => $setting) {
85
                $dic[$key] = $setting;
86
            }
87
        }
88
    }
89
}
90