rhosocial/yii2-base-models

View on GitHub
traits/EntityQueryTrait.php

Summary

Maintainability
A
2 hrs
Test Coverage

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

    public function guid(mixed $guid, false|string $like = false): static
Severity: Minor
Found in traits/EntityQueryTrait.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 id has a boolean flag argument $like, which is a certain sign of a Single Responsibility Principle violation.
Open

    public function id(mixed $id, false|string $like = false): static
Severity: Minor
Found in traits/EntityQueryTrait.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 guidOrId has a boolean flag argument $like, which is a certain sign of a Single Responsibility Principle violation.
Open

    public function guidOrId(int|string $param, bool|string $like = false): static
Severity: Minor
Found in traits/EntityQueryTrait.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

Similar blocks of code found in 2 locations. Consider refactoring.
Open

    public function updatedAtToday(): static
    {
        /* @var $this ActiveQuery */
        $model = $this->noInitModel;
        $start = strtotime(date('Y-m-d'));
Severity: Major
Found in traits/EntityQueryTrait.php and 1 other location - About 1 hr to fix
traits/EntityQueryTrait.php on lines 110..121

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 108.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

Similar blocks of code found in 2 locations. Consider refactoring.
Open

    public function createdAtToday(): static
    {
        /* @var $this ActiveQuery */
        $model = $this->noInitModel;
        $start = strtotime(date('Y-m-d'));
Severity: Major
Found in traits/EntityQueryTrait.php and 1 other location - About 1 hr to fix
traits/EntityQueryTrait.php on lines 158..169

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 108.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

Avoid using short method names like EntityQueryTrait::id(). The configured minimum method name length is 3.
Open

    public function id(mixed $id, false|string $like = false): static
    {
        /* @var $this ActiveQuery */
        $model = $this->noInitModel;
        return $this->likeCondition((string)$id, $model->idAttribute, $like);
Severity: Minor
Found in traits/EntityQueryTrait.php by phpmd

ShortMethodName

Since: 0.2

Detects when very short method names are used.

Example

class ShortMethod {
    public function a( $index ) { // Violation
    }
}

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

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

    public function id(mixed $id, false|string $like = false): static
Severity: Minor
Found in traits/EntityQueryTrait.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

Scope keyword "static" must be followed by a single space
Open

    public function updatedAtToday(): static
Severity: Minor
Found in traits/EntityQueryTrait.php by phpcodesniffer

Scope keyword "static" must be followed by a single space
Open

    public function orderByCreatedAt(int|string $sort = SORT_ASC): static
Severity: Minor
Found in traits/EntityQueryTrait.php by phpcodesniffer

Scope keyword "static" must be followed by a single space
Open

    public function page(int|string|null $pageSize = 10, ?int $currentPage = 0): static
Severity: Minor
Found in traits/EntityQueryTrait.php by phpcodesniffer

Scope keyword "static" must be followed by a single space
Open

    public function updatedAt(?string $start = null, ?string $end = null): static
Severity: Minor
Found in traits/EntityQueryTrait.php by phpcodesniffer

Scope keyword "static" must be followed by a single space
Open

    public function orderByUpdatedAt(int|string $sort = SORT_ASC): static
Severity: Minor
Found in traits/EntityQueryTrait.php by phpcodesniffer

Scope keyword "static" must be followed by a single space
Open

    public function guid(mixed $guid, false|string $like = false): static
Severity: Minor
Found in traits/EntityQueryTrait.php by phpcodesniffer

Scope keyword "static" must be followed by a single space
Open

    public function guidOrId(int|string $param, bool|string $like = false): static
Severity: Minor
Found in traits/EntityQueryTrait.php by phpcodesniffer

Scope keyword "static" must be followed by a single space
Open

    public function createdAt(?string $start = null, ?string $end = null): static
Severity: Minor
Found in traits/EntityQueryTrait.php by phpcodesniffer

Scope keyword "static" must be followed by a single space
Open

    public function createdAtToday(): static
Severity: Minor
Found in traits/EntityQueryTrait.php by phpcodesniffer

Scope keyword "static" must be followed by a single space
Open

    public function id(mixed $id, false|string $like = false): static
Severity: Minor
Found in traits/EntityQueryTrait.php by phpcodesniffer

There are no issues that match your filters.

Category
Status