README

Laravel ManticoreSearch plugin

An easy way to use the official ManticoreSearch client in your Laravel or Lumen applications.

composer require psagnataf/laravel-manticoresearch

Laravel

The package's service provider will automatically register its service provider.

Publish the configuration file:

php artisan vendor:publish --provider="ManticoreSearch\Laravel\ServiceProvider"

Alternative configuration method via .env file

After you publish the configuration file as suggested above, you may configure ManticoreSearch by adding the following to your application's .env file (with appropriate values):

MANTICORESEARCH_HOST=localhost
MANTICORESEARCH_PORT=9200
MANTICORESEARCH_TRANSPORT=Http
MANTICORESEARCH_USER=
MANTICORESEARCH_PASS=

Lumen

If you work with Lumen, please register the service provider and configuration in bootstrap/app.php:

$app->register(ManticoreSearch\Laravel\ServiceProvider::class);
$app->configure('manticoresearch');

Manually copy the configuration file to your application.

How to use

The ManticoreSearch facade is just an entry point into the ManticoreSearch client, so previously you might have used:

require_once __DIR__ . '/vendor/autoload.php';

$config = ['host'=>'127.0.0.1', 'port'=>9308];
$client = new \Manticoresearch\Client($config);
$index = new \Manticoresearch\Index($client);
$index->setName('movies');

Instead of these few lines above you can use single line solution:

$index = ManticoreSearch::index('movies');

That will run the command on the default connection. You can run a command on any connection (see the defaultConnection setting and connections array in the configuration file).

$index = ManticoreSearch::connection('connectionName')->index($nameOfIndex);
$pq = ManticoreSearch::connection('connectionName')->pq();
$cluster = ManticoreSearch::connection('connectionName')->cluster();
$indices = ManticoreSearch::connection('connectionName')->indices();
$nodes = ManticoreSearch::connection('connectionName')->nodes();

// etc...

methods of Client class:

ManticoreSearch::connection('connectionName')->sql($params);
ManticoreSearch::connection('connectionName')->replace($params);
ManticoreSearch::connection('connectionName')->delete($params);

// etc...

Lumen users who aren't using facades will need to use dependency injection, or the application container in order to get the ManticoreSearch Index object:

// using injection:
public function handle(\ManticoreSearch\Laravel\Manager $manticoresearch)
{
    $manticoresearch->describe();
}

// using application container:
$manticoreSearch = $this->app('manticoresearch');

Of course, dependency injection and the application container work for Laravel applications as well.

All available environments variables

Name	Default value	Description
MANTICORESEARCH_CONNECTION	default	Name of default connection
MANTICORESEARCH_HOST	localhost	Address of host with Manticore server
MANTICORESEARCH_PORT	9308	Port number with REST server
MANTICORESEARCH_TRANSPORT	Http	Type of transport, can be: Http, Https, PhpHttp or your custom driver
MANTICORESEARCH_USER		Username
MANTICORESEARCH_PASS		Password
MANTICORESEARCH_TIMEOUT	5	Timeout between requests
MANTICORESEARCH_CONNECTION_TIMEOUT	1	Timeout before connection
MANTICORESEARCH_PROXY		Url of HTTP proxy server
MANTICORESEARCH_PERSISTENT	true	Define whenever connection is persistent or not
MANTICORESEARCH_RETRIES	2	Amount of retries if connection is lost

psagnataf / laravel-manticoresearch

Maintainers

Details