dzarezenko/hitbtc-api

View on GitHub
src/HitBtcAPIPublic.php

Summary

Maintainability
A
45 mins
Test Coverage

Method getTrades has 6 arguments (exceeds 4 allowed). Consider refactoring.
Open

    public function getTrades($symbol, $by, $from, $startIndex = 0, $maxResults = 1000, $optionalParams = []) {
Severity: Minor
Found in src/HitBtcAPIPublic.php - About 45 mins to fix

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

        public function getRecentTrades($symbol, $maxResults = 1000, $formatItem = 'array', $side = true) {
    Severity: Minor
    Found in src/HitBtcAPIPublic.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 $isDemoAPI, which is a certain sign of a Single Responsibility Principle violation.
    Open

        public function __construct($apiVersion = 2, $isDemoAPI = false) {
    Severity: Minor
    Found in src/HitBtcAPIPublic.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 'hitbtc\api\tools\Request' in method '_request'.
    Open

            $response = tools\Request::json($request, $this->apiVersion, $this->isDemoAPI);
    Severity: Minor
    Found in src/HitBtcAPIPublic.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

    TODO found
    Open

                    $assocTicker = []; // TODO: implement more efficient solution
    Severity: Minor
    Found in src/HitBtcAPIPublic.php by fixme

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

        public function getTrades($symbol, $by, $from, $startIndex = 0, $maxResults = 1000, $optionalParams = []) {
    Severity: Minor
    Found in src/HitBtcAPIPublic.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 method _request is not named in camelCase.
    Open

        private function _request($method, $request = null) {
            if (is_null($request)) {
                $request = $method;
            }
    
    
    Severity: Minor
    Found in src/HitBtcAPIPublic.php by phpmd

    CamelCaseMethodName

    Since: 0.2

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

    Example

    class ClassName {
        public function get_name() {
        }
    }

    Source

    There are no issues that match your filters.

    Category
    Status