ModuleInstance.php

Go to the documentation of this file.

<?php

namespace BristolSU\Support\ModuleInstance;

use BristolSU\ControlDB\Contracts\Repositories\User;
use BristolSU\Support\Action\ActionInstance;
use BristolSU\Support\Activity\Activity;
use BristolSU\Support\Authentication\Contracts\Authentication;
use BristolSU\Support\Completion\CompletionConditionInstance;
use BristolSU\Support\Logic\Logic;
use BristolSU\Support\ModuleInstance\Connection\ModuleInstanceService;
use BristolSU\Support\ModuleInstance\Contracts\ModuleInstance as ModuleInstanceContract;
use BristolSU\Support\Permissions\Models\ModuleInstancePermission;
use BristolSU\Support\ModuleInstance\Settings\ModuleInstanceSetting;
use BristolSU\Support\Revision\HasRevisions;
use BristolSU\Support\User\Contracts\UserAuthentication;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\ModelNotFoundException;
use Illuminate\Support\Str;

class ModuleInstance extends Model implements ModuleInstanceContract
{
    use HasRevisions;
    
    protected $fillable = [
        'alias',
        'activity_id',
        'name',
        'slug',
        'description',
        'active',
        'visible',
        'mandatory',
        'completion_condition_instance_id',
        'enabled',
        'user_id',
        'order',
        'grouping_id'
    ];

    protected $casts = [
        '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 alias()
    {
        return $this->alias;
    }

    public function id()
    {
        return $this->id;
    }

    public function activity()
    {
        return $this->belongsTo(Activity::class);
    }

    public function moduleInstanceSettings()
    {
        return $this->hasMany(ModuleInstanceSetting::class);
    }

    public function moduleInstancePermissions()
    {
        return $this->hasMany(ModuleInstancePermission::class);
    }

    public function completionConditionInstance()
    {
        return $this->belongsTo(CompletionConditionInstance::class);
    }

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

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

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

    public function actionInstances()
    {
        return $this->hasMany(ActionInstance::class);
    }

    public function moduleInstanceServices()
    {
        return $this->hasMany(ModuleInstanceService::class);
    }

    public function setting($key, $default = null)
    {
        try {
            return $this->moduleInstanceSettings()->where('key', $key)->firstOrFail()->value;
        } catch (ModelNotFoundException $e) {
            return $default;
        }
    }

    public function scopeEnabled(Builder $query)
    {
        return $query->where('enabled', true);
    }

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

    public function grouping()
    {
        return $this->belongsTo(ModuleInstanceGrouping::class);
    }
}