App\Models\Compilation

Complexity

Total Complexity

6

Size/Duplication

Total Lines	78
Duplicated Lines	0 %

Importance

Changes	3
Bugs	1	Features	1

6 Methods

Rating	Name	Duplication	Size	Complexity
A	items()	0	9	1
A	getStageWeeksAttribute()	0	3	1
A	stageLocation()	0	3	1
A	stageWard()	0	3	1
A	student()	0	3	1
A	getStageDays()	0	3	1

<?php
declare(strict_types=1);

namespace App\Models;

use App\Models\Traits\EloquentGetTableName;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Database\Eloquent\SoftDeletes;
use Staudenmeir\EloquentParamLimitFix\ParamLimitFix;

class Compilation extends Model
{

    use SoftDeletes;
    use EloquentGetTableName;
    use ParamLimitFix;

    /**
     * The attributes that should be mutated to dates.
     *
     * @var array
     */
    protected $dates = ["deleted_at"];

    protected $appends = [
        "stage_weeks"
    ];

    /**
     * Get the student who created this compilation
     * @return BelongsTo
     */
    public function student(): BelongsTo
    {
        return $this->belongsTo("App\Models\Student")->withTrashed();
    }

    /**
     * Get the location where the stage of this compilation took place
     * @return BelongsTo
     */
    public function stageLocation(): BelongsTo
    {
        return $this->belongsTo("App\Models\Location", "stage_location_id", "id")->withTrashed();
    }

    /**
     * Get the ward where the stage of this compilation took place
     * @return BelongsTo
     */
    public function stageWard(): BelongsTo
    {
        return $this->belongsTo("App\Models\Ward", "stage_ward_id", "id")->withTrashed();
    }

    /**
     * Get the items of this compilation (as relationship)
     * @return HasMany
     */
    public function items(): HasMany
    {
        return $this->hasMany("App\Models\CompilationItem")
            // Compilation items are returned only once, although items related
            // to "multiple_choice" are stored as several records/models.
            ->groupBy("compilation_id")
            ->groupBy("question_id")
            // @todo item sorting must be based on section+question "position" attributes
            ->orderBy("question_id");
    }

    /**
     * Get the number of stage weeks.
     *
     * @return int
     */
    public function getStageWeeksAttribute(): int
    {
        return (int)round($this->getStageDays() / 7);
    }

    /**
     * Get the number of stage days.
     *
     * @return int
     */
    public function getStageDays(): int
    {
        return ((strtotime($this->stage_end_date) - strtotime($this->stage_start_date)) / 60 / 60 / 24) + 1;
    }

}