netglue/prismic-php-kit

View on GitHub
src/Prismic/Ref.php

Summary

Maintainability
A
35 mins
Test Coverage
A
100%

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

        string $id,
        string $ref,
        string $label,
        bool   $isMasterRef,
        ?int   $maybeScheduledAt = null
Severity: Minor
Found in src/Prismic/Ref.php - About 35 mins to fix

    Avoid using static access to class '\DateTimeImmutable' in method 'getScheduledDate'.
    Open

            return DateTimeImmutable::createFromFormat(
                'U',
                (string) $this->getScheduledAtTimestamp()
            );
    Severity: Minor
    Found in src/Prismic/Ref.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

    Doc-block of $maybeScheduledAt in __construct is phpdoc param type int which is not a permitted replacement of the nullable param type ?int declared in the signature ('?T' should be documented as 'T|null' or '?T')
    Open

         * @param int    $maybeScheduledAt If scheduled, a javascript timestamp in milliseconds otherwise null
    Severity: Minor
    Found in src/Prismic/Ref.php by phan

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

        private $id;
    Severity: Minor
    Found in src/Prismic/Ref.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 $id. Configured minimum length is 3.
    Open

            string $id,
    Severity: Minor
    Found in src/Prismic/Ref.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

    There are no issues that match your filters.

    Category
    Status