PHPackages jhormantasayco/laravel-searchzy - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Database & ORM](/categories/database) 4. / 5. jhormantasayco/laravel-searchzy ActiveLibrary[Database & ORM](/categories/database) jhormantasayco/laravel-searchzy =============================== Simple and lightweight search to eloquent models 2.1.1(5y ago)14155MITPHPPHP ^7.2|7.3|^8.0CI failing Since Jun 17Pushed 5y ago2 watchersCompare [ Source](https://github.com/jhormantasayco/laravel-searchzy)[ Packagist](https://packagist.org/packages/jhormantasayco/laravel-searchzy)[ Docs](https://github.com/jhormantasayco/laravel-searchzy)[ RSS](/packages/jhormantasayco-laravel-searchzy/feed)WikiDiscussions master Synced today READMEChangelog (7)Dependencies (6)Versions (8)Used By (0) Laravel Searchzy ================ [](#laravel-searchzy) [![Scrutinizer Code Quality](https://camo.githubusercontent.com/18a9033f9537ef0b03bc3bf0eba318998404d58c22c6309e1729e76f5b0337a4/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f6a686f726d616e7461736179636f2f6c61726176656c2d7365617263687a792f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/jhormantasayco/laravel-searchzy/?branch=master)[![Build Status](https://camo.githubusercontent.com/4f46cc58b9f8dbc1b0e939686f0430c036792760facfb1d303adabd5bcf1f827/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f6a686f726d616e7461736179636f2f6c61726176656c2d7365617263687a792f6261646765732f6275696c642e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/jhormantasayco/laravel-searchzy/build-status/master)[![Latest Stable on Packagist](https://camo.githubusercontent.com/e0d779fc9ab5bc83f56b0bfafa66fa6d8b75febbc9110067ae98c804c6b72300/68747470733a2f2f706f7365722e707567782e6f72672f6a686f726d616e7461736179636f2f6c61726176656c2d7365617263687a792f762f737461626c65)](https://packagist.org/packages/jhormantasayco/laravel-searchzy)[![Total Downloads](https://camo.githubusercontent.com/7731fecc167e6a15445daf8fd9b6f5a0696057a05293c21a89f918547a1c5ca8/68747470733a2f2f706f7365722e707567782e6f72672f6a686f726d616e7461736179636f2f6c61726176656c2d7365617263687a792f646f776e6c6f616473)](https://packagist.org/packages/jhormantasayco/laravel-searchzy)[![License](https://camo.githubusercontent.com/c9933c85eb09a4a8a81e9728b34feffa21f258d127afa7df22ff577af242ec6f/68747470733a2f2f706f7365722e707567782e6f72672f6a686f726d616e7461736179636f2f6c61726176656c2d7365617263687a792f6c6963656e7365)](https://packagist.org/packages/jhormantasayco/laravel-searchzy)[![Sonar Cloud](https://camo.githubusercontent.com/b3bca238018687d91b639b209868ed671da277f20b10399840476c635e3743a8/68747470733a2f2f736f6e6172636c6f75642e696f2f6170692f70726f6a6563745f6261646765732f6d6561737572653f70726f6a6563743d6a686f726d616e7461736179636f5f6c61726176656c2d7365617263687a79266d65747269633d616c6572745f737461747573)](https://sonarcloud.io/dashboard?id=jhormantasayco_laravel-searchzy) [![Quality gate](https://camo.githubusercontent.com/78684b9ac81e7c9370caf457140d3ef8c8f2250d93a209ec79a7047a918ded8a/68747470733a2f2f736f6e6172636c6f75642e696f2f6170692f70726f6a6563745f6261646765732f7175616c6974795f676174653f70726f6a6563743d6a686f726d616e7461736179636f5f6c61726176656c2d7365617263687a79)](https://sonarcloud.io/dashboard?id=jhormantasayco_laravel-searchzy) El package te permite buscar y filtrar registros de Eloquent Models en Laravel de una manera simple y sencilla. Compatible con la versión 6, 7, 8. Instalación ----------- [](#instalación) Puedes instalar el package vía composer de la siguiente manera: ``` composer require jhormantasayco/laravel-searchzy ``` Uso en los Models ----------------- [](#uso-en-los-models) Para añadir searchzy debes de hacer lo siguiente: 1. Usar el trait `Jhormantasayco\LaravelSearchzy\Searchzy` en tus Models. 2. Especificar mediante un array asociativo por medio de una propiedad o un método que retorne un array, donde se especifique las columnas que serán usadas por searchzy para la búsqueda y filtrado de los registros. Las keys del array representan el nombre de la variable que almacena la data del request y los values representan a las columnas o relaciones del Model. Para asociar una relación del Model se usa la siguiente nomenclatura `(relation:column)` como se describe en el siguiente ejemplo: ``` use Jhormantasayco\LaravelSearchzy\Searchzy; class MyModel extends Model { use Searchzy; /** * The attributes that are searchable via property. * * @var array */ protected $searchable = [ 'nombre' => 'name', 'dni' => 'code', 'telefono' => 'phone', 'correo' => 'email', 'post' => 'posts:title', 'descripcion' => 'posts:description', ]; /** * The attributes that are searchable via method. * * @return array */ public function searchableInputs(){ return [ 'nombre' => 'name', 'dni' => 'code', 'phone' => 'phone', 'email' => 'email', 'post' => 'posts:title', 'descripcion' => 'posts:description', ]; } /** * The attributes that are filterable via property. * * @var array */ protected $filterable = [ 'rol_id' => 'role_id', ]; /** * The attributes that are filterable via method. * * @return array */ public function filterableInputs(){ return [ 'rol_id' => 'role_id', ]; } } ``` ¿Propiedad o Método? -------------------- [](#propiedad-o-método) Puedes usar cualquiera de las vias que se presentan en el ejemplo, ya sea por medio de una propiedad o un método, todo funcionará sin problemas. Usa la forma con la cual te sientas más comodo. Uso en los Controllers ---------------------- [](#uso-en-los-controllers) Simplemente tienes que añadir el scope de searchzy en tus consultas para que se pueda realizar la búsqueda y filtrado de registros según los datos enviados en el request. Searchzy sólo trabajará con los datos cuyos nombres coincidan con lo descrito en los arrays asociativos del Model. ``` public function index(){ // Obtiene los inputs del request y sus respectivos valores. $params = Usuario::searchzyInputs(); // Implementación de searchzy en la consulta donde puedes seguir usando los demás métodos del Model con total normalidad. $oUsuarios = Usuario::withCount(['posts AS posts_count']) ->with(['posts']) ->searchzy() ->orderBy('name') ->paginate(); return view('welcome.index', compact('params', 'oUsuarios')); } ``` Uso en las Views ---------------- [](#uso-en-las-views) Para realizar la búsqueda de registros searchzy implementa una keyword que por defecto es `word`. La configuración se ubica en `config/searchzy.php` donde usted puede cambiar este valor según su necesidad. La implementar del campo de búsqueda se realiza de la siguiente manera ``` ``` Sí usas el package de `laravelcollective/html` la implementación sería la siguiente: ``` {!! Form::text(config('searchzy.keyword'), ${config('searchzy.keyword')}, [ 'class' => 'form-control', 'placeholder' => 'Buscar a un usuario por su nombre, dni, telefono, correo electrónico, titulo o descripción de sus posts' ]) !!} ``` Con esto ya podemos empezar a buscar nuestros registros con searchzy. Para los campos que son `filterable` se recomienda implementar un select por cada elemento del array. Ejemplo: ``` {!! Form::select('rol_id', UtilEnum::$ARR_ROLES, $rol_id, [ 'class' => 'form-control', ]) !!} ``` Nótese que el nombre del select debe de ser igual al definido en la keys del array en el Model. ### ¿Qué hemos logramos con esto? [](#qué-hemos-logramos-con-esto) - Evitar la sobrecarga de consultas de búsqueda (orWhere o whereHas) en los Controllers o Models del proyecto. - Dar un alias a las columnas y relaciones para realizar la búsqueda y filtrado de registros, evitando que cualquier persona que pudiera ver los parámetros en la url infiera el diseño y modelado de la base de datos. - Optimizar la consulta de búsqueda mediante el uso de subqueries generadas por el package. ### Requerimientos [](#requerimientos) - PHP 7.2 o superior. - Laravel 6.0 o superior. ### Demo [](#demo) Puedes ver una demo del package en los siguientes enlaces: - Demo: - Repositorio: ### Testing [](#testing) ``` ./vendor/bin/phpunit ./vendor/bin/phpcpd src ./vendor/bin/phpcs src ./vendor/bin/phpcbf src ./vendor/bin/phpstan analyse src ``` ### Changelog [](#changelog) Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently. Contributing ------------ [](#contributing) Please see [CONTRIBUTING](CONTRIBUTING.md) for details. ### Security [](#security) If you discover any security related issues, please email instead of using the issue tracker. Credits ------- [](#credits) - [Jhorman Alexander Tasayco](https://github.com/jhormantasayco) License ------- [](#license) The MIT License (MIT). Please see [License File](LICENSE.md) for more information. ### Health Score 31 — LowBetter than 66% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity17 Limited adoption so far Community8 Small or concentrated contributor base Maturity66 Established project with proven stability Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~40 days Recently: every ~61 days Total 7 Last Release 1964d ago Major Versions 1.1.2 → 2.0.02021-02-10 PHP version history (3 changes)1.0.0PHP ^7.1 1.1.0PHP ^7.2 2.0.0PHP ^7.2|7.3|^8.0 ### Community Maintainers ![](https://avatars.githubusercontent.com/u/14883451?v=4)[Jhorman Alexander Tasayco](/maintainers/jhormantasayco)[@jhormantasayco](https://github.com/jhormantasayco) --- Top Contributors [![jhormantasayco](https://avatars.githubusercontent.com/u/14883451?v=4)](https://github.com/jhormantasayco "jhormantasayco (19 commits)") --- Tags eloquentfilterlaravelphpsearchsearchlaraveleloquentBuscarjhormantasaycolaravel-searchzy ### Code Quality TestsPHPUnit Static AnalysisPHPStan Code StylePHP\_CodeSniffer Type Coverage Yes ### Embed Badge ![Health badge](/badges/jhormantasayco-laravel-searchzy/health.svg) ``` [![Health](https://phpackages.com/badges/jhormantasayco-laravel-searchzy/health.svg)](https://phpackages.com/packages/jhormantasayco-laravel-searchzy) ``` ### Alternatives [mongodb/laravel-mongodb A MongoDB based Eloquent model and Query builder for Laravel 7.1k8.4M96](/packages/mongodb-laravel-mongodb)[kirschbaum-development/eloquent-power-joins The Laravel magic applied to joins. 1.6k32.6M46](/packages/kirschbaum-development-eloquent-power-joins)[tucker-eric/eloquentfilter An Eloquent way to filter Eloquent Models 1.8k5.1M34](/packages/tucker-eric-eloquentfilter)[mohammad-fouladgar/eloquent-builder 526198.2k](/packages/mohammad-fouladgar-eloquent-builder)[mehdi-fathi/eloquent-filter Eloquent Filter adds custom filters automatically to your Eloquent Models in Laravel.It's easy to use and fully dynamic, just with sending the Query Strings to it. 448199.3k1](/packages/mehdi-fathi-eloquent-filter)[lemaur/eloquent-publishing 218.1k1](/packages/lemaur-eloquent-publishing) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)