ReporterAbstract::onBeforeRun() - Code Metrics - Inspection of "~" - turnaev/monitor-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( aca6e3...e7aa24 )

by Vladimir

created 2018-10-03 11:37 UTC

ReporterAbstract::onBeforeRun() A

↳ Parent: ReporterAbstract

Complexity

Conditions	1
Paths	1

Size

Total Lines	2
Code Lines	0

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
eloc	0
dl	0
loc	2
c	0
b	0
f	0
ccs	0
cts	1
cp	0
rs	10
cc	1
nc	1
nop	2
crap	2

<?php

/**
 * This file is part of the `tvi/monitor-bundle` project.
 *
 * (c) https://github.com/turnaev/monitor-bundle/graphs/contributors
 *
 * For the full copyright and license information, please view the LICENSE.md
 * file that was distributed with this source code.
 */


namespace Tvi\MonitorBundle\Reporter;

use ZendDiagnostics\Result\FailureInterface;
use ZendDiagnostics\Result\ResultInterface;
use ZendDiagnostics\Result\SkipInterface;
use ZendDiagnostics\Result\SuccessInterface;
use ZendDiagnostics\Result\WarningInterface;
use ZendDiagnostics\Runner\Reporter\ReporterInterface;
use ZendDiagnostics\Check\CheckInterface;
use ZendDiagnostics\Result\Collection as ResultsCollection;

/**

 * @author Vladimir Turnaev <[email protected]>
 */

abstract class ReporterAbstract implements ReporterInterface
{
    public const STATUS_CODE_SUCCESS = 0;
    public const STATUS_CODE_WARNING = 100;
    public const STATUS_CODE_SKIP = 200;
    public const STATUS_CODE_UNKNOWN = 300;
    public const STATUS_CODE_FAILURE = 1000;

    public const STATUS_NAME_SUCCESS = 'SUCCESS';
    public const STATUS_NAME_WARNING = 'WARNING';
    public const STATUS_NAME_SKIP = 'SKIP';
    public const STATUS_NAME_UNKNOWN = 'UNKNOWN';
    public const STATUS_NAME_FAILURE = 'FAILURE';

    public static $STATUS_MAP = [
        self::STATUS_CODE_SUCCESS => self::STATUS_NAME_SUCCESS,
        self::STATUS_CODE_WARNING => self::STATUS_NAME_WARNING,
        self::STATUS_CODE_SKIP => self::STATUS_NAME_SKIP,
        self::STATUS_CODE_UNKNOWN => self::STATUS_NAME_UNKNOWN,
        self::STATUS_CODE_FAILURE => self::STATUS_NAME_FAILURE,
    ];

    /**
     * Total number of Checks.
     *
     * @var int
     */
    protected $totalCount = 0;

    /**
     * Has the Runner operation been aborted (stopped) ?
     *
     * @var bool
     */
    protected $stopped = false;

    /**

     * @var ResultsCollection
     */
    protected $results;

    public static function getStatusNameByCode(int $statusCode): string

    {
        return isset(self::$STATUS_MAP[$statusCode]) ? self::$STATUS_MAP[$statusCode] : self::STATUS_NAME_UNKNOWN;
    }

    /**
     * This method is called right after Reporter starts running, via Runner::run().
     *
     * @param ArrayObject $checks       A collection of Checks that will be performed

     * @param array       $runnerConfig Complete Runner configuration, obtained via Runner::getConfig()
     */

    public function onStart(\ArrayObject $checks, $runnerConfig)
    {
        $this->totalCount = \count($checks);
    }

    /**
     * This method is called before each individual Check is performed. If this
     * method returns false, the Check will not be performed (will be skipped).
     *
     * @param CheckInterface $check      check instance that is about to be performed
     * @param string|null    $checkAlias The alias for the check that is about to be performed
     *
     * @return bool|void Return false to prevent check from happening
     */
    public function onBeforeRun(CheckInterface $check, $checkAlias = null)
    {
    }

    /**
     * This method is called every time a Check has been performed. If this method
     * returns false, the Runner will not perform any additional checks and stop
     * its run.
     *
     * @param CheckInterface  $check      A Check instance that has just finished running
     * @param ResultInterface $result     Result for that particular check instance
     * @param string|null     $checkAlias The alias for the check that has just finished
     *
     * @return bool|void Return false to prevent from running additional Checks
     */
    public function onAfterRun(CheckInterface $check, ResultInterface $result, $checkAlias = null)
    {
    }

    /**
     * This method is called when Runner has been aborted and could not finish the
     * whole run().
     *
     * @param ResultsCollection $results collection of Results for performed Checks
     */

    public function onStop(ResultsCollection $results)
    {
        $this->stopped = true;
    }

    /**
     * This method is called when Runner has finished its run.
     *
     * @param ResultsCollection $results collection of Results for performed Checks
     */

    public function onFinish(ResultsCollection $results)
    {
        $this->results = $results;
    }

    /**

     * @return int
     */
    public function getSuccessCount(): ?int
    {
        return $this->results ? $this->results->getSuccessCount() : null;
    }

    /**

     * @return int
     */
    public function getWarningCount(): ?int
    {
        return $this->results ? $this->results->getWarningCount() : null;
    }

    /**

     * @return int
     */
    public function getFailureCount(): ?int
    {
        return $this->results ? $this->results->getFailureCount() : null;
    }

    /**

     * @return int
     */
    public function getSkipCount(): ?int
    {
        return $this->results ? $this->results->getSkipCount() : null;
    }

    /**

     * @return int
     */
    public function getUnknownCount(): ?int
    {
        return $this->results ? $this->results->getUnknownCount() : null;
    }

    public function getTotalCount(): int

    {
        return $this->totalCount;
    }

    public function isStopped(): bool

    {
        return $this->stopped;
    }

    public function getResults(): ResultsCollection

    {
        return $this->results;
    }

    /**

     * @return array [name, code]
     */
    protected function getStatusByResul(ResultInterface $result)
    {
        switch (true) {
            case $result instanceof SuccessInterface:

                $name = self::STATUS_NAME_SUCCESS;
                $code = self::STATUS_CODE_SUCCESS;
                break;

            case $result instanceof WarningInterface:

                $name = self::STATUS_NAME_WARNING;
                $code = self::STATUS_CODE_WARNING;
                break;

            case $result instanceof SkipInterface:

                $name = self::STATUS_NAME_SKIP;
                $code = self::STATUS_CODE_SKIP;
                break;

            case $result instanceof FailureInterface:

                $name = self::STATUS_NAME_FAILURE;
                $code = self::STATUS_CODE_FAILURE;
                break;

            default:

                $name = self::STATUS_NAME_UNKNOWN;
                $code = self::STATUS_CODE_UNKNOWN;
                break;
        }

        return [$name, $code];
    }
}


1		<?php
2
3		/**
4		* This file is part of the `tvi/monitor-bundle` project.
5		*
6		* (c) https://github.com/turnaev/monitor-bundle/graphs/contributors
7		*
8		* For the full copyright and license information, please view the LICENSE.md
9		* file that was distributed with this source code.
10		*/
		0 ignored issues – show Coding Style introduced 2018-09-26 08:01 UTC by Report Bug Copy Issue Report PHP version not specified Loading history... Coding Style introduced 2018-09-26 08:01 UTC by Report Bug Copy Issue Report Missing @category tag in file comment Loading history... Coding Style introduced 2018-09-26 08:01 UTC by Report Bug Copy Issue Report Missing @package tag in file comment Loading history... Coding Style introduced 2018-09-26 08:01 UTC by Report Bug Copy Issue Report Missing @author tag in file comment Loading history... Coding Style introduced 2018-09-26 08:01 UTC by Report Bug Copy Issue Report Missing @license tag in file comment Loading history... Coding Style introduced 2018-09-26 08:01 UTC by Report Bug Copy Issue Report Missing @link tag in file comment Loading history...
11
12		namespace Tvi\MonitorBundle\Reporter;
13
14		use ZendDiagnostics\Result\FailureInterface;
15		use ZendDiagnostics\Result\ResultInterface;
16		use ZendDiagnostics\Result\SkipInterface;
17		use ZendDiagnostics\Result\SuccessInterface;
18		use ZendDiagnostics\Result\WarningInterface;
19		use ZendDiagnostics\Runner\Reporter\ReporterInterface;
20		use ZendDiagnostics\Check\CheckInterface;
21		use ZendDiagnostics\Result\Collection as ResultsCollection;
22
23		/**
		0 ignored issues – show Coding Style introduced 2018-10-01 07:39 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
24		* @author Vladimir Turnaev <[email protected]>
25		*/
		0 ignored issues – show Coding Style introduced 2018-09-24 09:59 UTC by Report Bug Copy Issue Report Missing @category tag in class comment Loading history... Coding Style introduced 2018-09-24 09:59 UTC by Report Bug Copy Issue Report Missing @package tag in class comment Loading history... Coding Style introduced 2018-09-24 09:59 UTC by Report Bug Copy Issue Report Missing @license tag in class comment Loading history... Coding Style introduced 2018-09-24 09:59 UTC by Report Bug Copy Issue Report Missing @link tag in class comment Loading history...
26		abstract class ReporterAbstract implements ReporterInterface
27		{
28		public const STATUS_CODE_SUCCESS = 0;
29		public const STATUS_CODE_WARNING = 100;
30		public const STATUS_CODE_SKIP = 200;
31		public const STATUS_CODE_UNKNOWN = 300;
32		public const STATUS_CODE_FAILURE = 1000;
33
34		public const STATUS_NAME_SUCCESS = 'SUCCESS';
35		public const STATUS_NAME_WARNING = 'WARNING';
36		public const STATUS_NAME_SKIP = 'SKIP';
37		public const STATUS_NAME_UNKNOWN = 'UNKNOWN';
38		public const STATUS_NAME_FAILURE = 'FAILURE';
39
40		public static $STATUS_MAP = [
41		self::STATUS_CODE_SUCCESS => self::STATUS_NAME_SUCCESS,
42		self::STATUS_CODE_WARNING => self::STATUS_NAME_WARNING,
43		self::STATUS_CODE_SKIP => self::STATUS_NAME_SKIP,
44		self::STATUS_CODE_UNKNOWN => self::STATUS_NAME_UNKNOWN,
45		self::STATUS_CODE_FAILURE => self::STATUS_NAME_FAILURE,
46		];
47
48		/**
49		* Total number of Checks.
50		*
51		* @var int
52		*/
53		protected $totalCount = 0;
54
55		/**
56		* Has the Runner operation been aborted (stopped) ?
57		*
58		* @var bool
59		*/
60		protected $stopped = false;
61
62		/**
		0 ignored issues – show Coding Style introduced 2018-09-24 09:59 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
63		* @var ResultsCollection
64		*/
65		protected $results;
66
67		public static function getStatusNameByCode(int $statusCode): string
		0 ignored issues – show Coding Style introduced 2018-10-01 16:50 UTC by Report Bug Copy Issue Report Missing doc comment for function getStatusNameByCode() Loading history...
68		{
69		return isset(self::$STATUS_MAP[$statusCode]) ? self::$STATUS_MAP[$statusCode] : self::STATUS_NAME_UNKNOWN;
70		}
71
72		/**
73		* This method is called right after Reporter starts running, via Runner::run().
74		*
75		* @param ArrayObject $checks A collection of Checks that will be performed
		0 ignored issues – show Bug introduced 2018-10-03 08:48 UTC by Report Bug Copy Issue Report The type `Tvi\MonitorBundle\Reporter\ArrayObject` was not found. Did you mean `ArrayObject`? If so, make sure to prefix the type with `\`. Loading history...
76		* @param array $runnerConfig Complete Runner configuration, obtained via Runner::getConfig()
77		*/
		0 ignored issues – show Coding Style introduced 2018-10-02 10:56 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
78		public function onStart(\ArrayObject $checks, $runnerConfig)
79		{
80		$this->totalCount = \count($checks);
81		}
82
83		/**
84		* This method is called before each individual Check is performed. If this
85		* method returns false, the Check will not be performed (will be skipped).
86		*
87		* @param CheckInterface $check check instance that is about to be performed
88		* @param string\|null $checkAlias The alias for the check that is about to be performed
89		*
90		* @return bool\|void Return false to prevent check from happening
91		*/
92		public function onBeforeRun(CheckInterface $check, $checkAlias = null)
93		{
94		}
95
96		/**
97		* This method is called every time a Check has been performed. If this method
98		* returns false, the Runner will not perform any additional checks and stop
99		* its run.
100		*
101		* @param CheckInterface $check A Check instance that has just finished running
102		* @param ResultInterface $result Result for that particular check instance
103		* @param string\|null $checkAlias The alias for the check that has just finished
104		*
105		* @return bool\|void Return false to prevent from running additional Checks
106		*/
107		public function onAfterRun(CheckInterface $check, ResultInterface $result, $checkAlias = null)
108		{
109		}
110
111		/**
112		* This method is called when Runner has been aborted and could not finish the
113		* whole run().
114		*
115		* @param ResultsCollection $results collection of Results for performed Checks
116		*/
		0 ignored issues – show Coding Style introduced 2018-10-02 10:56 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
117		public function onStop(ResultsCollection $results)
118		{
119		$this->stopped = true;
120		}
121
122		/**
123		* This method is called when Runner has finished its run.
124		*
125		* @param ResultsCollection $results collection of Results for performed Checks
126		*/
		0 ignored issues – show Coding Style introduced 2018-10-02 10:56 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
127	7	public function onFinish(ResultsCollection $results)
128		{
129	7	$this->results = $results;
130	7	}
131
132		/**
		0 ignored issues – show Coding Style introduced 2018-10-03 08:48 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
133		* @return int
134		*/
135		public function getSuccessCount(): ?int
136		{
137		return $this->results ? $this->results->getSuccessCount() : null;
138		}
139
140		/**
		0 ignored issues – show Coding Style introduced 2018-09-24 09:59 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
141		* @return int
142		*/
143		public function getWarningCount(): ?int
144		{
145		return $this->results ? $this->results->getWarningCount() : null;
146		}
147
148		/**
		0 ignored issues – show Coding Style introduced 2018-09-24 09:59 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
149		* @return int
150		*/
151		public function getFailureCount(): ?int
152		{
153		return $this->results ? $this->results->getFailureCount() : null;
154		}
155
156		/**
		0 ignored issues – show Coding Style introduced 2018-09-24 09:59 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
157		* @return int
158		*/
159		public function getSkipCount(): ?int
160		{
161		return $this->results ? $this->results->getSkipCount() : null;
162		}
163
164		/**
		0 ignored issues – show Coding Style introduced 2018-09-24 09:59 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
165		* @return int
166		*/
167		public function getUnknownCount(): ?int
168		{
169		return $this->results ? $this->results->getUnknownCount() : null;
170		}
171
172		public function getTotalCount(): int
		0 ignored issues – show Coding Style introduced 2018-10-03 08:48 UTC by Report Bug Copy Issue Report Missing doc comment for function getTotalCount() Loading history...
173		{
174		return $this->totalCount;
175		}
176
177		public function isStopped(): bool
		0 ignored issues – show Coding Style introduced 2018-10-03 08:48 UTC by Report Bug Copy Issue Report Missing doc comment for function isStopped() Loading history...
178		{
179		return $this->stopped;
180		}
181
182		public function getResults(): ResultsCollection
		0 ignored issues – show Coding Style introduced 2018-10-03 08:48 UTC by Report Bug Copy Issue Report Missing doc comment for function getResults() Loading history...
183		{
184		return $this->results;
185		}
186
187		/**
		0 ignored issues – show Coding Style introduced 2018-10-03 08:48 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history... Coding Style introduced 2018-10-03 08:48 UTC by Report Bug Copy Issue Report Parameter `$result` should have a doc-comment as per coding-style. Loading history...
188		* @return array [name, code]
189		*/
190		protected function getStatusByResul(ResultInterface $result)
191		{
192		switch (true) {
193		case $result instanceof SuccessInterface:
		0 ignored issues – show Coding Style introduced 2018-09-24 09:59 UTC by Report Bug Copy Issue Report Line indented incorrectly; expected 8 spaces, found 12 Loading history...
194		$name = self::STATUS_NAME_SUCCESS;
195		$code = self::STATUS_CODE_SUCCESS;
196		break;
197
198		case $result instanceof WarningInterface:
		0 ignored issues – show Coding Style introduced 2018-09-24 09:59 UTC by Report Bug Copy Issue Report Line indented incorrectly; expected 8 spaces, found 12 Loading history...
199		$name = self::STATUS_NAME_WARNING;
200		$code = self::STATUS_CODE_WARNING;
201		break;
202
203		case $result instanceof SkipInterface:
		0 ignored issues – show Coding Style introduced 2018-09-24 09:59 UTC by Report Bug Copy Issue Report Line indented incorrectly; expected 8 spaces, found 12 Loading history...
204		$name = self::STATUS_NAME_SKIP;
205		$code = self::STATUS_CODE_SKIP;
206		break;
207
208		case $result instanceof FailureInterface:
		0 ignored issues – show Coding Style introduced 2018-09-24 09:59 UTC by Report Bug Copy Issue Report Line indented incorrectly; expected 8 spaces, found 12 Loading history...
209		$name = self::STATUS_NAME_FAILURE;
210		$code = self::STATUS_CODE_FAILURE;
211		break;
212
213		default:
		0 ignored issues – show Coding Style introduced 2018-09-24 09:59 UTC by Report Bug Copy Issue Report Line indented incorrectly; expected 8 spaces, found 12 Loading history...
214		$name = self::STATUS_NAME_UNKNOWN;
215		$code = self::STATUS_CODE_UNKNOWN;
216		break;
217		}
218
219		return [$name, $code];
220		}
221		}
222

turnaev / monitor-bundle

Push — master ( aca6e3...e7aa24 )

ReporterAbstract::onBeforeRun() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like