add basic search functionality via friendsofcake/search

Author: LordSimal

composer.json

@@ -9,6 +9,7 @@
         "cakephp/cakephp": "5.2.*",
         "cakephp/migrations": "^4.0.0",
         "cakephp/plugin-installer": "^2.0",
+        "friendsofcake/search": "^7.5",
         "knplabs/packagist-api": "^2.1",
         "mobiledetect/mobiledetectlib": "^4.8.03"
     },

composer.lock

@@ -5,13 +5,13 @@
  * Custom templates for pagination elements.
  */
 return [
-    'button' => '<button class="bg-red-800 p-2 text-white rounded-sm"{{attrs}}>{{text}}</button>',
+    'button' => '<button class="bg-red-800 hover:cursor-pointer p-2 text-white rounded-sm"{{attrs}}>{{text}}</button>',
     'checkbox' => '<input class="justify-self-start" type="checkbox" name="{{name}}" value="{{value}}"{{attrs}}>',
     'checkboxWrapper' => '<div class="col-span-2 col-start-2 flex gap-2">{{label}}</div>',
     'error' => '<div class="col-start-2 col-end-4 text-red-700" id="{{id}}">{{content}}</div>',
-    'input' => '<input class="col-span-2 border border-slate-500 rounded-sm max-w-md min-w-4 p-1" type="{{type}}" name="{{name}}"{{attrs}}>',
-    'inputContainer' => '<div class="group py-3 grid grid-cols-3 gap-2">{{content}}</div>',
-    'inputContainerError' => '<div class="group py-3 grid grid-cols-3 gap-2 text-red-700">{{content}}{{error}}</div>',
+    'input' => '<input class="col-span-2 border h-full border-slate-500 rounded-sm max-w-md min-w-4 p-2" type="{{type}}" name="{{name}}"{{attrs}}>',
+    'inputContainer' => '<div class="group gap-2">{{content}}</div>',
+    'inputContainerError' => '<div class="group gap-2 text-red-700">{{content}}{{error}}</div>',
     'label' => "<label class=\"group-has-[input:required]:after:content-['_*'] group-has-[input:required]:after:text-red-700\" {{attrs}}>{{text}}</label>",
     // Not actually a nested label.
     'nestingLabel' => "{{hidden}}<label class=\"group-has-[input:required]:after:content-['_*'] group-has-[input:required]:after:text-red-700\" {{attrs}}>{{text}}</label>{{input}}",

config/form-templates.php

@@ -33,4 +33,5 @@
     'Migrations' => ['onlyCli' => true],
 
     // Additional plugins here
+    'Search',
 ];

config/plugins.php

@@ -42,6 +42,7 @@ public function initialize(): void
         parent::initialize();
 
         $this->loadComponent('Flash');
+        $this->loadComponent('Search.Search');
 
         /*
          * Enable the following component for recommended CakePHP form protection settings.

src/Controller/AppController.php

@@ -17,7 +17,8 @@ class PackagesController extends AppController
      */
     public function index()
     {
-        $query = $this->Packages->find();
+        $query = $this->Packages
+            ->find('search', search: $this->request->getQueryParams());
         $packages = $this->paginate($query);
 
         $this->set(compact('packages'));

src/Controller/PackagesController.php

@@ -3,10 +3,9 @@
 
 namespace App\Model\Table;
 
-use Cake\ORM\Query\SelectQuery;
-use Cake\ORM\RulesChecker;
 use Cake\ORM\Table;
 use Cake\Validation\Validator;
+use Search\Manager;
 
 /**
  * Packages Model
@@ -40,6 +39,8 @@ public function initialize(array $config): void
         $this->setTable('packages');
         $this->setDisplayField('package');
         $this->setPrimaryKey('id');
+
+        $this->addBehavior('Search.Search');
     }
 
     /**
@@ -85,4 +86,25 @@ public function validationDefault(Validator $validator): Validator
 
         return $validator;
     }
+
+    /**
+     * @return \Search\Manager
+     */
+    public function searchManager(): Manager
+    {
+        /** @var \Search\Model\Behavior\SearchBehavior $search */
+        $search = $this->getBehavior('Search');
+        $searchManager = $search->searchManager();
+        $searchManager->add('search', 'Search.Like', [
+            'before' => true,
+            'after' => true,
+            'fieldMode' => 'OR',
+            'comparison' => 'LIKE',
+            'wildcardAny' => '*',
+            'wildcardOne' => '?',
+            'fields' => ['package', 'description'],
+        ]);
+
+        return $searchManager;
+    }
 }

src/Model/Table/PackagesTable.php

@@ -8,6 +8,12 @@
     <div>
         <div class="flex justify-between items-center my-8">
             <h3 class="text-xl"><?= __('Packages') ?></h3>
+            <?php
+            echo $this->Form->create(null, ['valueSources' => 'query', 'class' => 'flex gap-4']);
+            echo $this->Form->control('search', ['label' => false,]);
+            echo $this->Form->button('Search', ['type' => 'submit']);
+            echo $this->Form->end();
+            ?>
             <div class="flex gap-4">
                 <p><?= __('Sort by:') ?></p>
                 <div class="flex gap-4">