Download the PHP package byng/pimcore-elasticsearch-plugin without Composer
On this page you can find all versions of the php package byng/pimcore-elasticsearch-plugin. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
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 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.
Informations about the package pimcore-elasticsearch-plugin
Pimcore Elasticsearch Plugin
The Elasticsearch plugin for Pimcore Saves/updates contents (text only) of document's (editables) and assets to Elasticsearch. It also provides a query builder to search the index.
Features
- Automatic indexing of documents and assets to Elasticsearch when created/updated in Pimcore admin.
- Hooks to add custom properties to the index.
- A simple query builder to retrieve indexed documents. Supports querying, filtering, sorting and pagination.
System Requirements
- PHP - 5.6+
- Elasticsearch - 1.7+
- Pimcore - 3, 4 (not tested on 5 yet)
Installation via composer
The recommended method to install the Pimcore Elasticsearch Plugin is via Composer.
1 - Add byng/pimcore-elasticsearch-plugin as a dependency in your project's composer.json file and run composer install
2 - Copy the distribution config file (elasticsearchplugin.xml.dist) in the root of the plugin folder
to {PIMCORE_WEBSITE_DIR}/var/config/elasticsearchplugin.xml.
3 - Enable the plugin in Pimcore using the extension manager.
Quickstart
Once the installation has been completed, the first time you create or update a document the Elasticsearch index will be created and the document will be indexed. You can verify that the index exists using curl or Kibana.
Hooks
Hooks allow you to hook into the plugin at various points to provide additional functionality. It uses the standard Zend EventManager which Pimcore uses.
Registering an event listener example
For example to register an even listener:
The above code will call the handlePreIndex() method of the class where it was added whenever a document is ready to be indexed.
Within the handlePreIndex() method you have access to the actual Pimcore document which is being indexed and also the data the plugin has lready extracted. You can add additional properties to the parameters array and they will also be saved to the index:
Available hooks
The following hooks are currently available:
document.elasticsearch.preIndex
This hook is called after the plugin has extracted all the information from the document to index and before it writes the data to Elasticsearch. You can use this hook to write additional/custom properties to the index.
asset.elasticsearch.preIndex
This hook is the asset equivalent of "document.elasticsearch.preIndex".
Querying
The pluigin provides a simple query builder to make it easy to extract information from Elasticsearch.
Example
The following JSON request will be generated from the above code and sent to Elasticsearch:
This will retrieve all documents that contain the word "something".
Todo
- Provide more complete query documentation
- Add support for custom queries, i.e. an array which can be converted to json and posted to Elasticsearch without any processing if the plugin doesn't support the whole Elasticsearch DSL for querying.
License
MIT
