JMGQ\AStar\Benchmark\Result\ResultPrinter

Complexity

Total Complexity

7

Size/Duplication

Total Lines	65
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	display()	0	20	2
A	orderResults()	0	8	1
A	formatSolutionFound()	0	14	3

<?php

This file is missing a doc comment.

The PHP open tag does not have a corresponding PHP close tag

Filename "ResultPrinter.php" doesn't match the expected filename "resultprinter.php"

Missing file doc comment

namespace JMGQ\AStar\Benchmark\Result;

use Symfony\Component\Console\Style\StyleInterface;

class ResultPrinter

Missing class doc comment

{

Opening brace should be on the same line as the declaration for class ResultPrinter

    private $output;

Private member variable "output" must contain a leading underscore

Expected 1 blank line before member var; 0 found

Missing member variable doc comment

Private member variable "output" must be prefixed with an underscore

    public function __construct(StyleInterface $output)

Expected 2 blank lines before function; 1 found

Missing function doc comment

    {

Opening brace should be on the same line as the declaration

        $this->output = $output;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end __construct()

    /**

Missing short description in doc comment

     * @param AggregatedResult[] $results

Missing parameter comment

     */

Missing @return tag in function comment

    public function display(array $results)
    {

Opening brace should be on the same line as the declaration

        $tableRows = array();

Short array syntax must be used to define arrays

        $orderedResults = $this->orderResults($results);

        foreach ($orderedResults as $result) {
            $size = $result->getSize() . 'x' . $result->getSize();

Equals sign not aligned with surrounding assignments; expected 12 spaces but found 1 space

Concat operator must not be surrounded by spaces

            $averageDuration = $result->getAverageDuration() . 'ms';

Concat operator must not be surrounded by spaces

            $minimumDuration = $result->getMinimumDuration() . 'ms';

Concat operator must not be surrounded by spaces

            $maximumDuration = $result->getMaximumDuration() . 'ms';

Concat operator must not be surrounded by spaces

            $solutionFound = $this->formatSolutionFound($result);

Equals sign not aligned with surrounding assignments; expected 3 spaces but found 1 space

            $tableRows[] = array($size, $averageDuration, $minimumDuration, $maximumDuration, $solutionFound);

Arrays with multiple values should not be declared on a single line.

Short array syntax must be used to define arrays

        }

        $tableHeaders = array('Size', 'Avg Duration', 'Min Duration', 'Max Duration', 'Solved?');

Arrays with multiple values should not be declared on a single line.

Short array syntax must be used to define arrays

        $this->output->table($tableHeaders, $tableRows);
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end display()

    /**

Missing short description in doc comment

     * @param AggregatedResult[] $results

Missing parameter comment

     * @return AggregatedResult[]
     */
    private function orderResults(array $results)

Private method name "ResultPrinter::orderResults" must be prefixed with an underscore

    {

Opening brace should be on the same line as the declaration

        usort($results, function ($a, $b) {

The opening parenthesis of a multi-line function call should be the last content on the line.

            return $a->getSize() > $b->getSize();
        });

For multi-line function calls, the closing parenthesis should be on a new line.

        return $results;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end orderResults()

    /**

Missing short description in doc comment

     * @param AggregatedResult $result

Missing parameter comment

     * @return string
     */
    private function formatSolutionFound($result)

Private method name "ResultPrinter::formatSolutionFound" must be prefixed with an underscore

Type hint "AggregatedResult" missing for $result

    {

Opening brace should be on the same line as the declaration

        $allResultsAreSolved = $result->getNumberOfSolutions() === $result->getNumberOfTerrains();

The value of a comparison must not be assigned to a variable

        if ($allResultsAreSolved) {
            return 'Yes';
        }

        $allResultsAreUnsolved = $result->getNumberOfSolutions() === 0;

The value of a comparison must not be assigned to a variable

        if ($allResultsAreUnsolved) {
            return 'No';
        }

        return 'Sometimes';
    }

Expected 2 blank lines after function; 0 found

Expected 1 blank line before closing function brace; 0 found

Expected //end formatSolutionFound()

}

Expected //end class

As per coding style, files should not end with a newline character.