eddiriarte / console-select

src/Helpers/SelectionHelper.php

<?php

This file is missing a doc comment.

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

Filename "SelectionHelper.php" doesn't match the expected filename "selectionhelper.php"

namespace EddIriarte\Console\Helpers;

Missing file doc comment

use EddIriarte\Console\Handlers\SelectHandler;
use Symfony\Component\Console\Formatter\OutputFormatterStyle;
use Symfony\Component\Console\Helper\HelperInterface;
use Symfony\Component\Console\Helper\HelperSet;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use EddIriarte\Console\Inputs\Interfaces\SelectInput;

/**
 * Class SelectionHelper
 *
 * Its used for registration to symfonys output helpers.
 *
 * @package EddIriarte\Console\Helpers

@package tag is not allowed in class comment

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

@author tag is not allowed in class comment

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

class SelectionHelper implements HelperInterface
{

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

    use StreamableInput;

    /**

Missing short description in doc comment

     * @var InputInterface
     */
    protected $input;

Protected member variable "input" must contain a leading underscore

    /**

Missing short description in doc comment

     * @var OutputInterface
     */
    protected $output;

Protected member variable "output" must contain a leading underscore

    /**

Missing short description in doc comment

     * @var null
     */
    protected $helperSet = null;

Protected member variable "helperSet" must contain a leading underscore

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

    /**
     * SelectionHelper constructor.
     * @param InputInterface $input

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

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

     * @param OutputInterface $output

Missing parameter comment

     */
    public function __construct(InputInterface $input, OutputInterface $output)

Expected 2 blank lines before function; 1 found

    {

Opening brace should be on the same line as the declaration

        $this->input = $input;

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

        $this->output = $output;

        $this->checkAnsiSupport();
        $this->setOutputStyles();
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end __construct()

    /**

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

     * {@inheritdoc}
     */

Missing @return tag in function comment

    public function setHelperSet(HelperSet $helperSet = null)

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->helperSet = $helperSet;

It seems like $helperSet can also be of type Symfony\Component\Console\Helper\HelperSet. However, the property $helperSet is declared as type null. Maybe add an additional type check?

    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end setHelperSet()

    /**
     * {@inheritdoc}
     */

Missing @return tag in function comment

    public function getHelperSet()
    {

Opening brace should be on the same line as the declaration

        return $this->helperSet;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getHelperSet()

    /**
     * {@inheritdoc}
     */

Missing @return tag in function comment

    public function getName()
    {

Opening brace should be on the same line as the declaration

        return 'selection';
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getName()

    /**
     * Allow multiple item selections to user.
     *
     * @param SelectInput $question

Missing parameter comment

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return array

Tag cannot be grouped with parameter tags in a doc comment

     */
    public function select(SelectInput $question)
    {

Opening brace should be on the same line as the declaration

        $select = new SelectHandler($question, $this->output, $this->getInputStream());

        $responses = $select->handle();
        // TODO: validate responses  ???

Comments for TODO tasks are often forgotten in the code; it might be better to use a dedicated issue tracker.

There should be no blank line after an inline comment.

        return $responses;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end select()

    /**

Doc comment is empty

     *
     */

Missing @return tag in function comment

    protected function checkAnsiSupport(): void
    {

Opening brace should be on the same line as the declaration

        if ($this->output->isDecorated()) {
            return;
        }

        // // disable overwrite when output does not support ANSI codes.
        // $this->overwrite = false;

45% of this comment could be valid code. Did you maybe forget this after debugging?

        // // set a reasonable redraw frequency so output isn't flooded
        // $this->setRedrawFrequency(10);

72% of this comment could be valid code. Did you maybe forget this after debugging?

    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end checkAnsiSupport()

    protected function setOutputStyles()

Missing function doc comment

    {

Opening brace should be on the same line as the declaration

        if (!$this->output->getFormatter()->hasStyle('hl')) {

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

            $style = new OutputFormatterStyle('black', 'white');
            $this->output->getFormatter()->setStyle('hl', $style);
        }
    }

Expected 2 blank lines after function; 0 found

Expected 1 blank line before closing function brace; 0 found

Expected //end setOutputStyles()

}

Expected //end class

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