Download the PHP package thomasjsn/laravel-scout-elastic without Composer

On this page you can find all versions of the php package thomasjsn/laravel-scout-elastic. 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?

Example code of thomasjsn/laravel-scout-elastic

Informations about the package laravel-scout-elastic

Laravel Scout Elasticsearch Driver

Travis Packagist

This package provides an Elasticsearch driver for Laravel Scout.

Contents

Installation

You can install the package via composer:

You must add the Scout service provider and the package service provider in your app.php config:

Then you should publish the Elasticsearch configuration using the vendor:publish Artisan command.

Setting up Elasticsearch configuration

You must have a Elasticsearch server up and running, indices can be created with an Artisan command; see below.

After you've published the Laravel Scout package configuration:

Usage

Creating Elasticsearch indexes with proper mapping

You may define custom mappings for Elasticsearch fields in the config. See examples in the config file. If you prefer storing mappings in models, you may create a static public method mapping() in each particular model:

And then use it in the config file:

The document type, in this example articles must match searchableAs() for the respective model.

Elasticsearch can set default types to model fields on the first insert if you do not explicitly define them. However; sometimes the defaults are not what you're looking for, or you need to define additional mapping properties.

In that case, we strongly recommend creating indices with proper mappings before inserting any data. For that purpose, there is an Artisan command, called elastic:make-indices {index} which creates an index based on the settings in your configuration file.

To create all indices from your config just ignore the {index} parameter and run:

If the index exists you will be asked if you want to delete and recreate it, or you can use the --force flag.

To get information about your existing Elasticsearch indices you may want to use the following command:

Indexing data

You may follow instructions from the official Laravel Scout documentation to index your data.

Search

The package supports everything that is provided by Laravel Scout.

The Scout search method used the default query method defined in the config file.

Sorting with orderBy() method:

Elastic specific

However, to use the extra Elasticsearch features included in this package, use trait ElasticSearchable by adding it to your model instead of Searchable:

The package features:

1) The elasticSearch method, elasticSearch($method, $query, array $params = null):

Parameters are taken from the configuration, for the specific query method, if not supplied. But you may override them.

2) A separate Elasticsearch index for each model.

If you have defined several indices in your config file, you may choose which index a model belongs to by overriding searchableWithin() method in your model:

If you do not override searchableWithin() in your model, the first index from the config will be used.

Credits

License

The MIT License (MIT).

All versions of laravel-scout-elastic with dependencies

PHP Build Version
Package Version
Requires php Version >=5.6.4
laravel/scout Version ^3.0
elasticsearch/elasticsearch Version ^5.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 thomasjsn/laravel-scout-elastic contains the following files

Loading the files please wait ....