Skip to content

A free open source IT asset/license management system

Added SavedSearch model + query builder

snipede548d75ce8b
diff --git a/app/Models/Builders/SavedSearchQueryBuilder.php b/app/Models/Builders/SavedSearchQueryBuilder.php
new file mode 100644
index 0000000000..cfdf75ff60
--- /dev/null
+++ b/app/Models/Builders/SavedSearchQueryBuilder.php
@@ -0,0 +1,34 @@
+<?php
+
+namespace App\Models\Builders;
+
+use App\Models\SavedSearch;
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Support\Facades\Auth;
+
+/**
+ * @template TModel of SavedSearch
+ *
+ * @extends Builder<TModel>
+ */
+class SavedSearchQueryBuilder extends Builder
+{
+ /**
+ * Records owned by the current authenticated user. Called from
+ * controllers and policies to keep the private-only semantics in
+ * one place.
+ */
+ public function ownedByCurrent(): self
+ {
+ return $this->where('created_by', Auth::id());
+ }
+
+ /**
+ * Records belonging to the given bs-table idTable. Combined with
+ * ownedByCurrent() to list a user's presets for one listing page.
+ */
+ public function forTable(string $tableName): self
+ {
+ return $this->where('table_name', $tableName);
+ }
+}
diff --git a/app/Models/SavedSearch.php b/app/Models/SavedSearch.php
new file mode 100644
index 0000000000..beb3d24f12
--- /dev/null
+++ b/app/Models/SavedSearch.php
@@ -0,0 +1,66 @@
+<?php
+
+namespace App\Models;
+
+use App\Models\Builders\SavedSearchQueryBuilder;
+use App\Rules\EloquentModelClass;
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Watson\Validating\ValidatingTrait;
+
+/**
+ * Named filter-preset for a listing page's advanced-search. Each
+ * record stores a URL query string captured from the advanced-search
+ * modal. Private to the creator for v1 (no sharing/default yet).
+ *
+ * @mixin IdeHelperSavedSearch
+ */
+class SavedSearch extends Model
+{
+ use HasFactory;
+ use ValidatingTrait;
+
+ protected $table = 'saved_searches';
+
+ protected $fillable = [
+ 'created_by',
+ 'table_name',
+ 'model',
+ 'name',
+ 'query_string',
+ ];
+
+ protected $rules = [
+ 'created_by' => 'required|integer',
+ 'table_name' => 'required|string|max:191',
+ 'model' => 'nullable|string|max:191',
+ 'name' => 'required|string|max:191',
+ 'query_string' => 'required|string|max:4096',
+ ];
+
+ public function getRules(): array
+ {
+ $rules = $this->rules;
+ $rules['model'] = ['nullable', 'string', 'max:191', new EloquentModelClass];
+
+ $createdBy = $this->created_by ?? 'NULL';
+ $tableName = $this->table_name ?? 'NULL';
+
+ $uniqueTail = ",NULL,id,created_by,{$createdBy},table_name,{$tableName}";
+ $rules['name'] .= '|unique:saved_searches,name'.$uniqueTail;
+ $rules['query_string'] .= '|unique:saved_searches,query_string'.$uniqueTail;
+
+ return $rules;
+ }
+
+ public function creator(): BelongsTo
+ {
+ return $this->belongsTo(User::class, 'created_by');
+ }
+
+ public function newEloquentBuilder($query): SavedSearchQueryBuilder
+ {
+ return new SavedSearchQueryBuilder($query);
+ }
+}