Activity.php

Go to the documentation of this file.

<?php

namespace BristolSU\Support\Activity;

use BristolSU\ControlDB\Contracts\Repositories\User;
use BristolSU\Support\ActivityInstance\ActivityInstance;
use BristolSU\Support\Authentication\Contracts\Authentication;
use BristolSU\Support\Logic\Logic;
use BristolSU\Support\ModuleInstance\ModuleInstance;
use BristolSU\Support\Revision\HasRevisions;
use BristolSU\Support\User\Contracts\UserAuthentication;
use Carbon\Carbon;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Str;

class Activity extends Model
{
    use HasRevisions;
    
    protected $fillable = [
        'name',
        'description',
        'activity_for',
        'for_logic',
        'admin_logic',
        'start_date',
        'end_date',
        'slug',
        'type',
        'enabled',
        'user_id'
    ];

    protected $casts = [
        'start_date' => 'datetime',
        'end_date' => 'datetime',
        'enabled' => 'boolean'
    ];

    public function __construct(array $attributes = [])
    {
        parent::__construct($attributes);
        self::creating(function($model) {
            if ($model->slug === null) {
                $model->slug = Str::slug($model->name);
            }
            if($model->user_id === null && ($user = app(UserAuthentication::class)->getUser()) !== null) {
                $model->user_id = $user->controlId();
            }
        });
    }

    public function moduleInstances()
    {
        return $this->hasMany(ModuleInstance::class);
    }

    public function scopeEnabled(Builder $query)
    {
        return $query->where('enabled', true);
    }
    
    public function forLogic()
    {
        return $this->belongsTo(Logic::class, 'for_logic');
    }

    public function adminLogic()
    {
        return $this->belongsTo(Logic::class, 'admin_logic');
    }

    public function scopeActive(Builder $query) {
        return $query
            ->where(['start_date' => null, 'end_date'=>null])
            ->orWhere([
                ['start_date', '<=', Carbon::now()],
                ['end_date', '>=', Carbon::now()]
            ]);
    }

    public function isCompletable(): bool {
        return $this->type === 'completable' || $this->type === 'multi-completable';
    }

    public function activityInstances()
    {
        return $this->hasMany(ActivityInstance::class);
    }

    public function user(): \BristolSU\ControlDB\Contracts\Models\User
    {
        if($this->user_id === null) {
            throw new \Exception(sprintf('Activity #%u is not owned by a user.', $this->id));
        }
        return app(User::class)->getById($this->user_id);
    }
}