TextFormatter::reportBeginning() - Code Metrics - Inspection of "Start to work on generic issue reporters" - ovr/phpsa - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#235)

by Kévin

created 2016-10-11 21:35 UTC

TextFormatter::reportBeginning() A

↳ Parent: TextFormatter

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php

namespace PHPSA\Report\Formatter;

use PHPSA\Issue;

class TextFormatter implements ReportFormatter
{
    /**
     * {@inheritdoc}
     */
    public function reportBeginning()
    {
        return '';
    }

    /**
     * {@inheritdoc}
     */
    public function reportEnd()
    {
        return '';
    }

    /**
     * @param Issue $issue
     *
     * @return string The formatted issue.
     */
    public function formatIssue(Issue $issue)
    {
        if ($issue->getCheckName() === 'syntax-error') {
            return $this->formatSyntaxError($issue);
        }

        return $this->formatNotice($issue);
    }

    private function formatSyntaxError(Issue $issue)
    {
        $filepath = $issue->getLocation()->getFilePath();
        $line = $issue->getLocation()->getLineStart();
        $codeLines = file($filepath);

        $output = '<error>Syntax error:  ' . $issue->getDescription() . " in {$filepath} </error>\n\n";

        $lineContent = trim($codeLines[$line-1]);
        if (!empty($lineContent)) {
            $output .= "<comment>\t {$lineContent} </comment>\n";
        }

        return $output . "\n";
    }

    private function formatNotice(Issue $issue)
    {
        $filepath = $issue->getLocation()->getFilePath();
        $line = $issue->getLocation()->getLineStart();
        $codeLines = file($filepath);

        $output = '<comment>Notice:  ' . $issue->getDescription() . " in {$filepath} on {$line} [{$issue->getCheckName()}]</comment>\n\n";

        if ($issue->getBlame()) {
            $output .= "<comment>\t {$issue->getBlame()}</comment>\n";
        } else {
            $code = trim($codeLines[$line - 1]);

            if (!empty($code)) {
                $output .= "<comment>\t {$code} </comment>\n";
            }
        }

        return $output . "\n";
    }
}


1			<?php
2
3			namespace PHPSA\Report\Formatter;
4
5			use PHPSA\Issue;
6
7			class TextFormatter implements ReportFormatter
8			{
9			/**
10			* {@inheritdoc}
11			*/
12			public function reportBeginning()
13			{
14			return '';
15			}
16
17			/**
18			* {@inheritdoc}
19			*/
20			public function reportEnd()
21			{
22			return '';
23			}
24
25			/**
26			* @param Issue $issue
27			*
28			* @return string The formatted issue.
29			*/
30			public function formatIssue(Issue $issue)
31			{
32			if ($issue->getCheckName() === 'syntax-error') {
33			return $this->formatSyntaxError($issue);
34			}
35
36			return $this->formatNotice($issue);
37			}
38
39			private function formatSyntaxError(Issue $issue)
40			{
41			$filepath = $issue->getLocation()->getFilePath();
42			$line = $issue->getLocation()->getLineStart();
43			$codeLines = file($filepath);
44
45			$output = '<error>Syntax error: ' . $issue->getDescription() . " in {$filepath} </error>\n\n";
46
47			$lineContent = trim($codeLines[$line-1]);
48			if (!empty($lineContent)) {
49			$output .= "<comment>\t {$lineContent} </comment>\n";
50			}
51
52			return $output . "\n";
53			}
54
55			private function formatNotice(Issue $issue)
56			{
57			$filepath = $issue->getLocation()->getFilePath();
58			$line = $issue->getLocation()->getLineStart();
59			$codeLines = file($filepath);
60
61			$output = '<comment>Notice: ' . $issue->getDescription() . " in {$filepath} on {$line} [{$issue->getCheckName()}]</comment>\n\n";
62
63			if ($issue->getBlame()) {
64			$output .= "<comment>\t {$issue->getBlame()}</comment>\n";
65			} else {
66			$code = trim($codeLines[$line - 1]);
67
68			if (!empty($code)) {
69			$output .= "<comment>\t {$code} </comment>\n";
70			}
71			}
72
73			return $output . "\n";
74			}
75			}
76

ovr / phpsa

Pull Request — master (#235)

TextFormatter::reportBeginning() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like