Merge pull request #244 from yajra/column-control

feat: column control builder

Author: yajra

src/Html/Column.php

@@ -4,7 +4,7 @@
 
 use Illuminate\Support\Arr;
 use Illuminate\Support\Str;
-use Yajra\DataTables\Html\Options\Plugins\SearchPanes;
+use Yajra\DataTables\Html\Options\Plugins;
 
 /**
  * @property array|string $data
@@ -35,7 +35,8 @@
 class Column extends Fluent
 {
     use HasAuthorizations;
-    use SearchPanes;
+    use Plugins\ColumnControl;
+    use Plugins\SearchPanes;
 
     /**
      * @param  array  $attributes

src/Html/Editor/Fields/Options.php

@@ -28,6 +28,21 @@ public static function yesNo(): static
         return new static($data);
     }
 
+    /**
+     * Create options from an array.
+     *
+     * @param  array<array-key, string|int|float|array{label: string, value: mixed}>  $data
+     */
+    public static function from(array $data): static
+    {
+        $items = [];
+        foreach ($data as $key => $value) {
+            $items[] = is_array($value) ? $value : ['label' => $value, 'value' => $key];
+        }
+
+        return new static($items);
+    }
+
     /**
      * Get options from a model.
      *

src/Html/HasOptions.php

@@ -17,6 +17,7 @@ trait HasOptions
     use Options\Plugins\AutoFill;
     use Options\Plugins\Buttons;
     use Options\Plugins\ColReorder;
+    use Options\Plugins\ColumnControl;
     use Options\Plugins\FixedColumns;
     use Options\Plugins\FixedHeader;
     use Options\Plugins\KeyTable;

src/Html/Options/HasFeatures.php

@@ -68,11 +68,12 @@ public function lengthChange(bool $value = true): static
     /**
      * Set ordering option value.
      *
+     * @param  bool|array{indicators: bool, handler: bool}  $value
      * @return $this
      *
      * @see https://datatables.net/reference/option/ordering
      */
-    public function ordering(bool $value = true): static
+    public function ordering(bool|array $value = true): static
     {
         $this->attributes['ordering'] = $value;
 

src/Html/Options/Plugins/ColumnControl.php

@@ -0,0 +1,110 @@
+<?php
+
+namespace Yajra\DataTables\Html\Options\Plugins;
+
+/**
+ * DataTables - Column control plugin option builder.
+ *
+ * @see https://datatables.net/extensions/columncontrol/
+ * @see https://datatables.net/extensions/columncontrol/config
+ */
+trait ColumnControl
+{
+    /**
+     * Set column control options.
+     *
+     * @see https://www.datatables.net/extensions/columncontrol/
+     */
+    public function columnControl(array $options): static
+    {
+        $this->attributes['columnControl'] = $options;
+
+        return $this;
+    }
+
+    protected function addColumnControl(int|string $target, array $content): static
+    {
+        if (! isset($this->attributes['columnControl']) || ! is_array($this->attributes['columnControl'])) {
+            $this->attributes['columnControl'] = [];
+        }
+
+        // get existing target and merge content if exists
+        foreach ($this->attributes['columnControl'] as &$control) {
+            if (isset($control['target']) && $control['target'] === $target) {
+                $existingContent = $control['content'] ?? [];
+                $mergedContent = array_merge($existingContent, $content);
+
+                // Remove duplicates properly for mixed array types (strings and arrays)
+                $uniqueContent = [];
+                foreach ($mergedContent as $item) {
+                    $serialized = is_array($item) ? serialize($item) : $item;
+                    if (! in_array($serialized, array_map(fn ($i) => is_array($i) ? serialize($i) : $i, $uniqueContent))) {
+                        $uniqueContent[] = $item;
+                    }
+                }
+
+                $control['content'] = $uniqueContent;
+
+                return $this;
+            }
+        }
+
+        $this->attributes['columnControl'][] = ['target' => $target, 'content' => $content];
+
+        return $this;
+    }
+
+    public function columnControlHeader(array $content, int $target = 0): static
+    {
+        $this->addColumnControl('thead:'.$target, $content);
+
+        return $this;
+    }
+
+    public function columnControlFooter(array $content, int $target = 0): static
+    {
+        $this->addColumnControl('tfoot:'.$target, $content);
+
+        return $this;
+    }
+
+    public function columnControlFooterSearch(array $content = []): static
+    {
+        $this->addColumnControl('tfoot', [empty($content) ? ['search'] : $content]);
+
+        return $this;
+    }
+
+    public function columnControlSearchDropdown(int|string $target = 0): static
+    {
+        $this->addColumnControl($target, ['order', 'searchDropdown'])
+            ->ordering(['indicators' => false, 'handler' => false]);
+
+        return $this;
+    }
+
+    public function columnControlSearch(?array $content = null, int|string $target = 1): static
+    {
+        $this->addColumnControl($target, $content ?? ['search']);
+
+        return $this;
+    }
+
+    public function columnControlSpacer(int|string $target = 1): static
+    {
+        $this->addColumnControl($target, [['extend' => 'spacer']]);
+
+        return $this;
+    }
+
+    public function columnControlTitle(null|string|array $title = null, int|string $target = 1): static
+    {
+        if (is_array($title)) {
+            $this->addColumnControl($target, [['extend' => 'title', ...$title]]);
+        } else {
+            $this->addColumnControl($target, [['extend' => 'title', 'text' => $title]]);
+        }
+
+        return $this;
+    }
+}