Download the PHP package jzpeepz/eloquent-search without Composer
On this page you can find all versions of the php package jzpeepz/eloquent-search. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download jzpeepz/eloquent-search
More information about jzpeepz/eloquent-search
Files in jzpeepz/eloquent-search
Package eloquent-search
Short Description Simple searching of all the Eloquent models in your project
License MIT
Homepage https://github.com/jzpeepz/eloquent-search
FAQ
Example:
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 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.
Informations about the package eloquent-search
Very short description of the package
This is where your description should go. Try and limit it to a paragraph or two, and maybe throw in a mention of what PSRs you support to avoid any confusion with users and contributors.
Installation
You can install the package via composer:
Publish the config file:
Publish the views so you can customize:
You might need to copy this route to your routes file if you need to add middleware or customize the search uri:
Include the search box in your views:
Usage
Getting Started
To make a model searchable, it needs to use the App\Traits\Searchable trait.
All searchable models must also be included in the config/eloquent-search.php file. This allows search abstracts to be generated with the command below.
NOTE: An exception will be thrown if any searchable models do not have url() or getSearchDescription() methods. See the customization section for more on those methods.
Initializing Search
Run the following command to initialize search abstracts for all searchable models.
php artisan search:init
Customization
What Gets Searched
By default, all attributes in the model will get lumped into the abstract that is searched.
To customize what gets searched, override the getSearchAbstract() method to return a string that should be searched.
Search Results
Description (required)
Add a getSearchDescription() method to your model that returns the description you would like.
URL (required)
Add a url() method to your model. This provides the URL that is linked to in search.
Title
By default, Searchable will attempt to determine a good title for the result.
To customize, override the getSearchTitle() method on your model.
Testing
Changelog
Please see CHANGELOG for more information what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
- Jonathan Peoples
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
Laravel Package Boilerplate
This package was generated using the Laravel Package Boilerplate.
