Sign upLogin

rugk/threema-msgapi-sdk-php

View on GitHub
Star
source/Threema/Console/Command/Base.php

Summary

Maintainability
A
0 mins
Test Coverage

The method help has a boolean flag argument $shellColors, which is a certain sign of a Single Responsibility Principle violation.
Open

    final public function help($shellColors = true) {
Severity: Minor
Found in source/Threema/Console/Command/Base.php by phpmd

BooleanArgumentFlag

Since: 1.4.0

A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

Example

class Foo {
    public function bar($flag = true) {
    }
}

Source https://phpmd.org/rules/cleancode.html#booleanargumentflag

Avoid using static access to class '\Threema\Console\Common' in method 'getArgumentPublicKey'.
Open

        $content = Common::getPublicKey($this->getArgumentStringOrFileContent($pos));
Severity: Minor
Found in source/Threema/Console/Command/Base.php by phpmd

StaticAccess

Since: 1.4.0

Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

Example

class Foo
{
    public function bar()
    {
        Bar::baz();
    }
}

Source https://phpmd.org/rules/cleancode.html#staticaccess

Avoid using static access to class '\Threema\Console\Command\CryptTool' in method 'getArgumentPrivateKey'.
Open

        $cryptTool = CryptTool::getInstance();
Severity: Minor
Found in source/Threema/Console/Command/Base.php by phpmd

StaticAccess

Since: 1.4.0

Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

Example

class Foo
{
    public function bar()
    {
        Bar::baz();
    }
}

Source https://phpmd.org/rules/cleancode.html#staticaccess

Avoid using static access to class '\Threema\Console\Command\CryptTool' in method 'getArgumentPublicKey'.
Open

        $cryptTool = CryptTool::getInstance();
Severity: Minor
Found in source/Threema/Console/Command/Base.php by phpmd

StaticAccess

Since: 1.4.0

Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

Example

class Foo
{
    public function bar()
    {
        Bar::baz();
    }
}

Source https://phpmd.org/rules/cleancode.html#staticaccess

Avoid using static access to class '\Threema\Console\Common' in method 'getArgumentPrivateKey'.
Open

        $content = Common::getPrivateKey($this->getArgumentStringOrFileContent($pos));
Severity: Minor
Found in source/Threema/Console/Command/Base.php by phpmd

StaticAccess

Since: 1.4.0

Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

Example

class Foo
{
    public function bar()
    {
        Bar::baz();
    }
}

Source https://phpmd.org/rules/cleancode.html#staticaccess

The method getArgument uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
Open

            else {
                return null;
            }
Severity: Minor
Found in source/Threema/Console/Command/Base.php by phpmd

ElseExpression

Since: 1.4.0

An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.

Example

class Foo
{
    public function bar($flag)
    {
        if ($flag) {
            // one branch
        } else {
            // another branch
        }
    }
}

Source https://phpmd.org/rules/cleancode.html#elseexpression

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

        $i = array_search($pos, $this->requiredArguments);
Severity: Minor
Found in source/Threema/Console/Command/Base.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

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

        $f = fopen( 'php://stdin', 'r' );
Severity: Minor
Found in source/Threema/Console/Command/Base.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

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

        $i = $this->getIndexByPos($pos);
Severity: Minor
Found in source/Threema/Console/Command/Base.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

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

        $i = $this->getIndexByPos($pos);
Severity: Minor
Found in source/Threema/Console/Command/Base.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

Constant argSecret should be defined in uppercase
Open

    const argSecret = 'secret';
Severity: Minor
Found in source/Threema/Console/Command/Base.php by phpmd

ConstantNamingConventions

Since: 0.2

Class/Interface constant names should always be defined in uppercase.

Example

class Foo {
    const MY_NUM = 0; // ok
    const myTest = ""; // fail
}

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

Constant argPrivateKeyFile should be defined in uppercase
Open

    const argPrivateKeyFile = 'privateKeyFile';
Severity: Minor
Found in source/Threema/Console/Command/Base.php by phpmd

ConstantNamingConventions

Since: 0.2

Class/Interface constant names should always be defined in uppercase.

Example

class Foo {
    const MY_NUM = 0; // ok
    const myTest = ""; // fail
}

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

Constant argFrom should be defined in uppercase
Open

    const argFrom = 'from';
Severity: Minor
Found in source/Threema/Console/Command/Base.php by phpmd

ConstantNamingConventions

Since: 0.2

Class/Interface constant names should always be defined in uppercase.

Example

class Foo {
    const MY_NUM = 0; // ok
    const myTest = ""; // fail
}

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

Constant argPublicKeyFile should be defined in uppercase
Open

    const argPublicKeyFile = 'publicKeyFile';
Severity: Minor
Found in source/Threema/Console/Command/Base.php by phpmd

ConstantNamingConventions

Since: 0.2

Class/Interface constant names should always be defined in uppercase.

Example

class Foo {
    const MY_NUM = 0; // ok
    const myTest = ""; // fail
}

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

Constant argNonce should be defined in uppercase
Open

    const argNonce = 'nonce';
Severity: Minor
Found in source/Threema/Console/Command/Base.php by phpmd

ConstantNamingConventions

Since: 0.2

Class/Interface constant names should always be defined in uppercase.

Example

class Foo {
    const MY_NUM = 0; // ok
    const myTest = ""; // fail
}

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

Constant argPublicKey should be defined in uppercase
Open

    const argPublicKey = 'publicKey';
Severity: Minor
Found in source/Threema/Console/Command/Base.php by phpmd

ConstantNamingConventions

Since: 0.2

Class/Interface constant names should always be defined in uppercase.

Example

class Foo {
    const MY_NUM = 0; // ok
    const myTest = ""; // fail
}

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

Constant argThreemaId should be defined in uppercase
Open

    const argThreemaId = 'threemaId';
Severity: Minor
Found in source/Threema/Console/Command/Base.php by phpmd

ConstantNamingConventions

Since: 0.2

Class/Interface constant names should always be defined in uppercase.

Example

class Foo {
    const MY_NUM = 0; // ok
    const myTest = ""; // fail
}

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

Constant argPrivateKey should be defined in uppercase
Open

    const argPrivateKey = 'privateKey';
Severity: Minor
Found in source/Threema/Console/Command/Base.php by phpmd

ConstantNamingConventions

Since: 0.2

Class/Interface constant names should always be defined in uppercase.

Example

class Foo {
    const MY_NUM = 0; // ok
    const myTest = ""; // fail
}

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

There are no issues that match your filters.

Category
Status