opnform/app/Models/Forms/Form.php

<?php

namespace App\Models\Forms;

use App\Events\Models\FormCreated;
use App\Models\Integration\FormZapierWebhook;
use App\Models\User;
use App\Models\Workspace;
use Database\Factories\FormFactory;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;
use Spatie\Sluggable\HasSlug;
use Spatie\Sluggable\SlugOptions;
use Stevebauman\Purify\Facades\Purify;
use Illuminate\Support\Facades\DB;

class Form extends Model
{
    const DARK_MODE_VALUES = ['auto', 'light', 'dark'];
    const THEMES = ['default', 'simple', 'notion'];
    const WIDTHS = ['centered', 'full'];

    use HasFactory, HasSlug, SoftDeletes;

    protected $fillable = [
        'workspace_id',
        'creator_id',
        'properties',
        'removed_properties',

        // Notifications
        'notifies',
        'notification_emails',
        'send_submission_confirmation',
        'notification_sender',
        'notification_subject',
        'notification_body',
        'notifications_include_submission',

        // integrations
        'webhook_url',

        'title',
        'description',
        'tags',

        // Customization
        'theme',
        'width',
        'cover_picture',
        'logo_picture',
        'dark_mode',
        'color',
        'uppercase_labels',
        'no_branding',
        'hide_title',
        'transparent_background',

        // Custom Code
        'custom_code',

        // Submission
        'submit_button_text',
        'database_fields_update',
        're_fillable',
        're_fill_button_text',
        'submitted_text',
        'redirect_url',
        'use_captcha',
        'closes_at',
        'closed_text',
        'max_submissions_count',
        'max_submissions_reached_text',

        // Security & Privacy
        'can_be_indexed',
        'password'
    ];

    protected $casts = [
        'properties' => 'array',
        'database_fields_update' => 'array',
        'closes_at' => 'datetime',
        'tags' => 'array',
        'removed_properties' => 'array'
    ];

    protected $appends = [
        'share_url',
        'is_pro'
    ];

    protected $hidden = [
        'workspace_id',
        'notifies',
        'webhook_url',
        'send_submission_confirmation',
        'redirect_url',
        'database_fields_update',
        'notification_sender',
        'notification_subject',
        'notification_body',
        'notifications_include_submission',
        'password',
        'tags',
        'notification_emails',
        'removed_properties'
    ];

    /**
     * The event map for the model.
     *
     * @var array
     */
    protected $dispatchesEvents = [
        'created' => FormCreated::class,
    ];

    public function getIsProAttribute()
    {
        return optional($this->workspace)->is_pro;
    }

    public function getShareUrlAttribute()
    {
        return url('/forms/'.$this->slug);
    }

    public function getSubmissionsCountAttribute()
    {
        return $this->submissions()->count();
    }

    public function getViewsCountAttribute()
    {
        return $this->views()->count() +
            $this->statistics()->sum(DB::raw("cast(data->>'views' as integer)"));
    }

    public function setDescriptionAttribute($value)
    {
        // Strip out unwanted html
        $this->attributes['description'] = Purify::clean($value);
    }

    public function setSubmittedTextAttribute($value)
    {
        // Strip out unwanted html
        $this->attributes['submitted_text'] = Purify::clean($value);
    }

    public function getIsClosedAttribute()
    {
        return ($this->closes_at && now()->gt($this->closes_at));
    }

    public function getMaxNumberOfSubmissionsReachedAttribute()
    {
        return ($this->max_submissions_count && $this->max_submissions_count <= $this->submissions_count);
    }

    public function setClosedTextAttribute($value)
    {
        $this->attributes['closed_text'] = Purify::clean($value);
    }

    public function setMaxSubmissionsReachedTextAttribute($value)
    {
        $this->attributes['max_submissions_reached_text'] = Purify::clean($value);
    }

    public function getHasPasswordAttribute()
    {
        return !empty($this->password);
    }

    /**
     * Relationships
     */
    public function workspace()
    {
        return $this->belongsTo(Workspace::class);
    }

    public function creator()
    {
        return $this->belongsTo(User::class, 'creator_id');
    }

    public function submissions()
    {
        return $this->hasMany(FormSubmission::class);
    }

    public function views()
    {
        return $this->hasMany(FormView::class);
    }

    public function statistics()
    {
        return $this->hasMany(FormStatistic::class);
    }

    public function zappierHooks()
    {
        return $this->hasMany(FormZapierWebhook::class);
    }

    /**
     * Config/options
     */
    public function getSlugOptions(): SlugOptions
    {
        return SlugOptions::create()
            ->doNotGenerateSlugsOnUpdate()
            ->generateSlugsFrom('title')
            ->saveSlugsTo('slug');
    }

    public static function newFactory()
    {
        return FormFactory::new();
    }
}