JMGQ\AStar\Benchmark\TerrainGenerator

Complexity

Total Complexity

8

Size/Duplication

Total Lines	45
Duplicated Lines	17.78 %

Coupling/Cohesion

Components	0
Dependencies	1

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	generate()	0	18	3
A	validatePositiveInteger()	0	8	2
A	validateOptionalInteger()	8	8	3

<?php

This file is missing a doc comment.

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

Filename "TerrainGenerator.php" doesn't match the expected filename "terraingenerator.php"

Missing file doc comment

namespace JMGQ\AStar\Benchmark;

use JMGQ\AStar\Example\Terrain\TerrainCost;

class TerrainGenerator

Missing class doc comment

{

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

    /**

Missing short description in doc comment

     * @param int $rows

Missing parameter comment

Expected 8 spaces after parameter type; 1 found

Expected "integer" but found "int" for parameter type

     * @param int $columns

Missing parameter comment

Expected 8 spaces after parameter type; 1 found

Expected "integer" but found "int" for parameter type

     * @param int | null $seed

Missing parameter comment

     * @return TerrainCost
     */
    public function generate($rows, $columns, $seed = null)

Expected 2 blank lines before function; 0 found

Type hint "int" missing for $rows

Type hint "int" missing for $columns

TRUE, FALSE and NULL should be uppercase as per the configured coding-style; instead of null please use NULL.

    {

Opening brace should be on the same line as the declaration

        $this->validatePositiveInteger($rows);
        $this->validatePositiveInteger($columns);
        $this->validateOptionalInteger($seed);

        mt_srand($seed);

        $terrainCost = array();

Short array syntax must be used to define arrays

        foreach (range(0, $rows - 1) as $row) {

Arithmetic operation must be bracketed

            foreach (range(0, $columns - 1) as $column) {

Arithmetic operation must be bracketed

                $terrainCost[$row][$column] = mt_rand(1, 10);
            }
        }

        return new TerrainCost($terrainCost);
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end generate()

    private function validatePositiveInteger($number)

Private method name "TerrainGenerator::validatePositiveInteger" must be prefixed with an underscore

Missing function doc comment

    {

Opening brace should be on the same line as the declaration

        $positiveInteger = filter_var($number, FILTER_VALIDATE_INT, array('options' => array('min_range' => 1)));

Short array syntax must be used to define arrays

        if ($positiveInteger === false) {

TRUE, FALSE and NULL should be uppercase as per the configured coding-style; instead of false please use FALSE.

            throw new \InvalidArgumentException('Invalid positive integer: ' . print_r($number, true));

Concat operator must not be surrounded by spaces

TRUE, FALSE and NULL should be uppercase as per the configured coding-style; instead of true please use TRUE.

        }
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end validatePositiveInteger()

    private function validateOptionalInteger($number)

Private method name "TerrainGenerator::validateOptionalInteger" must be prefixed with an underscore

Missing function doc comment

This method seems to be duplicated in your project.

    {

Opening brace should be on the same line as the declaration

        $integer = filter_var($number, FILTER_VALIDATE_INT);

        if ($integer === false && $number !== null) {

TRUE, FALSE and NULL should be uppercase as per the configured coding-style; instead of false please use FALSE.

TRUE, FALSE and NULL should be uppercase as per the configured coding-style; instead of null please use NULL.

            throw new \InvalidArgumentException('Invalid integer: ' . print_r($number, true));

Concat operator must not be surrounded by spaces

TRUE, FALSE and NULL should be uppercase as per the configured coding-style; instead of true please use TRUE.

        }
    }

Expected 2 blank lines after function; 0 found

Expected 1 blank line before closing function brace; 0 found

Expected //end validateOptionalInteger()

}

Expected //end class

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