Merge pull request #232 from yajra/tags

yajra · web-flow · commit dd40155980a0 · 2025-01-09T22:59:26.000+08:00
feat: add tags field support
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -10,9 +10,8 @@ parameters:
 
     ignoreErrors:
         - '#Unsafe usage of new static\(\).#'
+        - identifier: missingType.generics
+        - identifier: missingType.iterableValue
 
     excludePaths:
-
-    checkMissingIterableValueType: false
-
-    checkGenericClassInNonGenericObjectType: false
+        - ./src/Html/Fluent.php
diff --git a/src/Html/Editor/Fields/Tags.php b/src/Html/Editor/Fields/Tags.php
@@ -0,0 +1,143 @@
+<?php
+
+namespace Yajra\DataTables\Html\Editor\Fields;
+
+use Illuminate\Contracts\Support\Arrayable;
+
+/**
+ * @see https://editor.datatables.net/reference/field/tags
+ */
+class Tags extends Field
+{
+    protected string $type = 'tags';
+
+    /**
+     * @see https://editor.datatables.net/reference/field/tags#ajax
+     */
+    public function ajax(bool|string|null $url = true): static
+    {
+        $this->attributes['ajax'] = $url;
+
+        return $this;
+    }
+
+    /**
+     * @see https://editor.datatables.net/reference/field/tags#display
+     */
+    public function display(string $display): static
+    {
+        $this->attributes['display'] = $display;
+
+        return $this;
+    }
+
+    /**
+     * @see https://editor.datatables.net/reference/field/tags#escapeLabelHtml
+     */
+    public function escapeLabelHtml(bool $escape): static
+    {
+        $this->attributes['escapeLabelHtml'] = $escape;
+
+        return $this;
+    }
+
+    /**
+     * @see https://editor.datatables.net/reference/field/tags#i18n
+     */
+    public function i18n(array $i18n): static
+    {
+        $options = isset($this->attributes['i18n'])
+            ? (array) $this->attributes['i18n']
+            : [];
+
+        $this->attributes['i18n'] = array_merge($options, $i18n);
+
+        return $this;
+    }
+
+    /**
+     * @see https://editor.datatables.net/reference/field/tags#i18n
+     */
+    public function addButton(string $text): static
+    {
+        return $this->i18n(['addButton' => $text]);
+    }
+
+    /**
+     * @see https://editor.datatables.net/reference/field/tags#i18n
+     */
+    public function inputPlaceholder(string $text): static
+    {
+        return $this->i18n(['inputPlaceholder' => $text]);
+    }
+
+    /**
+     * @see https://editor.datatables.net/reference/field/tags#i18n
+     */
+    public function noResults(string $text): static
+    {
+        return $this->i18n(['noResults' => $text]);
+    }
+
+    /**
+     * @see https://editor.datatables.net/reference/field/tags#i18n
+     */
+    public function title(string $text): static
+    {
+        return $this->i18n(['title' => $text]);
+    }
+
+    /**
+     * @see https://editor.datatables.net/reference/field/tags#i18n
+     */
+    public function placeholder(string $text): static
+    {
+        return $this->i18n(['placeholder' => $text]);
+    }
+
+    /**
+     * @see https://editor.datatables.net/reference/field/tags#limit
+     */
+    public function limit(int $limit): static
+    {
+        $this->attributes['limit'] = $limit;
+
+        return $this;
+    }
+
+    /**
+     * @see https://editor.datatables.net/reference/field/tags#multiple
+     */
+    public function multiple(bool $multiple = true): static
+    {
+        $this->attributes['multiple'] = $multiple;
+
+        return $this;
+    }
+
+    /**
+     * @see https://editor.datatables.net/reference/field/tags#options
+     */
+    public function options(array|Arrayable $options): static
+    {
+        return parent::options($options);
+    }
+
+    /**
+     * @see https://editor.datatables.net/reference/field/tags#separator
+     */
+    public function separator(string $separator = ','): static
+    {
+        return parent::separator($separator);
+    }
+
+    /**
+     * @see https://editor.datatables.net/reference/field/tags#unique
+     */
+    public function unique(bool $unique = true): static
+    {
+        $this->attributes['unique'] = $unique;
+
+        return $this;
+    }
+}
diff --git a/tests/Html/Builder/BuilderOptionsLanguageTest.php b/tests/Html/Builder/BuilderOptionsLanguageTest.php
@@ -1,8 +1,9 @@
 <?php
 
-namespace Yajra\DataTables\Html\Tests;
+namespace Yajra\DataTables\Html\Tests\Html\Builder;
 
 use PHPUnit\Framework\Attributes\Test;
+use Yajra\DataTables\Html\Tests\TestCase;
 
 class BuilderOptionsLanguageTest extends TestCase
 {
diff --git a/tests/Html/Builder/BuilderOptionsPluginsTest.php b/tests/Html/Builder/BuilderOptionsPluginsTest.php
@@ -1,11 +1,12 @@
 <?php
 
-namespace Yajra\DataTables\Html\Tests;
+namespace Yajra\DataTables\Html\Tests\Html\Builder;
 
 use PHPUnit\Framework\Attributes\Test;
 use Yajra\DataTables\Html\Builder;
 use Yajra\DataTables\Html\Button;
 use Yajra\DataTables\Html\SearchPane;
+use Yajra\DataTables\Html\Tests\TestCase;
 
 class BuilderOptionsPluginsTest extends TestCase
 {
diff --git a/tests/Html/Builder/BuilderOptionsTest.php b/tests/Html/Builder/BuilderOptionsTest.php
@@ -1,10 +1,11 @@
 <?php
 
-namespace Yajra\DataTables\Html\Tests;
+namespace Yajra\DataTables\Html\Tests\Html\Builder;
 
 use PHPUnit\Framework\Attributes\Test;
 use Yajra\DataTables\Html\Builder;
 use Yajra\DataTables\Html\Column;
+use Yajra\DataTables\Html\Tests\TestCase;
 
 class BuilderOptionsTest extends TestCase
 {
diff --git a/tests/Html/Builder/BuilderTest.php b/tests/Html/Builder/BuilderTest.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Yajra\DataTables\Html\Tests;
+namespace Yajra\DataTables\Html\Tests\Html\Builder;
 
 use Illuminate\Support\HtmlString;
 use PHPUnit\Framework\Attributes\Test;
@@ -9,6 +9,7 @@
 use Yajra\DataTables\Html\ColumnDefinition;
 use Yajra\DataTables\Html\ColumnDefinitions;
 use Yajra\DataTables\Html\Editor\Editor;
+use Yajra\DataTables\Html\Tests\TestCase;
 
 class BuilderTest extends TestCase
 {
diff --git a/tests/Html/Builder/LayoutTest.php b/tests/Html/Builder/LayoutTest.php
@@ -1,13 +1,14 @@
 <?php
 
-namespace Yajra\DataTables\Html\Tests;
+namespace Yajra\DataTables\Html\Tests\Html\Builder;
 
 use InvalidArgumentException;
 use Livewire\Exceptions\ComponentNotFoundException;
 use PHPUnit\Framework\Attributes\Test;
 use Yajra\DataTables\Html\Builder;
 use Yajra\DataTables\Html\Enums\LayoutPosition;
 use Yajra\DataTables\Html\Layout;
+use Yajra\DataTables\Html\Tests\TestCase;
 use Yajra\DataTables\Html\Tests\TestComponents\TestInlineView;
 use Yajra\DataTables\Html\Tests\TestComponents\TestLivewire;
 use Yajra\DataTables\Html\Tests\TestComponents\TestView;
diff --git a/tests/Html/Column/ColumnDefinitionTest.php b/tests/Html/Column/ColumnDefinitionTest.php
@@ -1,9 +1,10 @@
 <?php
 
-namespace Yajra\DataTables\Html\Tests;
+namespace Yajra\DataTables\Html\Tests\Html\Column;
 
 use PHPUnit\Framework\Attributes\Test;
 use Yajra\DataTables\Html\ColumnDefinition;
+use Yajra\DataTables\Html\Tests\TestCase;
 
 class ColumnDefinitionTest extends TestCase
 {
diff --git a/tests/Html/Column/ColumnTest.php b/tests/Html/Column/ColumnTest.php
@@ -1,9 +1,10 @@
 <?php
 
-namespace Yajra\DataTables\Html\Tests;
+namespace Yajra\DataTables\Html\Tests\Html\Column;
 
 use PHPUnit\Framework\Attributes\Test;
 use Yajra\DataTables\Html\Column;
+use Yajra\DataTables\Html\Tests\TestCase;
 
 class ColumnTest extends TestCase
 {
diff --git a/tests/Html/Editor/EditorFormOptionsTest.php b/tests/Html/Editor/EditorFormOptionsTest.php
@@ -1,9 +1,10 @@
 <?php
 
-namespace Yajra\DataTables\Html\Tests;
+namespace Yajra\DataTables\Html\Tests\Html\Editor;
 
 use PHPUnit\Framework\Attributes\Test;
 use Yajra\DataTables\Html\Editor\FormOptions;
+use Yajra\DataTables\Html\Tests\TestCase;
 
 class EditorFormOptionsTest extends TestCase
 {
diff --git a/tests/Html/Editor/EditorTest.php b/tests/Html/Editor/EditorTest.php
@@ -1,10 +1,11 @@
 <?php
 
-namespace Yajra\DataTables\Html\Tests;
+namespace Yajra\DataTables\Html\Tests\Html\Editor;
 
 use PHPUnit\Framework\Attributes\Test;
 use Yajra\DataTables\Html\Editor\Editor;
 use Yajra\DataTables\Html\Editor\Fields\Text;
+use Yajra\DataTables\Html\Tests\TestCase;
 
 class EditorTest extends TestCase
 {
diff --git a/tests/Html/Editor/Fields/FieldOptionsTest.php b/tests/Html/Editor/Fields/FieldOptionsTest.php
@@ -1,12 +1,13 @@
 <?php
 
-namespace Yajra\DataTables\Html\Tests;
+namespace Yajra\DataTables\Html\Tests\Html\Editor\Fields;
 
 use Illuminate\Foundation\Testing\DatabaseTransactions;
 use Illuminate\Support\Facades\DB;
 use PHPUnit\Framework\Attributes\Test;
 use Yajra\DataTables\Html\Editor\Fields\Options;
 use Yajra\DataTables\Html\Tests\Models\User;
+use Yajra\DataTables\Html\Tests\TestCase;
 
 class FieldOptionsTest extends TestCase
 {
diff --git a/tests/Html/Editor/Fields/FieldTest.php b/tests/Html/Editor/Fields/FieldTest.php
@@ -1,10 +1,11 @@
 <?php
 
-namespace Yajra\DataTables\Html\Tests;
+namespace Yajra\DataTables\Html\Tests\Html\Editor\Fields;
 
 use PHPUnit\Framework\Attributes\Test;
 use Yajra\DataTables\Html\Editor\Fields;
 use Yajra\DataTables\Html\Tests\Models\User;
+use Yajra\DataTables\Html\Tests\TestCase;
 
 class FieldTest extends TestCase
 {
diff --git a/tests/Html/Editor/Fields/TagsTest.php b/tests/Html/Editor/Fields/TagsTest.php
diff --git a/tests/Html/Extensions/SearchPaneTest.php b/tests/Html/Extensions/SearchPaneTest.php

Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,9 @@`
`1`	`1`	`<?php`
`2`	`2`
`3`		`-namespace Yajra\DataTables\Html\Tests;`
	`3`	`+namespace Yajra\DataTables\Html\Tests\Html\Builder;`
`4`	`4`
`5`	`5`	`use PHPUnit\Framework\Attributes\Test;`
	`6`	`+use Yajra\DataTables\Html\Tests\TestCase;`
`6`	`7`
`7`	`8`	`class BuilderOptionsLanguageTest extends TestCase`
`8`	`9`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,10 @@`
`1`	`1`	`<?php`
`2`	`2`
`3`		`-namespace Yajra\DataTables\Html\Tests;`
	`3`	`+namespace Yajra\DataTables\Html\Tests\Html\Column;`
`4`	`4`
`5`	`5`	`use PHPUnit\Framework\Attributes\Test;`
`6`	`6`	`use Yajra\DataTables\Html\ColumnDefinition;`
	`7`	`+use Yajra\DataTables\Html\Tests\TestCase;`
`7`	`8`
`8`	`9`	`class ColumnDefinitionTest extends TestCase`
`9`	`10`	`{`