Loggable   A
last analyzed

Complexity

Total Complexity 4

Size/Duplication

Total Lines 42
Duplicated Lines 0 %

Coupling/Cohesion

Components 0
Dependencies 0

Importance

Changes 0
Metric Value
wmc 4
lcom 0
cbo 0
dl 0
loc 42
rs 10
c 0
b 0
f 0

4 Methods

Rating   Name   Duplication   Size   Complexity  
A bootLoggable() 0 4 1
A getLoggableAttributes() 0 4 1
A getUnloggableAttributes() 0 4 1
A changes() 0 5 1
1
<?php namespace Cviebrock\EloquentLoggable;
2
3
use Cviebrock\EloquentLoggable\Models\Change;
4
use Illuminate\Database\Eloquent\Relations\MorphMany;
5
6
7
trait Loggable
8
{
9
10
    /**
11
     * Register events that intercept when model is being saved.
12
     */
13
    public static function bootLoggable()
14
    {
15
        static::observe(app(LoggableObserver::class));
16
    }
17
18
    /**
19
     * Get a list of attributes that are loggable.
20
     *
21
     * @return array
22
     */
23
    public function getLoggableAttributes(): array
24
    {
25
        return [];
26
    }
27
28
    /**
29
     * Get a list of attributes that are unloggable.
30
     *
31
     * @return array
32
     */
33
    public function getUnloggableAttributes(): array
34
    {
35
        return [];
36
    }
37
38
    /**
39
     * Relation to changes.
40
     *
41
     * @return \Illuminate\Database\Eloquent\Relations\MorphMany
42
     */
43
    public function changes(): MorphMany
44
    {
45
        return $this->morphMany(Change::class, 'loggable', 'model_type', 'model_id')
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...
46
            ->orderBy('created_at', 'desc');
47
    }
48
}
49