ChunkableOptions::getChunks() - Code Metrics - eddiriarte/console-select - Measure and Improve Code Quality continuously with Scrutinizer

ChunkableOptions::getChunks() A
last analyzed 2020-10-20 07:24 UTC

↳ Parent: ChunkableOptions

Complexity

Conditions	3
Paths	4

Size

Total Lines	11
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	3

Importance

Changes

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

<?php

Coding Style introduced 2019-12-15 17:23 UTC by

This file is missing a doc comment.

Coding Style introduced 2019-12-15 17:23 UTC by

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

Coding Style introduced 2019-12-15 17:23 UTC by

Filename "ChunkableOptions.php" doesn't match the expected filename "chunkableoptions.php"

namespace EddIriarte\Console\Inputs\Traits;

Coding Style introduced 2019-12-15 17:23 UTC by

Missing file doc comment

use EddIriarte\Console\Inputs\Exceptions\IndexOutOfRange;

/**

 * Trait ChunkableOptions

 * @package EddIriarte\Console\Inputs\Traits

Coding Style introduced 2019-12-15 17:23 UTC by

There must be exactly one blank line before the tags in a doc comment

 * @author Eduardo Iriarte <eddiriarte[at]gmail[dot]com>

Coding Style introduced 2019-12-15 17:23 UTC by

Content of the @author tag must be in the form "Display Name <[email protected]>"

Coding Style introduced 2019-12-15 17:23 UTC by

Tag value indented incorrectly; expected 2 spaces but found 1

*/

Coding Style introduced 2019-12-15 17:23 UTC by

Missing @category tag in class comment

Coding Style introduced 2019-12-15 17:23 UTC by

Missing @license tag in class comment

Coding Style introduced 2019-12-15 17:23 UTC by

Missing @link tag in class comment

trait ChunkableOptions

Coding Style introduced 2019-12-15 17:23 UTC by

Opening brace should be on the same line as the declaration for trait ChunkableOptions

    protected $chunks;

Coding Style introduced 2019-12-15 17:23 UTC by

Protected member variable "chunks" must contain a leading underscore

Coding Style introduced 2019-12-15 17:23 UTC by

Expected 1 blank line before member var; 0 found

Coding Style Documentation introduced 2019-12-15 17:23 UTC by

Missing member variable doc comment

    protected $chunkSize = 3;

Coding Style introduced 2019-12-15 17:23 UTC by

Protected member variable "chunkSize" must contain a leading underscore

Coding Style Documentation introduced 2019-12-15 17:23 UTC by

Missing member variable doc comment

/**

Coding Style introduced 2019-12-15 17:23 UTC by

Missing short description in doc comment

Coding Style introduced 2019-12-15 17:23 UTC by

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

     * @return array

*/

    public function getChunks(int $chunkSize = null): array

Coding Style introduced 2019-12-15 17:23 UTC by

Expected 2 blank lines before function; 1 found

Coding Style introduced 2019-12-15 17:23 UTC by

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

Coding Style introduced 2019-12-15 17:23 UTC by

Opening brace should be on the same line as the declaration

        if (!is_null($chunkSize)) {

Coding Style introduced 2019-12-15 17:23 UTC by

There must be a single space after a NOT operator; 0 found

            $this->chunkSize = $chunkSize;

        if (!isset($this->chunks)) {

Coding Style introduced 2019-12-15 17:23 UTC by

There must be a single space after a NOT operator; 0 found

            $this->chunks = array_chunk($this->getOptions(), $this->chunkSize);

Bug introduced 2018-05-23 19:02 UTC by

It seems like getOptions() must be provided by classes using this trait. How about adding it as abstract method to this trait? ( Ignorable by Annotation )

        return $this->chunks;

Coding Style introduced 2019-12-15 17:23 UTC by

Expected 2 blank lines after function; 1 found

Coding Style introduced 2019-12-15 17:23 UTC by

Expected 1 blank line before closing function brace; 0 found

Coding Style introduced 2019-12-15 17:23 UTC by

Expected //end getChunks()

/**

Coding Style introduced 2019-12-15 17:23 UTC by

Missing short description in doc comment

     * @param int $index

Coding Style introduced 2019-12-15 17:23 UTC by

Missing parameter comment

Coding Style introduced 2019-12-15 17:23 UTC by

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

     * @return array

     * @throws EddIriarte\Console\Inputs\Exceptions\IndexOutOfRange

introduced 2019-12-15 17:23 UTC by

Comment missing for @throws tag in function comment

*/

Coding Style Documentation introduced 2019-12-15 17:23 UTC by

Missing @throws tag for "IndexOutOfRange" exception

    public function getChunkAt(int $index): array

Coding Style introduced 2019-12-15 17:23 UTC by

Opening brace should be on the same line as the declaration

        if (!empty($this->getChunks()[$index])) {

Coding Style introduced 2019-12-15 17:23 UTC by

There must be a single space after a NOT operator; 0 found

            return $this->getChunks()[$index];

        throw new IndexOutOfRange($index);

Coding Style introduced 2019-12-15 17:23 UTC by

Expected 2 blank lines after function; 1 found

Coding Style introduced 2019-12-15 17:23 UTC by

Expected 1 blank line before closing function brace; 0 found

Coding Style introduced 2019-12-15 17:23 UTC by

Expected //end getChunkAt()

/**

Coding Style introduced 2019-12-15 17:23 UTC by

Missing short description in doc comment

     * @return int

Coding Style introduced 2019-12-15 17:23 UTC by

Expected "integer" but found "int" for function return type

*/

    public function getChunksCount(): int

Coding Style introduced 2019-12-15 17:23 UTC by

Opening brace should be on the same line as the declaration

        return count($this->getChunks());

Coding Style introduced 2019-12-15 17:23 UTC by

Expected 2 blank lines after function; 1 found

Coding Style introduced 2019-12-15 17:23 UTC by

Expected 1 blank line before closing function brace; 0 found

Coding Style introduced 2019-12-15 17:23 UTC by

Expected //end getChunksCount()

/**

Coding Style introduced 2019-12-15 17:23 UTC by

Missing short description in doc comment

     * @param int $rowIndex

Coding Style introduced 2019-12-15 17:23 UTC by

Missing parameter comment

Coding Style introduced 2019-12-15 17:23 UTC by

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

     * @param int $colIndex

Coding Style introduced 2019-12-15 17:23 UTC by

Missing parameter comment

Coding Style introduced 2019-12-15 17:23 UTC by

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

     * @return bool

Coding Style introduced 2019-12-15 17:23 UTC by

Expected "boolean" but found "bool" for function return type

*/

    public function hasEntryAt(int $rowIndex, int $colIndex): bool

Coding Style introduced 2019-12-15 17:23 UTC by

Opening brace should be on the same line as the declaration

        $chunks = $this->getChunks();

        return array_key_exists($rowIndex, $chunks) && array_key_exists($colIndex, $chunks[$rowIndex]);

Coding Style introduced 2019-12-15 17:23 UTC by

Boolean operators are not allowed outside of control structure conditions

Coding Style introduced 2019-12-15 17:23 UTC by

Expected 2 blank lines after function; 1 found

Coding Style introduced 2019-12-15 17:23 UTC by

Expected 1 blank line before closing function brace; 0 found

Coding Style introduced 2019-12-15 17:23 UTC by

Expected //end hasEntryAt()

/**

Coding Style introduced 2019-12-15 17:23 UTC by

Missing short description in doc comment

     * @param int $rowIndex

Coding Style introduced 2019-12-15 17:23 UTC by

Missing parameter comment

Coding Style introduced 2019-12-15 17:23 UTC by

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

     * @param int $colIndex

Coding Style introduced 2019-12-15 17:23 UTC by

Missing parameter comment

Coding Style introduced 2019-12-15 17:23 UTC by

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

     * @return string

     * @throws EddIriarte\Console\Inputs\Exceptions\IndexOutOfRange

introduced 2019-12-15 17:23 UTC by

Comment missing for @throws tag in function comment

*/

Coding Style Documentation introduced 2019-12-15 17:23 UTC by

Missing @throws tag for "IndexOutOfRange" exception

    public function getEntryAt(int $rowIndex, int $colIndex): string

Coding Style introduced 2019-12-15 17:23 UTC by

Opening brace should be on the same line as the declaration

        if ($this->hasEntryAt($rowIndex, $colIndex)) {

            return $this->getChunks()[$rowIndex][$colIndex];

        throw new IndexOutOfRange("{$rowIndex}:{$colIndex}");

Coding Style Best Practice introduced 2019-12-15 17:23 UTC by

As per coding-style, please use concatenation or sprintf for the variable $rowIndex instead of interpolation.

Coding Style Best Practice introduced 2019-12-15 17:23 UTC by

As per coding-style, please use concatenation or sprintf for the variable $colIndex instead of interpolation.

Coding Style introduced 2019-12-15 17:23 UTC by

Expected 2 blank lines after function; 0 found

Coding Style introduced 2019-12-15 17:23 UTC by

Expected 1 blank line before closing function brace; 0 found

Coding Style introduced 2019-12-15 17:23 UTC by

Expected //end getEntryAt()

Coding Style introduced 2019-12-15 17:23 UTC by

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

eddiriarte / console-select

ChunkableOptions::getChunks() A last analyzed 2020-10-20 07:24 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

ChunkableOptions::getChunks() A
last analyzed 2020-10-20 07:24 UTC