Added Column search criterion

composer.json

@@ -11,7 +11,8 @@
             "EzSystems\\EzPlatformMatrixFieldtypeBundle\\": "src/bundle/",
             "EzSystems\\EzPlatformMatrixFieldtype\\": "src/lib/",
             "Ibexa\\FieldTypeMatrix\\": "src/lib/",
-            "Ibexa\\Bundle\\FieldTypeMatrix\\": "src/bundle/"
+            "Ibexa\\Bundle\\FieldTypeMatrix\\": "src/bundle/",
+            "Ibexa\\Contracts\\FieldTypeMatrix\\": "src/contracts/"
         }
     },
     "autoload-dev": {
@@ -45,6 +46,7 @@
         "ibexa/http-cache": "~4.6.0@dev",
         "ibexa/design-engine": "~4.6.0@dev",
         "ibexa/code-style": "^1.0",
+        "ibexa/solr": "~4.6.0@dev",
         "friendsofphp/php-cs-fixer": "^3.0",
         "phpunit/phpunit": "^9.5"
     },

src/bundle/DependencyInjection/IbexaFieldTypeMatrixExtension.php

@@ -33,6 +33,14 @@ public function load(array $configs, ContainerBuilder $container)
 
         $loader->load('default_parameters.yaml');
         $loader->load('services.yaml');
+
+        if ($container->hasExtension('ibexa_solr')) {
+            $loader->load('services/solr.yaml');
+        }
+
+        if ($container->hasExtension('ibexa_elasticsearch')) {
+            $loader->load('services/elasticsearch.yaml');
+        }
     }
 
     /**

src/bundle/Resources/config/services.yaml

@@ -2,3 +2,4 @@ imports:
     - { resource: services/fieldtype.yaml }
     - { resource: services/command.yaml }
     - { resource: services/graphql.yaml }
+    - { resource: services/search.yaml }

src/bundle/Resources/config/services/elasticsearch.yaml

@@ -0,0 +1,14 @@
+services:
+    _defaults:
+        autowire: true
+        autoconfigure: true
+        public: false
+
+    Ibexa\FieldTypeMatrix\Search\Elasticsearch\IndexSubscriber:
+        tags:
+            - { name: kernel.event_subscriber }
+
+    Ibexa\FieldTypeMatrix\Search\Elasticsearch\Criterion\ColumnCriterionVisitor:
+        tags:
+            - { name: ibexa.search.elasticsearch.query.content.criterion.visitor }
+            - { name: ibexa.search.elasticsearch.query.location.criterion.visitor }

src/bundle/Resources/config/services/search.yaml

@@ -0,0 +1,7 @@
+services:
+    _defaults:
+        autowire: true
+        autoconfigure: true
+        public: false
+
+    Ibexa\FieldTypeMatrix\Search\Common\IndexDataProvider: ~

src/bundle/Resources/config/services/solr.yaml

@@ -0,0 +1,14 @@
+services:
+    _defaults:
+        autowire: true
+        autoconfigure: true
+        public: false
+
+    Ibexa\FieldTypeMatrix\Search\Solr\ContentFieldMapper:
+        tags:
+            - { name: ibexa.search.solr.field.mapper.content }
+
+    Ibexa\FieldTypeMatrix\Search\Solr\ColumnCriterionVisitor:
+        tags:
+            - { name: ibexa.search.solr.query.content.criterion.visitor }
+            - { name: ibexa.search.solr.query.location.criterion.visitor }

src/contracts/Search/Criterion/Column.php

@@ -0,0 +1,51 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\Contracts\FieldTypeMatrix\Search\Criterion;
+
+use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion;
+use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\Operator;
+use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\Operator\Specifications;
+
+final class Column extends Criterion
+{
+    private string $fieldDefIdentifier;
+
+    private string $column;
+
+    public function __construct(
+        string $fieldDefIdentifier,
+        string $column,
+        string $value,
+        string $operator = Operator::EQ
+    ) {
+        parent::__construct(null, $operator, $value);
+
+        $this->fieldDefIdentifier = $fieldDefIdentifier;
+        $this->column = $column;
+    }
+
+    public function getFieldDefIdentifier(): string
+    {
+        return $this->fieldDefIdentifier;
+    }
+
+    public function getColumn(): string
+    {
+        return $this->column;
+    }
+
+    public function getSpecifications(): array
+    {
+        return [
+            new Specifications(Operator::IN, Specifications::FORMAT_ARRAY),
+            new Specifications(Operator::EQ, Specifications::FORMAT_SINGLE),
+            new Specifications(Operator::CONTAINS, Specifications::FORMAT_SINGLE),
+        ];
+    }
+}

src/lib/FieldType/Type.php

@@ -17,6 +17,8 @@
 
 class Type extends FieldType
 {
+    public const FIELD_TYPE_IDENTIFIER = 'matrix';
+
     /**
      * {@inheritdoc}
      */

src/lib/Search/Common/IndexDataProvider.php

@@ -0,0 +1,66 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\FieldTypeMatrix\Search\Common;
+
+use Ibexa\Contracts\Core\Persistence\Content as SPIContent;
+use Ibexa\Contracts\Core\Persistence\Content\Field;
+use Ibexa\Contracts\Core\Persistence\Content\Type\FieldDefinition;
+use Ibexa\Contracts\Core\Persistence\Content\Type\Handler as ContentTypeHandler;
+use Ibexa\Contracts\Core\Search;
+use Ibexa\FieldTypeMatrix\FieldType\Type;
+
+final class IndexDataProvider
+{
+    private ContentTypeHandler $contentTypeHandler;
+
+    public function __construct(ContentTypeHandler $contentTypeHandler)
+    {
+        $this->contentTypeHandler = $contentTypeHandler;
+    }
+
+    public function getSearchData(SPIContent $content): array
+    {
+        $searchFields = [];
+
+        $contentType = $this->contentTypeHandler->load(
+            $content->versionInfo->contentInfo->contentTypeId
+        );
+
+        foreach ($content->fields as $field) {
+            $definition = $this->findDefintion($contentType, $field);
+            if ($definition === null || $definition->fieldType !== Type::FIELD_TYPE_IDENTIFIER) {
+                continue;
+            }
+
+            $columns = array_column($definition->fieldTypeConstraints->fieldSettings['columns'], 'identifier');
+
+            $data = $field->value->data;
+            foreach ($data['entries'] as $column => $value) {
+                $searchFields[] = new Search\Field(
+                    $definition->identifier . '_col_' . $columns[$column] . '_value',
+                    $value,
+                    new Search\FieldType\MultipleStringField()
+                );
+            }
+        }
+
+        return $searchFields;
+    }
+
+    private function findDefintion(SPIContent\Type $contentType, Field $field): ?FieldDefinition
+    {
+        foreach ($contentType->fieldDefinitions as $definition) {
+            if ($field->fieldDefinitionId === $definition->id) {
+                return $definition;
+            }
+        }
+
+        return null;
+    }
+}

src/lib/Search/Elasticsearch/Criterion/ColumnCriterionVisitor.php

@@ -0,0 +1,50 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\FieldTypeMatrix\Search\Elasticsearch\Criterion;
+
+use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion;
+use Ibexa\Contracts\Elasticsearch\Query\CriterionVisitor;
+use Ibexa\Contracts\Elasticsearch\Query\LanguageFilter;
+use Ibexa\Contracts\FieldTypeMatrix\Search\Criterion\Column;
+use Ibexa\Elasticsearch\ElasticSearch\QueryDSL\BoolQuery;
+use Ibexa\Elasticsearch\ElasticSearch\QueryDSL\TermsQuery;
+use Ibexa\Elasticsearch\ElasticSearch\QueryDSL\WildcardQuery;
+
+final class ColumnCriterionVisitor implements CriterionVisitor
+{
+    public function supports(Criterion $criterion, LanguageFilter $languageFilter): bool
+    {
+        return $criterion instanceof Column;
+    }
+
+    /**
+     * @param \Ibexa\Contracts\FieldTypeMatrix\Search\Criterion\Column $criterion
+     */
+    public function visit(CriterionVisitor $dispatcher, Criterion $criterion, LanguageFilter $languageFilter): array
+    {
+        $name = $criterion->getFieldDefIdentifier() . '_col_' . $criterion->getColumn() . '_value_ms';
+
+        if ($criterion->operator === Criterion\Operator::CONTAINS) {
+            $bool = new BoolQuery();
+            foreach ((array) $criterion->value as $value) {
+                $wildcard = new WildcardQuery();
+                $wildcard->withField($name);
+                $wildcard->withValue('*' . $value . '*');
+
+                $bool->addShould($wildcard);
+            }
+        } else {
+            $terms = new TermsQuery();
+            $terms->withField($name);
+            $terms->withValue((array)$criterion->value);
+
+            return $terms->toArray();
+        }
+    }
+}

src/lib/Search/Elasticsearch/IndexSubscriber.php

@@ -0,0 +1,60 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\FieldTypeMatrix\Search\Elasticsearch;
+
+use Ibexa\Contracts\Core\Persistence\Content;
+use Ibexa\Contracts\Core\Persistence\Content\Handler as ContentHandler;
+use Ibexa\Contracts\Core\Search\Document;
+use Ibexa\Contracts\Elasticsearch\Mapping\Event\ContentIndexCreateEvent;
+use Ibexa\Contracts\Elasticsearch\Mapping\Event\LocationIndexCreateEvent;
+use Ibexa\FieldTypeMatrix\Search\Common\IndexDataProvider;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+
+final class IndexSubscriber implements EventSubscriberInterface
+{
+    private ContentHandler $contentHandler;
+
+    private IndexDataProvider $indexDataProvider;
+
+    public function __construct(ContentHandler $contentHandler, IndexDataProvider $indexDataProvider)
+    {
+        $this->contentHandler = $contentHandler;
+        $this->indexDataProvider = $indexDataProvider;
+    }
+
+    public static function getSubscribedEvents(): array
+    {
+        return [
+            ContentIndexCreateEvent::class => 'onContentIndexCreate',
+            LocationIndexCreateEvent::class => 'onLocationIndexCreate',
+        ];
+    }
+
+    public function onContentIndexCreate(ContentIndexCreateEvent $event): void
+    {
+        $this->appendSearchFields($event->getDocument(), $event->getContent());
+    }
+
+    public function onLocationIndexCreate(LocationIndexCreateEvent $event): void
+    {
+        $content = $this->contentHandler->load(
+            $event->getLocation()->contentId
+        );
+
+        $this->appendSearchFields($event->getDocument(), $content);
+    }
+
+    private function appendSearchFields(Document $document, Content $content): void
+    {
+        $data = $this->indexDataProvider->getSearchData($content);
+        foreach ($data as $field) {
+            $document->fields[] = $field;
+        }
+    }
+}

src/lib/Search/Solr/ContentFieldMapper.php

@@ -0,0 +1,33 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\FieldTypeMatrix\Search\Solr;
+
+use EzSystems\EzPlatformMatrixFieldtype\Search\Common\IndexDataProvider;
+use Ibexa\Contracts\Core\Persistence\Content as SPIContent;
+use Ibexa\Contracts\Solr\FieldMapper\ContentFieldMapper as BaseContentFieldMapper;
+
+final class ContentFieldMapper extends BaseContentFieldMapper
+{
+    private IndexDataProvider $indexDataProvider;
+
+    public function __construct(IndexDataProvider $indexDataProvider)
+    {
+        $this->indexDataProvider = $indexDataProvider;
+    }
+
+    public function accept(SPIContent $content): bool
+    {
+        return true;
+    }
+
+    public function mapFields(SPIContent $content): array
+    {
+        return $this->indexDataProvider->getSearchData($content);
+    }
+}

src/lib/Search/Solr/Criterion/ColumnCriterionVisitor.php

@@ -0,0 +1,41 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\FieldTypeMatrix\Search\Solr;
+
+use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion;
+use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\Operator;
+use Ibexa\Contracts\FieldTypeMatrix\Search\Criterion\Column;
+use Ibexa\Contracts\Solr\Query\CriterionVisitor;
+
+final class ColumnCriterionVisitor extends CriterionVisitor
+{
+    public function canVisit(Criterion $criterion): bool
+    {
+        return $criterion instanceof Column;
+    }
+
+    /**
+     * @param \Ibexa\Contracts\FieldTypeMatrix\Search\Criterion\Column $criterion
+     */
+    public function visit(Criterion $criterion, CriterionVisitor $subVisitor = null): string
+    {
+        $name = $criterion->getFieldDefIdentifier() . '_col_' . $criterion->getColumn() . '_value_ms';
+
+        $queries = [];
+        foreach ((array)$criterion->value as $value) {
+            if ($criterion->operator === Operator::CONTAINS) {
+                $queries[] = $name . ':*' . $this->escapeExpressions($value) . '*';
+            } else {
+                $queries[] = $name . ':"' . $this->escapeQuote($value, true) . '"';
+            }
+        }
+
+        return '(' . implode(' OR ', $queries) . ')';
+    }
+}