App\Command\ConsoleCommand

Complexity

Total Complexity

3

Size/Duplication

Total Lines	56
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	buildOptionParser()	0	12	1
A	execute()	0	27	2

<?php

Class found in ".php" file; use ".inc" extension instead

This file is missing a doc comment.

Header blocks must be separated by a single blank line

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

Filename "ConsoleCommand.php" doesn't match the expected filename "consolecommand.php"

declare(strict_types=1);

/**

The file-level docblock must follow the opening PHP tag in the file header

Inline doc block comments are not allowed; use "/* Comment */" or "// Comment" instead

Block comments must be started with /*

 * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
 * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)

Doc comment short description must be on a single line, further text should be a separate paragraph

 *
 * Licensed under The MIT License
 * For full copyright and license information, please see the LICENSE.txt
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)

@copyright tag must contain a year and the name of the copyright holder

 * @link      https://cakephp.org CakePHP(tm) Project

Tag value indented incorrectly; expected 1 space but found 6

The tag in position 2 should be the @license tag

 * @since     3.0.0

The tag in position 3 should be the @link tag

Tag value indented incorrectly; expected 1 space but found 5

 * @license   https://opensource.org/licenses/mit-license.php MIT License

Tag value indented incorrectly; expected 1 space but found 3

The tag in position 4 should be the @since tag

 */

PHP version not specified

Header blocks must be separated by a single blank line

Missing @author tag in file comment

Missing @package tag in file comment

Missing @category tag in file comment

namespace App\Command;

use Cake\Command\Command;
use Cake\Console\Arguments;
use Cake\Console\ConsoleIo;
use Cake\Console\ConsoleOptionParser;
use Cake\Log\Log;
use Psy\Shell as PsyShell;

/**
 * Simple console wrapper around Psy\Shell.
 */

Missing @license tag in class comment

Missing @link tag in class comment

Missing @category tag in class comment

Missing @author tag in class comment

Missing @package tag in class comment

class ConsoleCommand extends Command
{

Opening brace should be on the same line as the declaration

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

    /**
     * Start the Command and interactive console.
     *
     * @param \Cake\Console\Arguments $args The command arguments.

Parameter comment must be on the next line

     * @param \Cake\Console\ConsoleIo $io The console io

Expected 3 spaces after parameter name; 1 found

Parameter comment must end with a full stop

Parameter comment must be on the next line

     * @return int|null|void The exit code or null for success

Expected "integer|null|void" but found "int|null|void" for function return type

Separate the @param and @return sections by a blank line.

     */
    public function execute(Arguments $args, ConsoleIo $io)

Expected 1 blank line before function; 0 found

The method parameter $args is never used

    {

Opening brace should be on the same line as the declaration

        if (!class_exists('Psy\Shell')) {

Expected 1 space(s) after NOT operator; 0 found

            $io->err('<error>Unable to load Psy\Shell.</error>');
            $io->err('');
            $io->err('Make sure you have installed psysh as a dependency,');
            $io->err('and that Psy\Shell is registered in your autoloader.');
            $io->err('');
            $io->err('If you are using composer run');
            $io->err('');
            $io->err('<info>$ php composer.phar require --dev psy/psysh</info>');
            $io->err('');

            return static::CODE_ERROR;
        }

        $io->out('You can exit with <info>`CTRL-C`</info> or <info>`exit`</info>');
        $io->out('');

        Log::drop('debug');
        Log::drop('error');
        $io->setLoggers(false);
        restore_error_handler();
        restore_exception_handler();

        $psy = new PsyShell();
        $psy->run();
    }

    /**
     * Display help for this console.
     *
     * @param \Cake\Console\ConsoleOptionParser $parser The parser to update

Parameter comment must be on the next line

Parameter comment must end with a full stop

     * @return \Cake\Console\ConsoleOptionParser

Separate the @param and @return sections by a blank line.

     */
    public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser
    {

Opening brace should be on the same line as the declaration

        $parser->setDescription(
            'This shell provides a REPL that you can use to interact with ' .
            'your application in a command line designed to run PHP code. ' .
            'You can use it to run adhoc queries with your models, or ' .
            'explore the features of CakePHP and your application.' .
            "\n\n" .
            'You will need to have psysh installed for this Shell to work.'
        );

        return $parser;
    }

Expected 1 blank line after function; 0 found

}