App\Shell\ConsoleShell

Complexity

Total Complexity

3

Size/Duplication

Total Lines	55
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	main()	0	27	2
A	_getOptionParser()	0	13	1

<?php

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

Header blocks must be separated by a single blank line

Filename "ConsoleShell.php" doesn't match the expected filename "consoleshell.php"

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

/**

Namespaced classes, interfaces and traits should not begin with a file doc comment

 * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
 * Copyright (c) Cake Software Foundation, Inc. (http://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. (http://cakefoundation.org)

Expected "xxxx-xxxx Squiz Pty Ltd (ABN 77 084 670 600)" for copyright declaration

The tag in position 1 should be the @package tag

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

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

The tag in position 2 should be the @subpackage tag

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

The tag in position 3 should be the @author tag

Tag value indented incorrectly; expected 1 space but found 5

 * @license   http://www.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

The tag in position 4 should be the @copyright tag

 */

Header blocks must be separated by a single blank line

PHP version not specified

There must be exactly one blank line after the file comment

Missing @package tag in file comment

Missing @subpackage tag in file comment

Missing @author tag in file comment

Missing @category tag in file comment

namespace App\Shell;

use Cake\Console\ConsoleOptionParser;
use Cake\Console\Shell;
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 @author tag in class comment

Missing @package tag in class comment

Missing @category tag in class comment

class ConsoleShell extends Shell

The class Cake\Console\Shell has been deprecated: 3.6.0 ShellDispatcher and Shell will be removed in 5.0

{

Opening brace should be on the same line as the declaration

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

    /**
     * Start the shell and interactive console.
     *
     * @return int|null

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

     */
    public function main()
    {

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

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

            return self::CODE_ERROR;
        }

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

The string literal You can exit with <info>`CTRL-C`</info> or <info>`exit`</info> does not require double quotes, as per coding-style, please use single quotes.

        $this->out('');

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

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

    /**
     * Display help for this console.
     *
     * @return \Cake\Console\ConsoleOptionParser
     */
    public function _getOptionParser()

Public method name "ConsoleShell::_getOptionParser" must not be prefixed with an underscore

Public method name "ConsoleShell::_getOptionParser" is not in lowerCamel format

    {

Opening brace should be on the same line as the declaration

        $parser = new ConsoleOptionParser('console');
        $parser->description(

The method description() does not exist on Cake\Console\ConsoleOptionParser.

            'This shell provides a REPL that you can use to interact ' .
            'with your application in an interactive fashion. You can use ' .
            'it to run adhoc queries with your models, or experiment ' .
            'and 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

}