UserEmailIs.php

Go to the documentation of this file.

<?php

namespace BristolSU\Support\Filters\Filters\User;

use BristolSU\Support\Filters\Contracts\Filters\UserFilter;
use FormSchema\Generator\Field;
use FormSchema\Schema\Form;

class UserEmailIs extends UserFilter
{

    public function options(): Form
    {
        return \FormSchema\Generator\Form::make()->withField(
            Field::input('email')->inputType('email')->label('User Email')
                ->required(true)->placeholder('Email of the user')
        )->getSchema();
    }

    public function evaluate($settings): bool
    {
        try {
            return $this->user()->data()->email() === $settings['email'];
        } catch (\Exception $e) {
            return false;
        }        
    }

    public function name()
    {
        return 'User has Email';
    }

    public function description()
    {
        return 'User has a given email address';
    }

    public function alias()
    {
        return 'user_email_is';
    }
}