Sign upLogin

heiseonline/shariff-backend-php

View on GitHub
Star

Showing 23 of 23 total issues

Function get has a Cognitive Complexity of 17 (exceeds 5 allowed). Consider refactoring.
Open

    public function get(string $url)
    {
        // Changing configuration invalidates the cache
        $cacheKey = md5($url . $this->baseCacheKey);
Severity: Minor
Found in src/Backend/BackendManager.php - About 2 hrs 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

Method get has 39 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function get(string $url)
    {
        // Changing configuration invalidates the cache
        $cacheKey = md5($url . $this->baseCacheKey);
Severity: Minor
Found in src/Backend/BackendManager.php - About 1 hr to fix

    Avoid classes with short names like Vk. Configured minimum length is 3.
    Open

    class Vk extends Request implements ServiceInterface
{
    /**
     * {@inheritdoc}
     */
    Severity: Minor
    Found in src/Backend/Vk.php by phpmd

    ShortClassName

    Since: 2.9

    Detects when classes or interfaces have a very short name.

    Example

    class Fo {

}

interface Fo {

}

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

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

            $i      = 0;
    Severity: Minor
    Found in src/Backend/BackendManager.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

    Method __construct has 5 arguments (exceeds 4 allowed). Consider refactoring.
    Open

            string $baseCacheKey,
        CacheInterface $cache,
        ClientInterface $client,
        $domains,
        array $services
    Severity: Minor
    Found in src/Backend/BackendManager.php - About 35 mins to fix

      Missing class import via use statement (line '55', column '20').
      Open

              return new \GuzzleHttp\Psr7\Request($method, $url);
      Severity: Minor
      Found in src/Backend/Request.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 '25', column '20').
      Open

              return new \GuzzleHttp\Psr7\Request(
      Severity: Minor
      Found in src/Backend/StumbleUpon.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 '25', column '20').
      Open

              return new \GuzzleHttp\Psr7\Request(
      Severity: Minor
      Found in src/Backend/Xing.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

      Avoid too many return statements within this method.
      Open

              return $counts;
      Severity: Major
      Found in src/Backend/BackendManager.php - About 30 mins to fix

        Missing class import via use statement (line '40', column '20').
        Open

                return new \GuzzleHttp\Psr7\Request('GET', $query);
        Severity: Minor
        Found in src/Backend/Facebook.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 '25', column '20').
        Open

                return new \GuzzleHttp\Psr7\Request(
        Severity: Minor
        Found in src/Backend/Buffer.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 '70', column '27').
        Open

                        throw new \InvalidArgumentException('Invalid service name "' . $serviceName . '".');
        Severity: Minor
        Found in src/Backend/ServiceFactory.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 '25', column '20').
        Open

                return new \GuzzleHttp\Psr7\Request(
        Severity: Minor
        Found in src/Backend/Pinterest.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 '25', column '20').
        Open

                return new \GuzzleHttp\Psr7\Request(
        Severity: Minor
        Found in src/Backend/Vk.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 '26', column '23').
        Open

                    throw new \InvalidArgumentException('The Facebook app_id and secret must not be empty.');
        Severity: Minor
        Found in src/Backend/Facebook.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 '25', column '20').
        Open

                return new \GuzzleHttp\Psr7\Request('GET', 'https://www.reddit.com/api/info.json?url=' . urlencode($url));
        Severity: Minor
        Found in src/Backend/Reddit.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

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

            public function extractCount(array $data): int
    {
        $count = 0;
        if (!empty($data['data']['children'])) {
            foreach ($data['data']['children'] as $child) {
        Severity: Minor
        Found in src/Backend/Reddit.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

        Avoid using static access to class '\Laminas\Cache\StorageFactory' in method '__construct'.
        Open

                $cache = StorageFactory::factory([
            'adapter' => [
                'name'    => $configuration['adapter'],
                'options' => $configuration['adapterOptions'],
            ],
        Severity: Minor
        Found in src/LaminasCache.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 get uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
        Open

                    } else {
                try {
                    $content                     = $service->filterResponse($results[$i]->getBody()->getContents());
                    $json                        = json_decode($content, true);
                    $counts[$service->getName()] = is_array($json) ? $service->extractCount($json) : 0;
        Severity: Minor
        Found in src/Backend/BackendManager.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 '\GuzzleHttp\Pool' in method 'get'.
        Open

                $results = Pool::batch($this->client, $requests);
        Severity: Minor
        Found in src/Backend/BackendManager.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

        Severity
        Category
        Status
        Source
        Language