Download the PHP package yucadoo/elasticsearcher-fractal without Composer
On this page you can find all versions of the php package yucadoo/elasticsearcher-fractal. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download yucadoo/elasticsearcher-fractal
More information about yucadoo/elasticsearcher-fractal
Files in yucadoo/elasticsearcher-fractal
Package elasticsearcher-fractal
Short Description Combines Elasticsearcher with PHP League's Fractal package for easier document management.
License MIT
Homepage https://github.com/yucadoo/elasticsearcher-fractal
Informations about the package elasticsearcher-fractal
ElasticSearcher Fractal
Combines Elasticsearcher with PHP League's Fractal package for easier document management.
This package is compliant with PSR-1, PSR-2, PSR-4 and PSR-11. If you notice compliance oversights, please send a patch via pull request.
Install
Via Composer
Usage
This package provides the YucaDoo\ElasticSearcher\Managers\DocumentManager
class which can be used instead of the original ElasticSearcher\Managers\DocumentsManager
class. It actually wraps the original manager, providing the same functionality in a more reusable and object friendly way.
The original document manager handles raw documents, which are arrays. You always have to specify the Elasticsearch index name and id alongside the document. The new document manager is capable of taking any type of input, for example database models. The Elasticsearch index name and id are determined by the given input, while PHP League's Fractal package is used to convert the input to a document. If you like what you see below, this package is what you were looking for!
The new document manager requires an adapter, which extends the YucaDoo\ElasticSearcher\Managers\DocumentAdapter
interface. The adapter is used to obtain the Elasticsearch index name and id. Below is a sample implementation for Eloquent models.
Then implement the transformers for Elasticsearch. An example is given below.
It's time now to put things together. To do so we need a PSR-11 compatible container, which exists in most modern PHP frameworks. Most containers return an instance of the class when given the full class name.
The document manager needs the container to obtain the transformer instance to be used for the handled input. When handling a User a UserElasticsearchTransformer instance is needed, when handling a Post model the PostElasticsearchTransformer instance is needed, and so on. The document manager doesn't know the class name of the transformer. The container is expect to resolve the transformer based on the index name. To do so the AliasContainer can be used (version 2.0 or later).
I also recommend using the SingletonContainer to cache the resolved transformers.
First add the packages.
Then compose the new document manager using the AliasContainer.
Change log
Please see CHANGELOG for more information on what has changed recently.
Testing
Contributing
Please see CODE_OF_CONDUCT for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
- Hrvoje Jukic
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of elasticsearcher-fractal with dependencies
league/fractal Version ^0.19.2
madewithlove/elasticsearcher Version ^0.5.2
psr/container Version ^1.0