Download the PHP
package h-farm/laravel-searchable without Composer
On this page you can find all versions of the php package
h-farm/laravel-searchable. It is possible to download/install
these versions without Composer. Possible dependencies are resolved
automatically.
After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.
Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories.
In this case some credentials are needed to access such packages.
Please use the auth.json textarea to insert credentials, if a package is coming from a private repository.
You can look here for more information.
Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
To use Composer is sometimes complicated. Especially for beginners.
Composer needs much resources. Sometimes they are not available on a simple webspace.
If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
# Laravel Searchable 🔍
[](https://packagist.org/packages/maize-tech/laravel-searchable)
[](https://github.com/maize-tech/laravel-searchable/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/maize-tech/laravel-searchable/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[](https://packagist.org/packages/maize-tech/laravel-searchable)
Easily add weighted searches through model attributes and relationships.
This package currently supports `MySQL`, `PostgreSQL` and `SQLite` (see [SQLite support](#sqlite-support) for its requirements and differences).
## Installation
You can install the package via composer:
You can publish the config file with:
This is the content of the published config file:
## Usage
To use the package, add the `Maize\Searchable\HasSearch` trait to each model you want to make searchable.
Once done, you can implement the `getSearchableAttributes` abstract method by returning the list of attributes (or relationships' attributes) you want to search for.
You can also define the weight of each searchable attribute. If no weight is specified then `default_match_weight` will be taken from `config/searchable.php`.
Here's an example model including the `HasSearch` trait:
Now you can just search for a given term using the `scopeSearch` scope method:
That's all!
The package generates an SQL query with an 'or' condition for each search term and each searchable fields.
The given query returns all models matching the search terms.
Furthermore, search results are weighted, which means the query will be ordered by the most matching models.
If you don't want to order the search results by its match weight, you can set the `orderByWeight` flag to false:
## SQLite support
Plain columns, relationship attributes, raw expressions, weights and json attributes are all supported on SQLite, with the following requirements and differences:
- **JSON functions**: json attributes rely on the `json_extract` and `json_each` functions, which are built into SQLite since version 3.38 (older versions must be compiled with the JSON1 extension). The searched column must contain valid json or `NULL`, otherwise SQLite raises a `malformed JSON` error.
- **Json wildcard (`attribute.*`)**: the search is applied to the top level values of the json object only. Json keys are never matched. Nested objects and arrays are searched in their raw json form, where non-ASCII characters may be stored as escaped sequences (e.g. `\u00e0`) and are therefore not matched.
- **Case sensitivity**: SQLite's `LOWER` function and `LIKE` operator only fold ASCII characters. Searches are case insensitive for ASCII characters (`APPLE` matches `apple`), and lowercase non-ASCII characters are matched as is (both `cittĂ ` and `CITTĂ€` match a stored `CittĂ `). A stored uppercase non-ASCII character is never matched by its own letter though (neither `Ă bc` nor `Ă€BC` match a stored `Ă€BC`).
- **Accent sensitivity**: searches are accent sensitive (`citta` does not match `CittĂ `).
- **Whole json columns**: when a json column is searched as a plain attribute (`body` instead of `body.en` or `body.*`) the raw json text is searched, so escaped non-ASCII characters are not matched. Use a json key or the wildcard selector instead.
- **Raw expressions**: expressions are sent to the database as they are, so they must be valid SQLite. As an example, the `CONCAT` function is only available since SQLite 3.44: use the `||` operator on older versions.
- **Amount of results**: the keys of all matching models are bound to the final query, which is limited by SQLite's maximum number of bound parameters (32766 by default since SQLite 3.32).
## Testing
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](https://github.com/maize-tech/.github/blob/main/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](https://github.com/maize-tech/.github/security/policy) on how to report security vulnerabilities.
## Credits
- [Riccardo Dalla Via](https://github.com/riccardodallavia)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
All versions of laravel-searchable with dependencies
Composer command for our command line client (download client)This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free.Standard composer command
The package h-farm/laravel-searchable contains the following files
Loading the files please wait ...
Loading please wait ...
Before you can download the PHP files, the dependencies should be resolved. This can take some minutes. Please be patient.