Download the PHP package chriswillerton/searchable without Composer

On this page you can find all versions of the php package chriswillerton/searchable. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

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.
Please rate this library. Is it a good library?

Informations about the package searchable

Searchable

Searchable trait for Laravel Eloquent models.

This trait uses a full text search to search individual models. A results collection is provided to help sort multiple model searches by relevance.

Installation

Add the following to the composer.json file in your project:

"chriswillerton/searchable": "1.*"

or you can run the below on the command line in the root of your project:

composer require "chriswillerton/searchable" "1.*"

Setup

To get started, add the trait to the model:

use ChrisWillerton\Searchable\Searchable;

class YourModel extends Eloquent
{
    use Searchable;

    protected $full_text_index = 'title, content';

You also need to define the full text index that you've setup in your database. Add this as a property on your model called $full_text_index.

Usage

You can use searchable as below:

$results = YourModel::search('search term')
    ->orderBy('relevance', 'desc')
    ->get();

The collection is used for collecting multiple model search results together and making it easy to sort the whole collection by relevance. Imagine you have an Article, Post, and Product class, but you want results from all of these mixed together and sorted by relevance. You could do something like the below:

// Set which models we wish to search
$models_to_search = [
    Article::class,
    Post::class,
    Product::class
];

$term = 'search term';
$model_results = [];

// Loop through each model and perform the search query
foreach ($models_to_search as $model)
{
    $model_results[] = $model::search($term)
        ->get()
        ->toArray();
}

// Merge each result set together into a single array of results
$merged_results = array_merge(...$model_results);

// Add these results to a collection...
$collection = new ChrisWillerton\Searchable\SearchableResults($merged_results);

// and order them by relevance
$results = $collection->getByRelevance();

You should consider the performance impact of doing the above though. It's probably best to come up with a specific search solution if maximising performance is required.

All versions of searchable with dependencies

PHP Build Version
Package Version
Requires php Version >=5.4.0
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 chriswillerton/searchable contains the following files

Loading the files please wait ....