Completed
Push — master ( d9849e...578f69 )
by Arjay
20s queued 11s
created

src/AuditableWithDeletesTrait.php (1 issue)

Labels
Severity

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

1
<?php
2
3
namespace Yajra\Auditable;
4
5
/**
6
 * @property mixed deleter
7
 */
8
trait AuditableWithDeletesTrait
9
{
10
    use AuditableTrait;
11
12
    /**
13
     * Boot the audit trait for a model.
14
     *
15
     * @return void
16
     */
17
    public static function bootAuditableWithDeletesTrait()
18
    {
19
        static::observe(new AuditableWithDeletesTraitObserver);
20
    }
21
22
    /**
23
     * Get user model who deleted the record.
24
     *
25
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
26
     */
27
    public function deleter()
28
    {
29
        return $this->belongsTo($this->getUserClass(), $this->getDeletedByColumn())->withDefault();
0 ignored issues
show
It seems like belongsTo() 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...
30
    }
31
32
    /**
33
     * Get column name for deleted by.
34
     *
35
     * @return string
36
     */
37
    public function getDeletedByColumn()
38
    {
39
        return defined('static::DELETED_BY') ? static::DELETED_BY : 'deleted_by';
40
    }
41
42
    /**
43
     * Get deleted by user full name.
44
     *
45
     * @return string
46
     */
47
    public function getDeletedByNameAttribute()
48
    {
49
        return $this->deleter->name ?? '';
50
    }
51
}
52