Download the PHP package needbrainz/scout-typesense-aggregator without Composer

On this page you can find all versions of the php package needbrainz/scout-typesense-aggregator. 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?

Example code of needbrainz/scout-typesense-aggregator

Informations about the package scout-typesense-aggregator

Laravel Scout Aggregator for Typesense

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

Laravel Scout Aggregator for Typesense extends Laravel Scout with support for aggregated search across multiple models using Typesense. Based on Algolia's Scout Extended package, it adapts and extends the aggregator functionality for the open-source Typesense engine.

Installation

You can install the package via composer:

Usage

To create a new aggregator, you can use the make:aggregator command:

Then configure the aggregator settings in your config/scout.php file:

Register your Aggregator in an appropriate service provider, such as App\Providers\AppServiceProvider:

By default the Aggregator will merge the models toSearchableArrray and set the custom id coming from the Aggregator getScoutKey($model) which will create an id in the format ModelClassName::ModelScoutKey. This format can then be reverted with the extractScoutKey($key) for models retrieve. So if you change the syntax, don't forget to override the getScoutKey and extractScoutKey methods in your Aggregator class.

If the structure of the models is different, you can override the toSearchableArray method in your Aggregator class to customize the merging of the models.

Testing

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

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

All versions of scout-typesense-aggregator with dependencies

PHP Build Version
Package Version
Requires php Version ^8.3
illuminate/contracts Version ^10.0||^11.0||^12.0||^13.0
laravel/scout Version ^10.0||^11.0
spatie/laravel-package-tools Version ^1.16
typesense/typesense-php Version ^6.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 needbrainz/scout-typesense-aggregator contains the following files

Loading the files please wait ...