Filter.php

Go to the documentation of this file.

<?php


namespace BristolSU\Support\Filters\Contracts\Filters;


use BristolSU\ControlDB\Contracts\Models\Group;
use BristolSU\ControlDB\Contracts\Models\Role;
use BristolSU\ControlDB\Contracts\Models\User;
use FormSchema\Schema\Form as FormSchema;
use FormSchema\Transformers\VFGTransformer;
use Illuminate\Contracts\Support\Arrayable;

abstract class Filter implements Arrayable
{

    abstract public function model();

    abstract public function options(): FormSchema;

    abstract public function hasModel(): bool;

    abstract public function setModel($model);

    abstract public function evaluate($settings): bool;

    abstract public function name();

    abstract public function description();

    abstract public function alias();

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


}