[3.4.0] Adds Aggregators - Multiple entities in the same index

[nunomaduro]

Q	A
Bug fix?	yes
New feature?	yes
BC breaks?	no
Related Issue	Fix #201
Need Doc update	yes

Describe your change

• This Pull Request is a work in progress. Any feedback about the technical approach, implementation or would be highly appreciated. 🙏
• If you are running algolia/search-bundle in a Symfony application, please try this feature locally and report bugs (if any) on this discussion. 👍

This Pull Request introduces a new feature on Algolia algolia/search-bundle called Aggregators.

An aggregator object allows to aggregate more than one entity type in the same index. With aggregators, developers can provide a better search experience since the search results will contain content from various sources (entities).

How to configure an aggregator:

1. First, add a new aggregator on the configuration file algolia_search.yml:

        - indices:
            - name: news
              class: App\Entity\News

2. Then, create a new Aggregator object and declare the entities that you want to aggregate:

<?php

namespace App\Entity;

use Doctrine\ORM\Mapping as ORM;
use Algolia\SearchBundle\Entity\Aggregator;

/**
 * @ORM\Entity
 */
class News extends Aggregator
{
    /**
     * Returns the entities class names that should be aggregated.
     *
     * @return string[]
     */
    public static function getEntities()
    {
        return [
            Post::class,
            Comment::class,
        ];
    }
}

---

Indexation & Search:

1. IndexManager::search method:

$indexManager->index($post, $objectManager);
$indexManager->index($comment, $objectManager);

$results = $indexManager->search('', News::class, $objectManager);

// $results[0] will contain a Post.
// $results[1] will contain a Comment.

2. IndexManager::rawSearch method:

$indexManager->index($post, $objectManager);
$indexManager->index($comment, $objectManager);

$results = $indexManager->rawSearch('', News::class);

/**
 * 
 * Results:
 * 
 * {
 *     "hits": [
 *         {
 *             "id": 2,
 *             "title": "Test",
 *             "content": "Test content",
 *             "objectID": "App\Entity\Post::1",
 *             ...
 *         },
 *         {
 *             "content": "Comment content",
 *             "post_title": "What a post!",
 *             "objectID": "App\Entity\Comment::1",
 *             ...
 *         },
 *         ...
 *     ]
 * }
*/

3. IndexManager::remove method:

$indexManager->index($post, $objectManager);
$indexManager->index($comment, $objectManager);
$indexManager->remove($comment, $objectManager);

$results = $indexManager->search('', News::class, $objectManager);
// count($results) will be 1.

4. Advanced Aggregators:

I will wait for some feedback from the community before writing out for a detailed explanation of the advanced usage of aggregators.

[nunomaduro]

I will review this Pull Request again later. Now that I have better understanding of the product, things can be even better on this Pull Request.

[alcaeus]

One more note about ODM mappings, apart from that this looks good 👍

[kiler129]

@nunomaduro Is there any more docs on this feature? How such index will look in Algolia index?

[nunomaduro]

Yes, docs are here: https://www.algolia.com/doc/framework-integration/symfony/advanced/?language=php#aggregators---multiple-entities-types-in-the-one-index .

…

On Tue 18 Dec 2018 at 04:03, Grzegorz Zdanowski ***@***.***> wrote: @nunomaduro <https://github.com/nunomaduro> Is there any more docs on this feature? How such index will look in Algolia index? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#257 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AFNFVKuZmejpUuBzH9IkxCvoI1PbIxc7ks5u6Fr4gaJpZM4WgWKv> .