Download the PHP package thedevopser/typesense-bundle without Composer

ACSEOTypesenseBundle

This bundle provides integration with Typesense with Symfony.

It relies on the official TypeSense PHP package

Features include:

• Doctrine object transformer to Typesense indexable data
• Usefull services to search in collections
• Listeners for Doctrine events for automatic indexing

Installation

Install the bundle using composer

`

Enable the bundle in you Symfony project

Configuration

Configure the Bundle

You can use basic types supported by Typesense for your fields : string, int32, float, etc. You can also use specific type names, such as : primary, collection, object

Data conversion from Doctrine entity to Typesense data is managed by ACSEO\TypesenseBundle\Transformer\DoctrineToTypesenseTransformer

Usage

Create index and populate data

This bundle comes with useful commands in order to create and index your data

Search documents

This bundle creates dynamic generic finders services that allows you to query Typesense

The finder services are named like this : typesense.finder.collection_name

You can inject the generic finder in your Controller or into other services.

You can also create specific finder for a collection. See documentation below.

Querying Typesense

The class TypesenseQuery() class takes 2 arguments :

• The search terme (q)
• The fields to search on (queryBy)

You can create more complex queries using all the possible Typsense search arguments

Create specific finder for a collection

You can easily create specific finders for each collection that you declare.

This configuration will create a service named @typesense.finder.books.books_autocomplete.
You can inject the specific finder in your Controller or into other services

and then use it like this :

Use different kind of services

This bundles creates different services that you can use in your Controllers or anywhere you want.

• typesense.client : the basic client inherited from the official typesense-php package
• typesense.collection_client : this service allows you to do basic actions on collections, and allows to perform search and multisearch action.
• typesense.finder.* : this generated service allows you to perform query or rawQuery on a specific collection. Example of a generated service : typesense.finder.candidates
• typesense.specificfinder.*.* : this generated service allows you to run pre-configured requests (declared in : config/packages/acseo_typesense.yml). Example of a generated service : typesense.specificfinder.candidates.default

Note : there a other services. You can use the debug:container command in order to see all of them.

Doctrine Listeners

Doctrine listeners will update Typesense with Entity data during the following events :

• postPersist
• postUpdate
• preDelete

Perform multisearch

You can create multisearch requests and get results using the collectionClient service.

Cookbook

• Use Typesense to make an autocomplete field

Testing the Bundle

tests are written in the tests directory.

• Unit tests doesn't require a running Typesense server
• Functional tests require a running Typesense server

You can launch the tests with the following commands :