https://github.com/fork/craft-elastica
A plugin to connect to Elasticsearch and persist elements via hooks
https://github.com/fork/craft-elastica
Last synced: 10 months ago
JSON representation
A plugin to connect to Elasticsearch and persist elements via hooks
- Host: GitHub
- URL: https://github.com/fork/craft-elastica
- Owner: fork
- License: mit
- Created: 2021-01-05T13:17:34.000Z (over 5 years ago)
- Default Branch: develop
- Last Pushed: 2024-11-12T15:47:58.000Z (over 1 year ago)
- Last Synced: 2024-11-12T16:40:42.231Z (over 1 year ago)
- Language: PHP
- Size: 96.7 KB
- Stars: 6
- Watchers: 9
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Elastica Plugin for Craft 5.x
**Table of contents**
- [Features](#features)
- [Requirements](#requirements)
- [Setup](#setup)
- [Usage](#usage)
- [Roadmap](#roadmap)
---
## Features
- Index entries and other elements in Elasticsearch
- Customize Index data structures via hooks
- Define Index Templates to configure the Index and its fields and mapping in Elasticsearch
- Re-Index contents via utility or console command
## Requirements
- Craft CMS >= 5.x
### Version Matrix
| Elastica Version | Craft Version | ElasticSearch Version |
|------------------|---------------|-----------------------|
| 4.x | 5.x | 8.x |
| 3.x | 5.x | 7.x |
| 2.x | 4.x | 7.x |
## Setup
**1. Install**
Install the package
```sh
cd /path/to/project
composer require fork/craft-elastica
```
**2. Configuration**
Go to the plugin settings page and enter a index prefix name which is prepended to the indexes being created in Elasticsearch.
The name of the index is generated from this prefix.
Also provide the hostname of the elasticsearch instance.
## Usage
To generate the data to index register event handlers in your own module or plugin class like this:
```php
// initialize elasticsearch indexer
Event::on(
Indexer::class,
Indexer::EVENT_INDEXER_INIT,
function (IndexerInitEvent $event) {
$event->addSectionHandles([
'articles',
]);
$event->addCategoryGroupHandles([
'topics',
]);
$event->addVolumeHandles([
'images',
]);
}
);
// build elasticsearch index data
Event::on(
Indexer::class,
Indexer::EVENT_BEFORE_INDEX_DATA,
function (IndexEvent $event) {
// build your custom data structure to index
$indexData = MyCustomPlugin::$plugin->mySearchService->getIndexData($event->sender);
$event->indexData = $indexData;
}
);
```
## Environment based configuration
You can make the plugin's configuration environment based by adding an elastica.php file in your config directory with
the following contents. This is just an example, you can name your environment variables as you want.
```php
use craft\helpers\App;
return [
'indexingEnabled' => App::env('ELASTICSEARCH_INDEXING_ENABLED') ?? true,
'hosts' => [
[
App::env('CRAFT_ENVIRONMENT'),
App::env('ELASTICSEARCH_URL'),
App::env('ELASTICSEARCH_INDEX_PREFIX'),
]
]
];
```
## Roadmap
- [x] Logo
- [x] Index categories
- [ ] Maybe include search proxy
- [ ] Exclude sites via settings
- [ ] Show index info / test index in utility
- [ ] More documentation
---
