AuditableTrait::getUserClass() - Code Metrics - yajra/laravel-auditable - Measure and Improve Code Quality continuously with Scrutinizer

AuditableTrait::getUserClass() A
last analyzed 2021-06-03 03:28 UTC

↳ Parent: AuditableTrait

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
dl	0
loc	8
ccs	0
cts	2
cp	0
rs	10
c	0
b	0
f	0
cc	2
nc	2
nop	0
crap	6

<?php

namespace Yajra\Auditable;

use Illuminate\Database\Eloquent\Builder;

/**
 * @property mixed creator
 * @property mixed updater
 */
trait AuditableTrait
{
    /**
     * Boot the audit trait for a model.
     *
     * @return void
     */
    public static function bootAuditableTrait()
    {
        static::observe(new AuditableTraitObserver);
    }

    /**
     * Get user model who created the record.
     *
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
     */
    public function creator()
    {
        return $this->belongsTo($this->getUserClass(), $this->getCreatedByColumn())
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                    ->withDefault(config('auditable.defaults.creator'));
    }

    /**
     * Get user class.
     *
     * @return string
     */
    protected function getUserClass()
    {
        if (property_exists($this, 'auditUser')) {
            return $this->auditUser;
class MyClass { }

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

        return config('auth.providers.users.model', 'App\User');
    }

    /**
     * Get column name for created by.
     *
     * @return string
     */
    public function getCreatedByColumn()
    {
        return defined('static::CREATED_BY') ? static::CREATED_BY : 'created_by';
    }

    /**
     * Get user model who updated the record.
     *
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
     */
    public function updater()
    {
        return $this->belongsTo($this->getUserClass(), $this->getUpdatedByColumn())
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                    ->withDefault(config('auditable.defaults.updater'));
    }

    /**
     * Get column name for updated by.
     *
     * @return string
     */
    public function getUpdatedByColumn()
    {
        return defined('static::UPDATED_BY') ? static::UPDATED_BY : 'updated_by';
    }

    /**
     * Get created by user full name.
     *
     * @return string
     */
    public function getCreatedByNameAttribute()
    {
        return $this->creator->name ?? '';
    }

    /**
     * Get updated by user full name.
     *
     * @return string
     */
    public function getUpdatedByNameAttribute()
    {
        return $this->updater->name ?? '';
    }

    /**
     * Query scope to limit results to own records.
     *
     * @param \Illuminate\Database\Eloquent\Builder $query
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeOwned(Builder $query)
    {
        return $query->where($this->getQualifiedUserIdColumn(), auth()->id());
    }

    /**
     * Get qualified column name for user id.
     *
     * @return string
     */
    public function getQualifiedUserIdColumn()
    {
        return $this->getTable() . '.' . $this->getUserInstance()->getKey();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * Get Laravel's user class instance.
     *
     * @return \Illuminate\Database\Eloquent\Model
     */
    public function getUserInstance()
    {
        $class = $this->getUserClass();

        return new $class;
    }
}


1			<?php
2
3			namespace Yajra\Auditable;
4
5			use Illuminate\Database\Eloquent\Builder;
6
7			/**
8			* @property mixed creator
9			* @property mixed updater
10			*/
11			trait AuditableTrait
12			{
13			/**
14			* Boot the audit trait for a model.
15			*
16			* @return void
17			*/
18			public static function bootAuditableTrait()
19			{
20			static::observe(new AuditableTraitObserver);
21			}
22
23			/**
24			* Get user model who created the record.
25			*
26			* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
27			*/
28			public function creator()
29			{
30			return $this->belongsTo($this->getUserClass(), $this->getCreatedByColumn())
			0 ignored issues – show Bug introduced 2019-08-22 04:42 UTC by Report Bug Copy Issue Report 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...
31			->withDefault(config('auditable.defaults.creator'));
32			}
33
34			/**
35			* Get user class.
36			*
37			* @return string
38			*/
39			protected function getUserClass()
40			{
41			if (property_exists($this, 'auditUser')) {
42			return $this->auditUser;
			0 ignored issues – show Bug introduced 2019-08-27 14:15 UTC by Report Bug Copy Issue Report The property `auditUser` 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...
43			}
44
45			return config('auth.providers.users.model', 'App\User');
46			}
47
48			/**
49			* Get column name for created by.
50			*
51			* @return string
52			*/
53			public function getCreatedByColumn()
54			{
55			return defined('static::CREATED_BY') ? static::CREATED_BY : 'created_by';
56			}
57
58			/**
59			* Get user model who updated the record.
60			*
61			* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
62			*/
63			public function updater()
64			{
65			return $this->belongsTo($this->getUserClass(), $this->getUpdatedByColumn())
			0 ignored issues – show Bug introduced 2019-08-22 04:42 UTC by Report Bug Copy Issue Report 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...
66			->withDefault(config('auditable.defaults.updater'));
67			}
68
69			/**
70			* Get column name for updated by.
71			*
72			* @return string
73			*/
74			public function getUpdatedByColumn()
75			{
76			return defined('static::UPDATED_BY') ? static::UPDATED_BY : 'updated_by';
77			}
78
79			/**
80			* Get created by user full name.
81			*
82			* @return string
83			*/
84			public function getCreatedByNameAttribute()
85			{
86			return $this->creator->name ?? '';
87			}
88
89			/**
90			* Get updated by user full name.
91			*
92			* @return string
93			*/
94			public function getUpdatedByNameAttribute()
95			{
96			return $this->updater->name ?? '';
97			}
98
99			/**
100			* Query scope to limit results to own records.
101			*
102			* @param \Illuminate\Database\Eloquent\Builder $query
103			* @return \Illuminate\Database\Eloquent\Builder
104			*/
105			public function scopeOwned(Builder $query)
106			{
107			return $query->where($this->getQualifiedUserIdColumn(), auth()->id());
108			}
109
110			/**
111			* Get qualified column name for user id.
112			*
113			* @return string
114			*/
115			public function getQualifiedUserIdColumn()
116			{
117			return $this->getTable() . '.' . $this->getUserInstance()->getKey();
			0 ignored issues – show Bug introduced 2019-08-22 04:42 UTC by Report Bug Copy Issue Report It seems like `getTable()` 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...
118			}
119
120			/**
121			* Get Laravel's user class instance.
122			*
123			* @return \Illuminate\Database\Eloquent\Model
124			*/
125			public function getUserInstance()
126			{
127			$class = $this->getUserClass();
128
129			return new $class;
130			}
131			}
132

yajra / laravel-auditable

AuditableTrait::getUserClass() A last analyzed 2021-06-03 03:28 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

AuditableTrait::getUserClass() A
last analyzed 2021-06-03 03:28 UTC