Sign upLogin

quack/quack

View on GitHub
Star
src/cli/Console.php

Summary

Maintainability
A
2 hrs
Test Coverage

The class Console has 16 public methods. Consider refactoring Console to keep number of public methods under 10.
Open

class Console
{
    private $stdin;
    private $stdout;
    private $stderr;
Severity: Minor
Found in src/cli/Console.php by phpmd

TooManyPublicMethods

Since: 0.1

A class with too many public methods is probably a good suspect for refactoring, in order to reduce its complexity and find a way to have more fine grained objects.

By default it ignores methods starting with 'get' or 'set'.

Example

Source https://phpmd.org/rules/codesize.html#toomanypublicmethods

Console has 21 functions (exceeds 20 allowed). Consider refactoring.
Open

class Console
{
    private $stdin;
    private $stdout;
    private $stderr;
Severity: Minor
Found in src/cli/Console.php - About 2 hrs to fix

    Function getEvent has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
    Open

        public function getEvent($char)
    {
        $event = @$this->event_tree[ord($char)];
        if (null === $event) {
            return null;
    Severity: Minor
    Found in src/cli/Console.php - About 25 mins to fix

    Cognitive Complexity

    Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

    A method's cognitive complexity is based on a few simple rules:

    • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
    • Code is considered more complex for each "break in the linear flow of the code"
    • Code is considered more complex when "flow breaking structures are nested"

    Further reading

    Remove error control operator '@' on line 157.
    Open

        public function getEvent($char)
    {
        $event = @$this->event_tree[ord($char)];
        if (null === $event) {
            return null;
    Severity: Minor
    Found in src/cli/Console.php by phpmd

    ErrorControlOperator

    Error suppression should be avoided if possible as it doesn't just suppress the error, that you are trying to stop, but will also suppress errors that you didn't predict would ever occur. Consider changing error_reporting() level and/or setting up your own error handler.

    Example

    function foo($filePath) {
    $file = @fopen($filPath); // hides exceptions
    $key = @$array[$notExistingKey]; // assigns null to $key
}

    Source http://phpmd.org/rules/cleancode.html#errorcontroloperator

    Avoid variables with short names like $n. Configured minimum length is 3.
    Open

        public function forwardCursor($n)
    Severity: Minor
    Found in src/cli/Console.php by phpmd

    ShortVariable

    Since: 0.2

    Detects when a field, local, or parameter has a very short name.

    Example

    class Something {
    private $q = 15; // VIOLATION - Field
    public static function main( array $as ) { // VIOLATION - Formal
        $r = 20 + $this->q; // VIOLATION - Local
        for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
            $r += $this->q;
        }
    }
}

    Source https://phpmd.org/rules/naming.html#shortvariable

    The property $stty_settings is not named in camelCase.
    Open

    class Console
{
    private $stdin;
    private $stdout;
    private $stderr;
    Severity: Minor
    Found in src/cli/Console.php by phpmd

    CamelCasePropertyName

    Since: 0.2

    It is considered best practice to use the camelCase notation to name attributes.

    Example

    class ClassName {
    protected $property_name;
}

    Source

    The property $event_tree is not named in camelCase.
    Open

    class Console
{
    private $stdin;
    private $stdout;
    private $stderr;
    Severity: Minor
    Found in src/cli/Console.php by phpmd

    CamelCasePropertyName

    Since: 0.2

    It is considered best practice to use the camelCase notation to name attributes.

    Example

    class ClassName {
    protected $property_name;
}

    Source

    The parameter $event_tree is not named in camelCase.
    Open

        public function subscribe($event_tree)
    {
        $this->event_tree = $event_tree;
    }
    Severity: Minor
    Found in src/cli/Console.php by phpmd

    CamelCaseParameterName

    Since: 0.2

    It is considered best practice to use the camelCase notation to name parameters.

    Example

    class ClassName {
    public function doSomething($user_name) {
    }
}

    Source

    Avoid variables with short names like $n. Configured minimum length is 3.
    Open

        public function backwardCursor($n)
    Severity: Minor
    Found in src/cli/Console.php by phpmd

    ShortVariable

    Since: 0.2

    Detects when a field, local, or parameter has a very short name.

    Example

    class Something {
    private $q = 15; // VIOLATION - Field
    public static function main( array $as ) { // VIOLATION - Formal
        $r = 20 + $this->q; // VIOLATION - Local
        for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
            $r += $this->q;
        }
    }
}

    Source https://phpmd.org/rules/naming.html#shortvariable

    The variable $event_tree is not named in camelCase.
    Open

        public function subscribe($event_tree)
    {
        $this->event_tree = $event_tree;
    }
    Severity: Minor
    Found in src/cli/Console.php by phpmd

    CamelCaseVariableName

    Since: 0.2

    It is considered best practice to use the camelCase notation to name variables.

    Example

    class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

    Source

    There are no issues that match your filters.

    Category
    Status