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.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

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 PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • 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.
Please rate this library. Is it a good library?

Informations about the package elasticsearcher-fractal

ElasticSearcher Fractal

Latest Version on Packagist Build Status Coverage Status Quality Score Total Downloads

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

License

The MIT License (MIT). Please see License File for more information.


All versions of elasticsearcher-fractal with dependencies

PHP Build Version
Package Version
Requires php Version ~7.2
league/fractal Version ^0.19.2
madewithlove/elasticsearcher Version ^0.5.2
psr/container Version ^1.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package yucadoo/elasticsearcher-fractal contains the following files

Loading the files please wait ....