KoalityFormatter::getFormattedResults() - Code Metrics - leankoala-gmbh/KoalityShopwarePlugin - Measure and Improve Code Quality continuously with Scrutinizer

KoalityFormatter::getFormattedResults() C
last analyzed 2021-09-24 06:54 UTC

↳ Parent: KoalityFormatter

Complexity

Conditions	10
Paths	257

Size

Total Lines	56
Code Lines	30

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	0	Features	0

Metric	Value
cc	10
eloc	30
c	3
b	0
f	0
nc	257
nop	0
dl	0
loc	56
rs	6.1208

How to fix Long Method Complexity

<?php

namespace Koality\ShopwarePlugin\Formatter;

/**
 * Class KoalityFormatter
 *
 * This class is used to create an IETF conform health JSON that can be
 * read by koality.io.
 *
 * @see https://tools.ietf.org/html/draft-inadarei-api-health-check-05
 *
 * @package Koality\ShopwarePlugin\Formatter
 *
 * @author Nils Langner <[email protected]>
 * created 2020-12-28
 */
class KoalityFormatter
{
    /**
     * @var Result[]
     */
    private $results = [];

    /**
     * Add a new result.
     *
     * If the status of the result is "fail" the whole check will be marked as failed.
     *
     * @param Result $result
     */
    public function addResult(Result $result)
    {
        $this->results[] = $result;
    }

    /**
     * Return an IETF conform result array with all sub results.
     *
     * @return array
     */
    public function getFormattedResults()
    {
        $formattedResult = [];
        $checks = [];
        $status = Result::STATUS_PASS;

        foreach ($this->results as $result) {
            $check = [
                'status' => $result->getStatus(),
                'output' => $result->getMessage()
            ];

            if (is_numeric($result->getLimit())) {
                $check['limit'] = $result->getLimit();
            }

            if (!is_null($result->getLimitType())) {
                $check['limitType'] = $result->getLimitType();
            }

            if (!is_null($result->getObservedValue())) {
                $check['observedValue'] = $result->getObservedValue();
            }

            if (!is_null($result->getObservedValueUnit())) {
                $check['observedUnit'] = $result->getObservedValueUnit();
            }

            if (!is_null($result->getObservedValuePrecision())) {
                $check['observedValuePrecision'] = $result->getObservedValuePrecision();
            }

            if (!is_null($result->getType())) {
                $check['metricType'] = $result->getType();
            }

            $attributes = $result->getAttributes();
            if (count($attributes) > 0) {
                $check['attributes'] = $attributes;
            }

            $checks[$result->getKey()] = $check;

            if ($result->getStatus() == Result::STATUS_FAIL) {
                $status = Result::STATUS_FAIL;
            }
        }

        $formattedResult['status'] = $status;
        $formattedResult['output'] = $this->getOutput($status);

        $formattedResult['checks'] = $checks;

        $formattedResult['info'] = $this->getInfoBlock();

        return $formattedResult;
    }

    /**
     * Get the output string depending on the given status.
     *
     * @param string $status
     *
     * @return string
     */
    private function getOutput($status)
    {
        if ($status === Result::STATUS_PASS) {
            return 'All Shopware6 health metrics passed.';
        } else {
            return 'Some Shopware6 health metrics failed: ';
        }
    }

    /**
     * Return the info block for the JSON output
     *
     * @return string[]
     */
    private function getInfoBlock()
    {
        return [
            'creator' => 'koality.io Shopware Plugin',
            'version' => '1.0.0',
            'plugin_url' => 'https://www.koality.io/plugins/shopware'
        ];
    }
}


1			<?php
2
3			namespace Koality\ShopwarePlugin\Formatter;
4
5			/**
6			* Class KoalityFormatter
7			*
8			* This class is used to create an IETF conform health JSON that can be
9			* read by koality.io.
10			*
11			* @see https://tools.ietf.org/html/draft-inadarei-api-health-check-05
12			*
13			* @package Koality\ShopwarePlugin\Formatter
14			*
15			* @author Nils Langner <[email protected]>
16			* created 2020-12-28
17			*/
18			class KoalityFormatter
19			{
20			/**
21			* @var Result[]
22			*/
23			private $results = [];
24
25			/**
26			* Add a new result.
27			*
28			* If the status of the result is "fail" the whole check will be marked as failed.
29			*
30			* @param Result $result
31			*/
32			public function addResult(Result $result)
33			{
34			$this->results[] = $result;
35			}
36
37			/**
38			* Return an IETF conform result array with all sub results.
39			*
40			* @return array
41			*/
42			public function getFormattedResults()
43			{
44			$formattedResult = [];
45			$checks = [];
46			$status = Result::STATUS_PASS;
47
48			foreach ($this->results as $result) {
49			$check = [
50			'status' => $result->getStatus(),
51			'output' => $result->getMessage()
52			];
53
54			if (is_numeric($result->getLimit())) {
55			$check['limit'] = $result->getLimit();
56			}
57
58			if (!is_null($result->getLimitType())) {
59			$check['limitType'] = $result->getLimitType();
60			}
61
62			if (!is_null($result->getObservedValue())) {
63			$check['observedValue'] = $result->getObservedValue();
64			}
65
66			if (!is_null($result->getObservedValueUnit())) {
67			$check['observedUnit'] = $result->getObservedValueUnit();
68			}
69
70			if (!is_null($result->getObservedValuePrecision())) {
71			$check['observedValuePrecision'] = $result->getObservedValuePrecision();
72			}
73
74			if (!is_null($result->getType())) {
75			$check['metricType'] = $result->getType();
76			}
77
78			$attributes = $result->getAttributes();
79			if (count($attributes) > 0) {
80			$check['attributes'] = $attributes;
81			}
82
83			$checks[$result->getKey()] = $check;
84
85			if ($result->getStatus() == Result::STATUS_FAIL) {
86			$status = Result::STATUS_FAIL;
87			}
88			}
89
90			$formattedResult['status'] = $status;
91			$formattedResult['output'] = $this->getOutput($status);
92
93			$formattedResult['checks'] = $checks;
94
95			$formattedResult['info'] = $this->getInfoBlock();
96
97			return $formattedResult;
98			}
99
100			/**
101			* Get the output string depending on the given status.
102			*
103			* @param string $status
104			*
105			* @return string
106			*/
107			private function getOutput($status)
108			{
109			if ($status === Result::STATUS_PASS) {
110			return 'All Shopware6 health metrics passed.';
111			} else {
112			return 'Some Shopware6 health metrics failed: ';
113			}
114			}
115
116			/**
117			* Return the info block for the JSON output
118			*
119			* @return string[]
120			*/
121			private function getInfoBlock()
122			{
123			return [
124			'creator' => 'koality.io Shopware Plugin',
125			'version' => '1.0.0',
126			'plugin_url' => 'https://www.koality.io/plugins/shopware'
127			];
128			}
129			}
130

leankoala-gmbh / KoalityShopwarePlugin

KoalityFormatter::getFormattedResults() C last analyzed 2021-09-24 06:54 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like

KoalityFormatter::getFormattedResults() C
last analyzed 2021-09-24 06:54 UTC