opnform/app/Models/Forms/Form.php

316 lines
7.8 KiB
PHP
Raw Normal View History

2022-09-20 19:59:52 +00:00
<?php
namespace App\Models\Forms;
use App\Events\Models\FormCreated;
use App\Models\Integration\FormZapierWebhook;
use App\Models\Traits\CachableAttributes;
use App\Models\Traits\CachesAttributes;
2022-09-20 19:59:52 +00:00
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 Illuminate\Support\Str;
2022-09-20 19:59:52 +00:00
use Spatie\Sluggable\HasSlug;
use Spatie\Sluggable\SlugOptions;
use Stevebauman\Purify\Facades\Purify;
use Illuminate\Support\Facades\DB;
2023-10-13 09:43:53 +00:00
use Illuminate\Database\Eloquent\Casts\Attribute;
2022-09-20 19:59:52 +00:00
class Form extends Model implements CachableAttributes
2022-09-20 19:59:52 +00:00
{
use CachesAttributes;
2022-09-20 19:59:52 +00:00
const DARK_MODE_VALUES = ['auto', 'light', 'dark'];
const THEMES = ['default', 'simple', 'notion'];
const WIDTHS = ['centered', 'full'];
2023-02-19 12:11:50 +00:00
const VISIBILITY = ['public', 'draft', 'closed'];
2022-09-20 19:59:52 +00:00
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',
'slack_webhook_url',
'discord_webhook_url',
'notification_settings',
2022-09-20 19:59:52 +00:00
// integrations
'webhook_url',
'title',
'description',
'tags',
'visibility',
2022-09-20 19:59:52 +00:00
// Customization
'custom_domain',
2022-09-20 19:59:52 +00:00
'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',
'editable_submissions',
'editable_submissions_button_text',
2023-04-12 11:17:05 +00:00
'confetti_on_submission',
'auto_save',
2022-09-20 19:59:52 +00:00
// Security & Privacy
'can_be_indexed',
'password',
// Custom SEO
'seo_meta'
2022-09-20 19:59:52 +00:00
];
protected $casts = [
'properties' => 'array',
'database_fields_update' => 'array',
'closes_at' => 'datetime',
'tags' => 'array',
'removed_properties' => 'array',
'seo_meta' => 'object',
'notification_settings' => 'object'
2022-09-20 19:59:52 +00:00
];
protected $appends = [
'share_url',
];
protected $hidden = [
'workspace_id',
'notifies',
'slack_webhook_url',
'discord_webhook_url',
2022-09-20 19:59:52 +00:00
'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'
];
protected $cachableAttributes = [
'is_pro',
'submissions_count',
'views_count',
];
2022-09-20 19:59:52 +00:00
/**
* The event map for the model.
*
* @var array
*/
protected $dispatchesEvents = [
'created' => FormCreated::class,
];
public function getIsProAttribute()
{
return $this->remember('is_pro', 15, function(): bool {
return optional($this->workspace)->is_pro;
});
2022-09-20 19:59:52 +00:00
}
public function getShareUrlAttribute()
{
if ($this->custom_domain) {
return 'https://' . $this->custom_domain . '/forms/' . $this->slug;
}
return url('/forms/' . $this->slug);
2022-09-20 19:59:52 +00:00
}
public function getEditUrlAttribute()
{
return url('/forms/' . $this->slug . '/show');
}
2022-09-20 19:59:52 +00:00
public function getSubmissionsCountAttribute()
{
return $this->remember('submissions_count', 5, function(): int {
return $this->submissions()->count();
});
2022-09-20 19:59:52 +00:00
}
public function getViewsCountAttribute()
{
return $this->remember('views_count', 5, function(): int {
if (env('DB_CONNECTION') == 'mysql') {
return (int)($this->views()->count() +
$this->statistics()->sum(DB::raw("json_extract(data, '$.views')")));
}
return $this->views()->count() +
$this->statistics()->sum(DB::raw("cast(data->>'views' as integer)"));
});
2022-09-20 19:59:52 +00:00
}
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);
}
2022-10-27 21:31:05 +00:00
public function setTagsAttribute($value)
{
2022-11-01 13:43:14 +00:00
if ($value == '') {
$value = null;
2022-10-27 21:31:05 +00:00
}
$this->attributes['tags'] = json_encode($value);
}
2022-09-20 19:59:52 +00:00
public function getIsClosedAttribute()
{
return ($this->closes_at && now()->gt($this->closes_at));
}
public function getFormPendingSubmissionKeyAttribute()
{
if ($this->updated_at?->timestamp) {
return "openform-" . $this->id . "-pending-submission-" . substr($this->updated_at?->timestamp, -6);
}
return null;
}
2022-09-20 19:59:52 +00:00
public function getMaxNumberOfSubmissionsReachedAttribute()
{
$this->disableCache('submissions_count');
2022-09-20 19:59:52 +00:00
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);
}
protected function removedProperties(): Attribute
{
2023-10-13 09:43:53 +00:00
return Attribute::make(
get: function ($value) {
return $value ? json_decode($value, true) : [];
}
);
2023-10-13 08:05:10 +00:00
}
2022-09-20 19:59:52 +00:00
/**
* 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(function (Form $form) {
return $form->title . ' ' . Str::random(6);
})
2022-09-20 19:59:52 +00:00
->saveSlugsTo('slug');
}
public static function newFactory()
{
return FormFactory::new();
}
public function getNotifiesWebhookAttribute()
{
return !empty($this->webhook_url);
}
public function getNotifiesDiscordAttribute()
{
return !empty($this->discord_webhook_url);
}
public function getNotifiesSlackAttribute()
{
return !empty($this->slack_webhook_url);
}
2022-09-20 19:59:52 +00:00
}