PascalKleindienst/octobercms-github-projects

View on GitHub
classes/Github.php

Summary

Maintainability
A
45 mins
Test Coverage

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

    public function repos($username, $type, $sort, $direction, $page = 1, $per_page = 30)
Severity: Minor
Found in classes/Github.php - About 45 mins to fix

    Avoid using static access to class '\Cache' in method 'fetchCache'.
    Wontfix

            return Cache::remember($key, self::$TTL, function () use ($key) {
                return $this->fetch($key);
            });
    Severity: Minor
    Found in classes/Github.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 variables with short names like $id. Configured minimum length is 3.
    Open

        public function gist($id, $sha=null)
    Severity: Minor
    Found in classes/Github.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 parameter $per_page is not named in camelCase.
    Open

        public function repos($username, $type, $sort, $direction, $page = 1, $per_page = 30)
        {
            return $this->fetchCache(
                "/users/$username/repos?" . http_build_query([
                    'type'      => $type,
    Severity: Minor
    Found in classes/Github.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 $ch. Configured minimum length is 3.
    Open

            $ch = curl_init();
    Severity: Minor
    Found in classes/Github.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

    Incorrect spacing between argument "$sha" and equals sign; expected 1 but found 0
    Open

        public function gist($id, $sha=null)
    Severity: Minor
    Found in classes/Github.php by phpcodesniffer

    Incorrect spacing between default value and equals sign for argument "$sha"; expected 1 but found 0
    Open

        public function gist($id, $sha=null)
    Severity: Minor
    Found in classes/Github.php by phpcodesniffer

    The variable $per_page is not named in camelCase.
    Open

        public function repos($username, $type, $sort, $direction, $page = 1, $per_page = 30)
        {
            return $this->fetchCache(
                "/users/$username/repos?" . http_build_query([
                    'type'      => $type,
    Severity: Minor
    Found in classes/Github.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