EnvironmentCheckSuiteResult::Status() - Code Metrics - silverstripe/silverstripe-environmentcheck - Measure and Improve Code Quality continuously with Scrutinizer

EnvironmentCheckSuiteResult::Status() A
last analyzed 2019-11-07 02:25 UTC

↳ Parent: EnvironmentCheckSuiteResult

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	1
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	3
rs	10

<?php

namespace SilverStripe\EnvironmentCheck;

use InvalidArgumentException;
use SilverStripe\ORM\ArrayList;
use SilverStripe\View\ArrayData;
use SilverStripe\View\ViewableData;

/**
 * A single set of results from running an EnvironmentCheckSuite
 *
 * @package environmentcheck
 */
class EnvironmentCheckSuiteResult extends ViewableData
{
    /**
     * @var ArrayList
     */
    protected $details;

    /**
     * @var int
     */
    protected $worst = 0;

    public function __construct()
    {
        parent::__construct();
        $this->details = new ArrayList();
    }

    /**
     * @param int $status
     * @param string $message
     * @param string $checkIdentifier
     */
    public function addResult($status, $message, $checkIdentifier)
    {
        $this->details->push(new ArrayData([
            'Check' => $checkIdentifier,
            'Status' => $this->statusText($status),
            'StatusCode' => $status,
            'Message' => $message,
        ]));

        $this->worst = max($this->worst, $status);
    }

    /**
     * Returns true if there are no errors.
     *
     * @return bool
     */
    public function ShouldPass()
    {
        return $this->worst <= EnvironmentCheck::WARNING;
    }

    /**
     * Returns overall (i.e. worst) status as a string.
     *
     * @return string
     */
    public function Status()
    {
        return $this->statusText($this->worst);
    }

    /**
     * Returns detailed status information about each check.
     *
     * @return ArrayList
     */
    public function Details()
    {
        return $this->details;
    }

    /**
     * Convert the final result status and details to JSON.
     *
     * @return string
     */
    public function toJSON()
    {
        $result = [
            'Status' => $this->Status(),
            'ShouldPass' => $this->ShouldPass(),
            'Checks' => []
        ];
        foreach ($this->details as $detail) {
            $result['Checks'][] = $detail->toMap();
        }
        return json_encode($result);
    }

    /**
     * Return a text version of a status code.
     *
     * @param  int $status
     * @return string
     * @throws InvalidArgumentException
     */
    protected function statusText($status)
    {
        switch ($status) {
            case EnvironmentCheck::ERROR:
                return 'ERROR';
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
            case EnvironmentCheck::WARNING:
                return 'WARNING';
                break;
            case EnvironmentCheck::OK:
                return 'OK';
                break;
            case 0:
                return 'NO CHECKS';
                break;
            default:
                throw new InvalidArgumentException("Bad environment check status '$status'");
                break;
        }
    }
}


1			<?php
2
3			namespace SilverStripe\EnvironmentCheck;
4
5			use InvalidArgumentException;
6			use SilverStripe\ORM\ArrayList;
7			use SilverStripe\View\ArrayData;
8			use SilverStripe\View\ViewableData;
9
10			/**
11			* A single set of results from running an EnvironmentCheckSuite
12			*
13			* @package environmentcheck
14			*/
15			class EnvironmentCheckSuiteResult extends ViewableData
16			{
17			/**
18			* @var ArrayList
19			*/
20			protected $details;
21
22			/**
23			* @var int
24			*/
25			protected $worst = 0;
26
27			public function __construct()
28			{
29			parent::__construct();
30			$this->details = new ArrayList();
31			}
32
33			/**
34			* @param int $status
35			* @param string $message
36			* @param string $checkIdentifier
37			*/
38			public function addResult($status, $message, $checkIdentifier)
39			{
40			$this->details->push(new ArrayData([
41			'Check' => $checkIdentifier,
42			'Status' => $this->statusText($status),
43			'StatusCode' => $status,
44			'Message' => $message,
45			]));
46
47			$this->worst = max($this->worst, $status);
48			}
49
50			/**
51			* Returns true if there are no errors.
52			*
53			* @return bool
54			*/
55			public function ShouldPass()
56			{
57			return $this->worst <= EnvironmentCheck::WARNING;
58			}
59
60			/**
61			* Returns overall (i.e. worst) status as a string.
62			*
63			* @return string
64			*/
65			public function Status()
66			{
67			return $this->statusText($this->worst);
68			}
69
70			/**
71			* Returns detailed status information about each check.
72			*
73			* @return ArrayList
74			*/
75			public function Details()
76			{
77			return $this->details;
78			}
79
80			/**
81			* Convert the final result status and details to JSON.
82			*
83			* @return string
84			*/
85			public function toJSON()
86			{
87			$result = [
88			'Status' => $this->Status(),
89			'ShouldPass' => $this->ShouldPass(),
90			'Checks' => []
91			];
92			foreach ($this->details as $detail) {
93			$result['Checks'][] = $detail->toMap();
94			}
95			return json_encode($result);
96			}
97
98			/**
99			* Return a text version of a status code.
100			*
101			* @param int $status
102			* @return string
103			* @throws InvalidArgumentException
104			*/
105			protected function statusText($status)
106			{
107			switch ($status) {
108			case EnvironmentCheck::ERROR:
109			return 'ERROR';
110			break;
			0 ignored issues – show Unused Code introduced 2019-02-15 00:14 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
111			case EnvironmentCheck::WARNING:
112			return 'WARNING';
113			break;
114			case EnvironmentCheck::OK:
115			return 'OK';
116			break;
117			case 0:
118			return 'NO CHECKS';
119			break;
120			default:
121			throw new InvalidArgumentException("Bad environment check status '$status'");
122			break;
123			}
124			}
125			}
126

silverstripe / silverstripe-environmentcheck

EnvironmentCheckSuiteResult::Status() A last analyzed 2019-11-07 02:25 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

EnvironmentCheckSuiteResult::Status() A
last analyzed 2019-11-07 02:25 UTC