Applicant::setApplicantCriteria()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 6

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 6
rs 10
c 0
b 0
f 0
cc 1
nc 1
nop 1
1
<?php
2
3
namespace Te7aHoudini\LaravelApplicant\Traits;
4
5
use Illuminate\Support\Arr;
6
use Te7aHoudini\LaravelApplicant\Models\Application;
7
8
trait Applicant
9
{
10
    /**
11
     * creates a new application model object for this model.
12
     *
13
     * @param null|array|object $model
14
     * @param array $criteria
15
     * @return \Te7aHoudini\LaravelApplicant\Models\Application
16
     */
17
    public function appliesFor($model = null, $criteria = [])
18
    {
19
        $applicationType = Arr::get($criteria, 'type', Arr::get($this->applicantCriteria, 'type', 'applicant'));
0 ignored issues
show
Bug introduced by
The property applicantCriteria does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
20
21
        $applicationStatus = Arr::get($criteria, 'status', Arr::get($this->applicantCriteria, 'status', 'created'));
22
23
        if (is_null($model)) {
24
            $data = [
25
                'type' => $applicationType,
26
                'status' => $applicationStatus,
27
            ];
28
        }
29
30
        if (is_array($model)) {
31
            $data = array_merge(
32
                $model,
33
                [
34
                    'type' => $model['type'] ?? $applicationType,
35
                    'status' => $model['status'] ?? $applicationStatus,
36
                ]
37
            );
38
        }
39
40
        if (is_object($model)) {
41
            $data = [
42
                'type' => $applicationType,
43
                'status' => $applicationStatus,
44
                'receiver_id' => $model->id,
45
                'receiver_type' => get_class($model),
46
            ];
47
        }
48
49
        return Application::create(array_merge($data, ['applicant_id' => $this->id, 'applicant_type' => get_class($this)]));
0 ignored issues
show
Bug introduced by
The property id does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
Bug introduced by
The variable $data does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
50
    }
51
52
    /**
53
     * check if current model has applied on application or not.
54
     *
55
     * @param null|array|object $model
56
     * @param array $criteria
57
     * @return bool
58
     */
59
    public function hasAppliedFor($model = null, $criteria = [])
60
    {
61
        return $this->appliedApplicationsFor($model, $criteria)->exists();
62
    }
63
64
    /**
65
     * get applications that model has applied on.
66
     *
67
     * @param null|array|object $model
68
     * @param array $criteria
69
     * @return \Illuminate\Database\Eloquent\Builder
70
     */
71
    public function appliedApplicationsFor($model = null, $criteria = [])
72
    {
73
        $applicationType = Arr::get($criteria, 'type', Arr::get($this->applicantCriteria, 'type', 'applicant'));
74
75
        $applicationStatus = Arr::get($criteria, 'status', Arr::get($this->applicantCriteria, 'status', 'created'));
76
77
        $query = $this->appliedApplications();
78
79
        if (is_null($model)) {
80
            $query->where('type', $applicationType)->where('status', $applicationStatus);
81
        }
82
83
        if (is_array($model)) {
84
            $data = array_merge(
85
                $model,
86
                [
87
                    'type' => $model['type'] ?? $applicationType,
88
                    'status' => $model['status'] ?? $applicationStatus,
89
                ]
90
            );
91
92
            foreach ($data as $column => $value) {
93
                $query->where($column, $value);
94
            }
95
        }
96
97
        if (is_object($model)) {
98
            $query->where('type', $applicationType)->where('status', $applicationStatus)->where('receiver_id', $model->id)->where('receiver_type', get_class($model));
99
        }
100
101
        return $query;
102
    }
103
104
    /**
105
     * sets applicantCriteria attribute and returns $this to allow fluent api.
106
     *
107
     * @param array $criteria
108
     * @return self
109
     */
110
    public function setApplicantCriteria($criteria = [])
111
    {
112
        $this->applicantCriteria = $criteria;
113
114
        return $this;
115
    }
116
117
    /**
118
     * returns this model applied applications.
119
     *
120
     * @return \Illuminate\Database\Eloquent\Relations\MorphMany
121
     */
122
    public function appliedApplications()
123
    {
124
        return $this->morphMany(Application::class, 'applicant');
0 ignored issues
show
Bug introduced by
It seems like morphMany() 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...
125
    }
126
}
127