EddIriarte\Console\Inputs\Traits\ChunkableOptions

Complexity

Total Complexity

10

Size/Duplication

Total Lines	68
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getChunksCount()	0	3	1
A	hasEntryAt()	0	4	2
A	getChunkAt()	0	7	2
A	getEntryAt()	0	7	2
A	getChunks()	0	11	3

<?php

This file is missing a doc comment.

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

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

namespace EddIriarte\Console\Inputs\Traits;

Missing file doc comment

use EddIriarte\Console\Inputs\Exceptions\IndexOutOfRange;


/**
 * Trait ChunkableOptions
 * @package EddIriarte\Console\Inputs\Traits

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

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

Content of the @author tag must be in the form "Display Name <username@example.com>"

Tag value indented incorrectly; expected 2 spaces but found 1

 */

Missing @category tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

trait ChunkableOptions
{

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

    protected $chunks;

Protected member variable "chunks" must contain a leading underscore

Expected 1 blank line before member var; 0 found

Missing member variable doc comment

    protected $chunkSize = 3;

Protected member variable "chunkSize" must contain a leading underscore

Missing member variable doc comment

    /**

Missing short description in doc comment

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

     * @return array
     */
    public function getChunks(int $chunkSize = null): array

Expected 2 blank lines before function; 1 found

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

        if (!is_null($chunkSize)) {

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

            $this->chunkSize = $chunkSize;
        }

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

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

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

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

        }

        return $this->chunks;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getChunks()

    /**

Missing short description in doc comment

     * @param int $index

Missing parameter comment

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

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

Comment missing for @throws tag in function comment

     */

Missing @throws tag for "IndexOutOfRange" exception

    public function getChunkAt(int $index): array
    {

Opening brace should be on the same line as the declaration

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

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

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

        throw new IndexOutOfRange($index);
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getChunkAt()

    /**

Missing short description in doc comment

     * @return int

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

     */
    public function getChunksCount(): int
    {

Opening brace should be on the same line as the declaration

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

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getChunksCount()

    /**

Missing short description in doc comment

     * @param int $rowIndex

Missing parameter comment

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

     * @param int $colIndex

Missing parameter comment

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

     * @return bool

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

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

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]);

Boolean operators are not allowed outside of control structure conditions

    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end hasEntryAt()

    /**

Missing short description in doc comment

     * @param int $rowIndex

Missing parameter comment

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

     * @param int $colIndex

Missing parameter comment

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

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

Comment missing for @throws tag in function comment

     */

Missing @throws tag for "IndexOutOfRange" exception

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

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}");

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

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

    }

Expected 2 blank lines after function; 0 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getEntryAt()

}

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