HasScopeChecks   A
last analyzed

Complexity

Total Complexity 6

Size/Duplication

Total Lines 29
Duplicated Lines 0 %

Coupling/Cohesion

Components 0
Dependencies 1

Importance

Changes 0
Metric Value
wmc 6
lcom 0
cbo 1
dl 0
loc 29
rs 10
c 0
b 0
f 0

3 Methods

Rating   Name   Duplication   Size   Complexity  
A isCheckScopeMethod() 0 4 2
A getOriginalScopeMethodName() 0 4 1
A forwardCallTo() 0 16 3
1
<?php
2
3
namespace BeyondCode\LaravelScopeChecks;
4
5
use Illuminate\Support\Str;
6
7
trait HasScopeChecks
8
{
9
    protected function isCheckScopeMethod(string $method): bool
10
    {
11
        return Str::startsWith($method, 'is') || Str::startsWith($method, 'has');
12
    }
13
14
    protected function getOriginalScopeMethodName($checkMethodName): string
15
    {
16
        return preg_replace('/^(is|has)(.*)$/m', '$2', $checkMethodName);
17
    }
18
19
    protected function forwardCallTo($object, $method, $parameters)
20
    {
21
        if ($this->isCheckScopeMethod($method)) {
22
            $originalScopeMethodName = $this->getOriginalScopeMethodName($method);
23
24
            if (method_exists($this, "scope{$originalScopeMethodName}")) {
25
                $builder = $this->newQuery()->where($this->getKeyName(), $this->getKey());
0 ignored issues
show
Bug introduced by
It seems like newQuery() must be provided by classes using this trait. How about adding it as abstract method to this trait?

This check looks for methods that are used by a trait but not required by it.

To illustrate, let’s look at the following code example

trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

The trait Idable provides a method equalsId that in turn relies on the method getId(). If this method does not exist on a class mixing in this trait, the method will fail.

Adding the getId() as an abstract method to the trait will make sure it is available.

Loading history...
Bug introduced by
It seems like getKeyName() must be provided by classes using this trait. How about adding it as abstract method to this trait?

This check looks for methods that are used by a trait but not required by it.

To illustrate, let’s look at the following code example

trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

The trait Idable provides a method equalsId that in turn relies on the method getId(). If this method does not exist on a class mixing in this trait, the method will fail.

Adding the getId() as an abstract method to the trait will make sure it is available.

Loading history...
Bug introduced by
It seems like getKey() must be provided by classes using this trait. How about adding it as abstract method to this trait?

This check looks for methods that are used by a trait but not required by it.

To illustrate, let’s look at the following code example

trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

The trait Idable provides a method equalsId that in turn relies on the method getId(). If this method does not exist on a class mixing in this trait, the method will fail.

Adding the getId() as an abstract method to the trait will make sure it is available.

Loading history...
26
27
                $builder = call_user_func_array([$builder, $originalScopeMethodName], $parameters);
28
29
                return $builder->exists();
30
            }
31
        }
32
33
        return parent::forwardCallTo($object, $method, $parameters);
34
    }
35
}
36