AbstractTemplateOptimizer::cleanAndPredictErrorParameters() - Code Metrics - Inspection of "Merge branch 'refac/Optimizer'" - Dispositif/Wikibot - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 1faa52...d67625 )

by Dispositif

created 2020-04-19 15:22 UTC

cleanAndPredictErrorParameters() B

↳ Parent: AbstractTemplateOptimizer

Complexity

Conditions	10
Paths	16

Size

Total Lines	36
Code Lines	22

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	10
eloc	22
nc	16
nop	0
dl	0
loc	36
rs	7.6666
c	1
b	0
f	0

How to fix Complexity

<?php
/**
 * This file is part of dispositif/wikibot application (@github)
 * 2019/2020 © Philippe M. <[email protected]>
 * For the full copyright and MIT license information, please view the license file.
 */

declare(strict_types=1);


namespace App\Domain;


use App\Domain\Models\Wiki\AbstractWikiTemplate;
use App\Domain\Utils\TextUtil;
use Exception;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;

abstract class AbstractTemplateOptimizer implements TemplateOptimizerInterface
{
    use SummaryLogTrait;

    protected $originTemplate;

    protected $wikiPageTitle;

    protected $optiTemplate;

    /**
     * @var LoggerInterface|NullLogger
     */
    protected $log;

    /**
     * todo Refac add doTasks() in constructor if no optional method needed between doTasks() and getOptiTemplate()
     */
    public function __construct(
        AbstractWikiTemplate $template,
        ?string $wikiPageTitle = null,
        ?LoggerInterface $log = null
    ) {
        $this->originTemplate = $template;
        $this->optiTemplate = clone $template;
        $this->wikiPageTitle = ($wikiPageTitle) ?? null;
        $this->log = $log ?? new NullLogger();
    }

    public function getOptiTemplate(): AbstractWikiTemplate
    {
        return $this->optiTemplate;
    }

    /**
     * TODO : return "" instead of null ?
     *
     * @param $name
     *
     * @return string|null
     * @throws Exception
     */
    protected function getParam(string $name): ?string
    {
        return $this->optiTemplate->getParam($name);
    }

    protected function hasParamValue(string $name): bool
    {
        return !empty($this->optiTemplate->getParam($name));
    }

    protected function unsetParam($name)
    {
        $this->optiTemplate->unsetParam($name);
    }

    /**
     * @param $name
     * @param $value
     *
     * @throws Exception
     */
    protected function setParam($name, $value)
    {
        // todo : overwrite setParam() ?
        if (!empty($value) || $this->optiTemplate->getParam($name)) {
            $this->optiTemplate->setParam($name, $value);
        }
    }

    /**
     * Correction des parametres rejetés à l'hydratation données.
     *
     * @throws Exception
     */
    protected function cleanAndPredictErrorParameters()
    {
        if (empty($this->optiTemplate->parametersErrorFromHydrate)) {
            return;
        }
        $allParamsAndAlias = $this->optiTemplate->getParamsAndAlias();

        foreach ($this->optiTemplate->parametersErrorFromHydrate as $name => $value) {
            if (!is_string($name)) {
                // example : 1 => "ouvrage collectif" from |ouvrage collectif|
                continue;
            }

            // delete error parameter if no value
            if (empty($value)) {
                unset($this->optiTemplate->parametersErrorFromHydrate[$name]);

                continue;
            }

            $maxDistance = 1;
            if (mb_strlen($name) >= 4) {
                $maxDistance = 2;
            }
            if (mb_strlen($name) >= 8) {
                $maxDistance = 3;
            }

            $predName = TextUtil::predictCorrectParam($name, $allParamsAndAlias, $maxDistance);
            if ($predName && mb_strlen($name) >= 5) {
                if (empty($this->getParam($predName))) {
                    $predName = $this->optiTemplate->getAliasParam($predName);
                    $this->setParam($predName, $value);
                    $this->addSummaryLog(sprintf('%s⇒%s ?', $name, $predName));
                    $this->notCosmetic = true;

                    unset($this->optiTemplate->parametersErrorFromHydrate[$name]);
                }
            }
        }
    }
}


1			<?php
2			/**
3			* This file is part of dispositif/wikibot application (@github)
4			* 2019/2020 © Philippe M. <[email protected]>
5			* For the full copyright and MIT license information, please view the license file.
6			*/
7
8			declare(strict_types=1);
9
10
11			namespace App\Domain;
12
13
14			use App\Domain\Models\Wiki\AbstractWikiTemplate;
15			use App\Domain\Utils\TextUtil;
16			use Exception;
17			use Psr\Log\LoggerInterface;
18			use Psr\Log\NullLogger;
19
20			abstract class AbstractTemplateOptimizer implements TemplateOptimizerInterface
21			{
22			use SummaryLogTrait;
23
24			protected $originTemplate;
25
26			protected $wikiPageTitle;
27
28			protected $optiTemplate;
29
30			/**
31			* @var LoggerInterface\|NullLogger
32			*/
33			protected $log;
34
35			/**
36			* todo Refac add doTasks() in constructor if no optional method needed between doTasks() and getOptiTemplate()
37			*/
38			public function __construct(
39			AbstractWikiTemplate $template,
40			?string $wikiPageTitle = null,
41			?LoggerInterface $log = null
42			) {
43			$this->originTemplate = $template;
44			$this->optiTemplate = clone $template;
45			$this->wikiPageTitle = ($wikiPageTitle) ?? null;
46			$this->log = $log ?? new NullLogger();
47			}
48
49			public function getOptiTemplate(): AbstractWikiTemplate
50			{
51			return $this->optiTemplate;
52			}
53
54			/**
55			* TODO : return "" instead of null ?
56			*
57			* @param $name
58			*
59			* @return string\|null
60			* @throws Exception
61			*/
62			protected function getParam(string $name): ?string
63			{
64			return $this->optiTemplate->getParam($name);
65			}
66
67			protected function hasParamValue(string $name): bool
68			{
69			return !empty($this->optiTemplate->getParam($name));
70			}
71
72			protected function unsetParam($name)
73			{
74			$this->optiTemplate->unsetParam($name);
75			}
76
77			/**
78			* @param $name
79			* @param $value
80			*
81			* @throws Exception
82			*/
83			protected function setParam($name, $value)
84			{
85			// todo : overwrite setParam() ?
86			if (!empty($value) \|\| $this->optiTemplate->getParam($name)) {
87			$this->optiTemplate->setParam($name, $value);
88			}
89			}
90
91			/**
92			* Correction des parametres rejetés à l'hydratation données.
93			*
94			* @throws Exception
95			*/
96			protected function cleanAndPredictErrorParameters()
97			{
98			if (empty($this->optiTemplate->parametersErrorFromHydrate)) {
99			return;
100			}
101			$allParamsAndAlias = $this->optiTemplate->getParamsAndAlias();
102
103			foreach ($this->optiTemplate->parametersErrorFromHydrate as $name => $value) {
104			if (!is_string($name)) {
105			// example : 1 => "ouvrage collectif" from \|ouvrage collectif\|
106			continue;
107			}
108
109			// delete error parameter if no value
110			if (empty($value)) {
111			unset($this->optiTemplate->parametersErrorFromHydrate[$name]);
112
113			continue;
114			}
115
116			$maxDistance = 1;
117			if (mb_strlen($name) >= 4) {
118			$maxDistance = 2;
119			}
120			if (mb_strlen($name) >= 8) {
121			$maxDistance = 3;
122			}
123
124			$predName = TextUtil::predictCorrectParam($name, $allParamsAndAlias, $maxDistance);
125			if ($predName && mb_strlen($name) >= 5) {
126			if (empty($this->getParam($predName))) {
127			$predName = $this->optiTemplate->getAliasParam($predName);
128			$this->setParam($predName, $value);
129			$this->addSummaryLog(sprintf('%s⇒%s ?', $name, $predName));
130			$this->notCosmetic = true;
			0 ignored issues – show Bug Best Practice introduced 2020-04-19 15:28 UTC by Report Bug Copy Issue Report The property `notCosmetic` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
131			unset($this->optiTemplate->parametersErrorFromHydrate[$name]);
132			}
133			}
134			}
135			}
136			}
137

Dispositif / Wikibot

Push — master ( 1faa52...d67625 )

cleanAndPredictErrorParameters() B

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like