Sign upLogin

rugk/xenforo-threema-gateway

View on GitHub
Star
src/library/ThreemaGateway/Handler/Action/Receiver.php

Summary

Maintainability
A
2 hrs
Test Coverage

Method getFileList has 37 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function getFileList($mimeType = null, $fileType = null, $threemaId = null, $queryMetaData = true)
    {
        $this->initiate();
        $model = XenForo_Model::create('ThreemaGateway_Model_Messages');
Severity: Minor
Found in src/library/ThreemaGateway/Handler/Action/Receiver.php - About 1 hr to fix

    Function getFileList has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
    Open

        public function getFileList($mimeType = null, $fileType = null, $threemaId = null, $queryMetaData = true)
    {
        $this->initiate();
        $model = XenForo_Model::create('ThreemaGateway_Model_Messages');
    Severity: Minor
    Found in src/library/ThreemaGateway/Handler/Action/Receiver.php - About 1 hr 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

    Missing class import via use statement (line '421', column '49').
    Open

                    throw new XenForo_Exception(new XenForo_Phrase('threemagw_permission_error'));
    Severity: Minor
    Found in src/library/ThreemaGateway/Handler/Action/Receiver.php by phpmd

    MissingImport

    Since: 2.7.0

    Importing all external classes in a file through use statements makes them clearly visible.

    Example

    function make() {
    return new \stdClass();
}

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

    Missing class import via use statement (line '421', column '27').
    Open

                    throw new XenForo_Exception(new XenForo_Phrase('threemagw_permission_error'));
    Severity: Minor
    Found in src/library/ThreemaGateway/Handler/Action/Receiver.php by phpmd

    MissingImport

    Since: 2.7.0

    Importing all external classes in a file through use statements makes them clearly visible.

    Example

    function make() {
    return new \stdClass();
}

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

    Missing class import via use statement (line '179', column '23').
    Open

                throw new XenForo_Exception('Parameter $messageId missing.');
    Severity: Minor
    Found in src/library/ThreemaGateway/Handler/Action/Receiver.php by phpmd

    MissingImport

    Since: 2.7.0

    Importing all external classes in a file through use statements makes them clearly visible.

    Example

    function make() {
    return new \stdClass();
}

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

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

        public function getFileList($mimeType = null, $fileType = null, $threemaId = null, $queryMetaData = true)
    Severity: Minor
    Found in src/library/ThreemaGateway/Handler/Action/Receiver.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

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

        public function __construct($alreadyPrepared = false, $skipPermissionCheck = false)
    Severity: Minor
    Found in src/library/ThreemaGateway/Handler/Action/Receiver.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

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

        public function __construct($alreadyPrepared = false, $skipPermissionCheck = false)
    Severity: Minor
    Found in src/library/ThreemaGateway/Handler/Action/Receiver.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

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

        public function getMessageStateHistory($messageSentId, $getMetaData = true, $limitQuery = null)
    Severity: Minor
    Found in src/library/ThreemaGateway/Handler/Action/Receiver.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 'XenForo_Model' in method 'getLastMessage'.
    Open

            $model = XenForo_Model::create('ThreemaGateway_Model_Messages');
    Severity: Minor
    Found in src/library/ThreemaGateway/Handler/Action/Receiver.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 execute uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
    Open

            } else {
            // query meta data
            $metaData = $model->getMessageMetaData();
            if (!$metaData) {
                return null;
    Severity: Minor
    Found in src/library/ThreemaGateway/Handler/Action/Receiver.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

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

            } else {
            // It's more complex if we want to query image & file messages
            // together, as the MIME type includes image files.
            //
            // Forunately this problem can be solved by just querying each
    Severity: Minor
    Found in src/library/ThreemaGateway/Handler/Action/Receiver.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 using static access to class 'XenForo_Model' in method 'getMessageStateHistory'.
    Open

            $model = XenForo_Model::create('ThreemaGateway_Model_Messages');
    Severity: Minor
    Found in src/library/ThreemaGateway/Handler/Action/Receiver.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 'XenForo_Model' in method 'getMessages'.
    Open

            $model = XenForo_Model::create('ThreemaGateway_Model_Messages');
    Severity: Minor
    Found in src/library/ThreemaGateway/Handler/Action/Receiver.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 'XenForo_Model' in method 'initiate'.
    Open

                $model = XenForo_Model::create('ThreemaGateway_Model_Messages');
    Severity: Minor
    Found in src/library/ThreemaGateway/Handler/Action/Receiver.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 'XenForo_Model' in method 'getFileList'.
    Open

            $model = XenForo_Model::create('ThreemaGateway_Model_Messages');
    Severity: Minor
    Found in src/library/ThreemaGateway/Handler/Action/Receiver.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 'XenForo_Model' in method 'messageIsReceived'.
    Open

            $model = XenForo_Model::create('ThreemaGateway_Model_Messages');
    Severity: Minor
    Found in src/library/ThreemaGateway/Handler/Action/Receiver.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 'XenForo_DataWriter' in method 'removeMessage'.
    Open

            $dataWriter = XenForo_DataWriter::create('ThreemaGateway_DataWriter_Messages');
    Severity: Minor
    Found in src/library/ThreemaGateway/Handler/Action/Receiver.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 'XenForo_Model' in method 'getMessageData'.
    Open

            $model = XenForo_Model::create('ThreemaGateway_Model_Messages');
    Severity: Minor
    Found in src/library/ThreemaGateway/Handler/Action/Receiver.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

    There are no issues that match your filters.

    Category
    Status