README

Scout plugin for Craft CMS 3

Craft Scout provides a simple solution for adding full-text search to your entries. Scout will automatically keep your search indexes in sync with your entries.

Support Open Source. Buy beer.

This plugin is licensed under a MIT license, which means that it's completely free open source software, and you can use it for whatever and however you wish. If you're using it and want to support the development, buy me a beer over at Beerpay!

Requirements

This plugin requires Craft CMS 3.0.0-RC1 or later.

Installation

To install the plugin, follow these instructions.

Open your terminal and go to your Craft project:
```
 cd /path/to/project
```
Then tell Composer to load the plugin:
```
 composer require rias/craft-scout
```
In the Control Panel, go to Settings → Plugins and click the “Install” button for Scout.

Setup

To define your indices, create a new scout.php file within your config folder. This file should return an array with 3 keys, an application_id, your admin_api_key (which are both found in your Algolia account) and a mappings key, which defines your site's mappings.

Within the mappings array, each index is represented by a configuration array.

<?php

return [
    "sync" => true,
    "application_id" => "algolia",
    "admin_api_key" => "algolia",
    "mappings" => [
        [
            'indexName' => 'blog',
            'elementType' => \craft\elements\Entry::class,
            'criteria' => [
                'section' => 'blog'
            ],
            'transformer' => function (craft\base\Element $element) {
                return $element->toArray();
            },
        ],
        ...
    ],
];

The Sync option

This config variable determines if Scout should keep your entries in sync automatically. Setting this to false disables all of Scout's event listeners.

Mapping configuration settings

`indexName`

The index name in Algolia, if you don't already have an index created, Scout will create one for you.

`elementType`

The element type that this index contains, most of the time this will be craft\elements\Entry::class

Craft's default element type classes are:

craft\elements\Asset
craft\elements\Category
craft\elements\Entry
craft\elements\GlobalSet
craft\elements\MatrixBlock
craft\elements\Tag
craft\elements\User

'elementType' => craft\elements\Entry::class,

`criteria`

An array of parameters that should be set on the Element Query that limits which entries go inside the index. These criteria are also used when importing through the console command.

'criteria' => [
    'section' => 'blog',
],

`transformer`

The transformer that should be used to define the data that should be sent to Algolia for each element. If you don’t set this, the default transformer will be used, which includes all of the element’s direct attribute values, but no custom field values.

// Can be set to a function
'transformer' => function(craft\elements\Entry $entry) {
    return [
        'title' => $entry->title,
        'id' => $entry->id,
        'url' => $entry->url,
    ];
},

// Or a string/array that defines a Transformer class configuration
'transformer' => 'MyTransformerClassName',

// Or a Transformer class instance
'transformer' => new MyTransformerClassName(),

Your custom transformer class would look something like this:

<?php

use craft\elements\Entry;
use League\Fractal\TransformerAbstract;

class MyTransformerClassName extends TransformerAbstract
{
    public function transform(Entry $entry)
    {
        return [
            // ...
        ];
    }
}

`splitElementIndex`

For long documents it is advised to divide the element into multiple rows to keep each row within row data size. This can be done using splitElementIndex. Array items are array indexes returned from the transformer.

'splitElementIndex' => [
    'summary',
    'matrixElement'
]

Important - distinctId (available after indexing) must be set up as an attribute for faceting for deletion of objects to work when using splitElementIndex.

Console commands

Scout provides two easy console commands for managing your indices.

Importing

To import one or all indices you can run the following console command

./craft scout/index/import <indexName?>

The indexName argument is not required, all your mappings will be imported when you omit it.

Flushing/Clearing

Clearing an index is as easy as running a command in your console.

./craft scout/index/flush <indexName?>

As with the import command, indexName is not required, when flushing Scout will ask you to confirm that you really want to clear all the data in your index.

Credits

Craft Algolia by aaronwaldon as a base to start from
@larsboldt for the Split Element Index option

Brought to you by Rias

jorgeanzola / craft-scout

Maintainers

Details