CompletionCondition.php

Go to the documentation of this file.

<?php

namespace BristolSU\Support\Completion\Contracts;

use BristolSU\Support\ActivityInstance\ActivityInstance;
use BristolSU\Support\ModuleInstance\Contracts\ModuleInstance;
use FormSchema\Schema\Form;
use FormSchema\Transformers\VFGTransformer;
use Illuminate\Contracts\Support\Arrayable;
use Illuminate\Contracts\Support\Jsonable;

abstract class CompletionCondition implements Arrayable, Jsonable
{
    private $moduleAlias;

    public function __construct(string $moduleAlias)
    {
        $this->moduleAlias = $moduleAlias;
    }

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

    public function percentage($settings, ActivityInstance $activityInstance, ModuleInstance $moduleInstance): int 
    {
        if ($this->isComplete($settings, $activityInstance, $moduleInstance)) {
            return 100;
        }
        return 0;
    }

    abstract public function isComplete($settings, ActivityInstance $activityInstance, ModuleInstance $moduleInstance): bool;

    abstract public function options(): Form;

    abstract public function name(): string;

    abstract public function description(): string;

    abstract public function alias(): string;

    public function toJson($options = 0)
    {
        return json_encode($this->toArray(), $options);
    }
    
    public function toArray()
    {
        return [
            'name' => $this->name(),
            'description' => $this->description(),
            'options' => (new VFGTransformer())->transformToArray($this->options()),
            'alias' => $this->alias()
        ];
    }
}