App\Support\Models\Relation\BelongsToCreatedBy

Complexity

Total Complexity

3

Size/Duplication

Total Lines	33
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	setCreatedByRelationValue()	0	5	1
A	createdBy()	0	3	1
A	getCreatedByRelationValue()	0	3	1

<?php

namespace App\Support\Models\Relation;

use App\Models\User;
use Illuminate\Database\Eloquent\Relations\BelongsTo;

/**
 * @property int $created_by Foreign key of \App\Models\User.
 * @property-read \App\Models\User $createdBy
 */
trait BelongsToCreatedBy
{
    /**
     * Define an inverse one-to-one relationship with \App\Models\User.
     *
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
     */
    public function createdBy(): BelongsTo
    {
        return $this->belongsTo(User::class, 'created_by');

It seems like belongsTo() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * Return \App\Models\User model relation value.
     *
     * @return \App\Models\User
     */
    public function getCreatedByRelationValue(): User
    {
        return $this->getRelationValue('created_by');

It seems like getRelationValue() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * Set \App\Models\User model relation value.
     *
     * @param  \App\Models\User  $user
     * @return $this
     */
    public function setCreatedByRelationValue(User $user)
    {
        $this->createdBy()->associate($user);

        return $this;
    }
}