App\Models\HrAdvisor

Complexity

Total Complexity

6

Size/Duplication

Total Lines	70
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	1

5 Methods

Rating	Name	Duplication	Size	Complexity
A	user()	0	3	1
A	getClaimedJobIdsAttribute()	0	3	1
A	department()	0	3	1
A	claimed_jobs()	0	5	1
A	getNameAttribute()	0	6	2

<?php

namespace App\Models;

/**
 * Class HrAdvisor
 *
 * @property int $id
 * @property int $user_id
 * @property int $department_id
 *
 * @property \App\Models\User $user
 * @property \App\Models\Lookup\Department $department
 * @property \Illuminate\Database\Eloquent\Collection $job_posters
 * @property \Jenssegers\Date\Date $created_at
 * @property \Jenssegers\Date\Date $updated_at
 *
 * Computed Properties
 * @property string $name
 * @property int[] $claimed_job_ids
 */
class HrAdvisor extends BaseModel
{
    /**
     * @var string[] $casts
     */
    protected $casts = [
        'department_id' => 'int',
        'user_id' => 'int'
    ];

    /**
     * The attributes that should be visible in arrays.
     *
     * @var array
     */
    protected $visible = ['id', 'department_id', 'user_id', 'name', 'claimed_job_ids'];

    /**
     * @var string[] $fillable
     */
    protected $fillable = ['department_id'];



    /**
     * The accessors to append to the model's array form.
     *
     * @var array
     */
    protected $appends = ['name', 'claimed_job_ids'];

    public function user()

Missing doc comment for function user()

Method \App\Models\HrAdvisor::user() does not have return type hint nor @return annotation for its return value.

    {
        return $this->belongsTo(\App\Models\User::class);
    }

    public function department()

Missing doc comment for function department()

Method \App\Models\HrAdvisor::department() does not have return type hint nor @return annotation for its return value.

    {
        return $this->belongsTo(\App\Models\Lookup\Department::class);
    }

    public function claimed_jobs()

Missing doc comment for function claimed_jobs()

Method name "HrAdvisor::claimed_jobs" is not in camel caps format

Method \App\Models\HrAdvisor::claimed_jobs() does not have return type hint nor @return annotation for its return value.

    {
        return $this->belongsToMany(
            \App\Models\JobPoster::class,
            'claimed_jobs'
        );
    }

    /**
     * Return the full name of the User associated with this HR Advisor.
     *
     * @return string

Method \App\Models\HrAdvisor::getNameAttribute() has useless @return annotation.

     */
    public function getNameAttribute(): string
    {
        if ($this->user !== null) {
            return $this->user->first_name . ' ' . $this->user->last_name;
        }
        return '';
    }

    /**
     * Return an array of ids of claimed jobs.
     *
     * @return array

@return annotation of method \App\Models\HrAdvisor::getClaimedJobIdsAttribute() does not specify type hint for items of its traversable return value.

     */
    public function getClaimedJobIdsAttribute()

Method \App\Models\HrAdvisor::getClaimedJobIdsAttribute() does not have native return type hint for its return value but it should be possible to add it based on @return annotation "array".

    {
        return $this->claimed_jobs()->allRelatedIds()->toArray();
    }
}