Tvi\MonitorBundle\Reporter\ReporterAbstract

Complexity

Total Complexity

26

Size/Duplication

Total Lines	205
Duplicated Lines	0 %

Test Coverage

Coverage

80.7%

Importance

Changes

0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	getSkipCount()	0	3	2
A	getSuccessCount()	0	3	2
A	onStart()	0	5	1
A	getWarningCount()	0	3	2
A	onAfterRun()	0	2	1
A	isStopped()	0	3	1
A	getTotalCount()	0	3	1
A	getResults()	0	3	1
A	getFailureCount()	0	3	2
A	getUnknownCount()	0	3	2
A	onBeforeRun()	0	2	1
A	onFinish()	0	7	2
A	onStopped()	0	2	1
A	getStatusByResul()	0	30	5
A	onStop()	0	3	1
A	getStatusNameByCode()	0	3	1

<?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.
 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

Missing @link tag in file comment

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;

/**

Missing short description in doc comment

 * @author Vladimir Turnaev <turnaev@gmail.com>
 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

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

    const STATUS_NAME_SUCCESS = 'SUCCESS';
    const STATUS_NAME_WARNING = 'WARNING';
    const STATUS_NAME_SKIP = 'SKIP';
    const STATUS_NAME_UNKNOWN = 'UNKNOWN';
    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;

    /**

Missing short description in doc comment

     * @var ResultsCollection
     */
    protected $results;

    public static function getStatusNameByCode(int $statusCode): string

Missing doc comment for function getStatusNameByCode()

    {
        return static::$STATUS_MAP[$statusCode] ?? static::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

The type Tvi\MonitorBundle\Reporter\ArrayObject was not found. Did you mean ArrayObject? If so, make sure to prefix the type with \.

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

Missing @return tag in function comment

    public function onStart(\ArrayObject $checks, $runnerConfig)
    {
        $this->stopped = false;

        $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
     */

Missing @return tag in function comment

    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
     */

Missing @return tag in function comment

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

        // Display information that the test has been aborted.
        if ($this->stopped) {
            $this->onStopped();
        }
    }

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    public function getTotalCount(): int

Missing doc comment for function getTotalCount()

    {
        return $this->totalCount;
    }

    public function isStopped(): bool

Missing doc comment for function isStopped()

    {
        return $this->stopped;
    }

    public function getResults(): ResultsCollection

Missing doc comment for function getResults()

    {
        return $this->results;
    }

    protected function onStopped()

Missing doc comment for function onStopped()

    {
    }

    /**

Missing short description in doc comment

Parameter $result should have a doc-comment as per coding-style.

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

Line indented incorrectly; expected 8 spaces, found 12

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

            case $result instanceof WarningInterface:

Line indented incorrectly; expected 8 spaces, found 12

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

            case $result instanceof SkipInterface:

Line indented incorrectly; expected 8 spaces, found 12

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

            case $result instanceof FailureInterface:

Line indented incorrectly; expected 8 spaces, found 12

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

            default:

Line indented incorrectly; expected 8 spaces, found 12

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

        return [$name, $code];
    }
}