Yajra\Auditable\AuditableTrait

Complexity

Total Complexity

12

Size/Duplication

Total Lines	117
Duplicated Lines	17.09 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

0%

Importance

Changes	5
Bugs	0	Features	1

10 Methods

Rating	Name	Duplication	Size	Complexity
A	bootAuditableTrait()	0	4	1
A	creator()	0	4	1
A	getCreatedByColumn()	0	4	1
A	updater()	0	4	1
A	getUpdatedByColumn()	0	4	1
A	getCreatedByNameAttribute()	10	10	2
A	getUserInstance()	0	6	1
A	getUpdatedByNameAttribute()	10	10	2
A	scopeOwned()	0	4	1
A	getQualifiedUserIdColumn()	0	4	1

<?php

namespace Yajra\Auditable;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Relations\BelongsTo;

/**
 * Class AuditableTrait
 *
 * @property int created_by
 * @property int updated_by
 * @method string getTable()
 * @method void observe($observer)
 * @method BelongsTo belongsTo($related, $foreignKey = null, $otherKey = null, $relation = null)
 * @package Yajra\Auditable
 */
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(get_class(auth()->user()), $this->getCreatedByColumn());
    }

    /**
     * Get column name for created by.
     *
     * @return string
     */
    protected function getCreatedByColumn()
    {
        return 'created_by';
    }

    /**
     * Get user model who updated the record.
     *
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
     */
    public function updater()
    {
        return $this->belongsTo(get_class(auth()->user()), $this->getUpdatedByColumn());
    }

    /**
     * Get column name for updated by.
     *
     * @return string
     */
    protected function getUpdatedByColumn()
    {
        return 'updated_by';
    }

    /**
     * Get created by user full name.
     *
     * @return string
     */
    public function getCreatedByNameAttribute()

This method seems to be duplicated in your project.

    {
        if ($this->{$this->getCreatedByColumn()}) {
            $user = $this->getUserInstance()->find($this->{$this->getCreatedByColumn()});

            return $user->first_name . ' ' . $user->last_name;
        }

        return '';
    }

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

        return new $class;
    }

    /**
     * Get updated by user full name.
     *
     * @return string
     */
    public function getUpdatedByNameAttribute()

This method seems to be duplicated in your project.

    {
        if ($this->{$this->getUpdatedByColumn()}) {
            $user = $this->getUserInstance()->find($this->{$this->getUpdatedByColumn()});

            return $user->first_name . ' ' . $user->last_name;
        }

        return '';
    }

    /**
     * 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();
    }
}