From 622139f71930122c8971c8ed16e4876283349a73 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Randy=20=C4=8Cupi=C4=87?= <randy@netgen.hr>
Date: Mon, 19 Aug 2019 13:53:02 +0200
Subject: [PATCH] Implement custom field sort clause

---
 .../Content/Query/SortClause/CustomField.php  | 23 +++++++++++++
 .../Common/SortClauseVisitor/CustomField.php  | 34 +++++++++++++++++++
 .../search/solr/sort_clause_visitors.yml      |  6 ++++
 3 files changed, 63 insertions(+)
 create mode 100644 lib/API/Values/Content/Query/SortClause/CustomField.php
 create mode 100644 lib/Core/Search/Solr/Query/Common/SortClauseVisitor/CustomField.php

diff --git a/lib/API/Values/Content/Query/SortClause/CustomField.php b/lib/API/Values/Content/Query/SortClause/CustomField.php
new file mode 100644
index 00000000..cb033b0e
--- /dev/null
+++ b/lib/API/Values/Content/Query/SortClause/CustomField.php
@@ -0,0 +1,23 @@
+<?php
+
+namespace Netgen\EzPlatformSearchExtra\API\Values\Content\Query\SortClause;
+
+use eZ\Publish\API\Repository\Values\Content\Query;
+use eZ\Publish\API\Repository\Values\Content\Query\SortClause;
+use Netgen\EzPlatformSearchExtra\API\Values\Content\Query\Criterion\SubdocumentQuery;
+use Netgen\EzPlatformSearchExtra\API\Values\Content\Query\SortClause\Target\SubdocumentTarget;
+
+/**
+ * CustomField sort clause is used to sort Content by custom field indexed for this content.
+ */
+final class CustomField extends SortClause
+{
+    /**
+     * @param string $fieldName
+     * @param string $sortDirection
+     */
+    public function __construct($fieldName, $sortDirection = Query::SORT_ASC)
+    {
+        parent::__construct($fieldName, $sortDirection);
+    }
+}
diff --git a/lib/Core/Search/Solr/Query/Common/SortClauseVisitor/CustomField.php b/lib/Core/Search/Solr/Query/Common/SortClauseVisitor/CustomField.php
new file mode 100644
index 00000000..b14b122f
--- /dev/null
+++ b/lib/Core/Search/Solr/Query/Common/SortClauseVisitor/CustomField.php
@@ -0,0 +1,34 @@
+<?php
+
+namespace Netgen\EzPlatformSearchExtra\Core\Search\Solr\Query\Common\SortClauseVisitor;
+
+use EzSystems\EzPlatformSolrSearchEngine\Query\SortClauseVisitor;
+use eZ\Publish\API\Repository\Values\Content\Query\SortClause;
+use \Netgen\EzPlatformSearchExtra\API\Values\Content\Query\SortClause\CustomField as CustomFieldSortClause;
+
+class CustomField extends SortClauseVisitor
+{
+    /**
+     * Check if visitor is applicable to current sortClause.
+     *
+     * @param SortClause $sortClause
+     *
+     * @return bool
+     */
+    public function canVisit(SortClause $sortClause)
+    {
+        return $sortClause instanceof CustomFieldSortClause;
+    }
+
+    /**
+     * Map field value to a proper Solr representation.
+     *
+     * @param SortClause $sortClause
+     *
+     * @return string
+     */
+    public function visit(SortClause $sortClause)
+    {
+        return $sortClause->target . $this->getDirection($sortClause);
+    }
+}
diff --git a/lib/Resources/config/search/solr/sort_clause_visitors.yml b/lib/Resources/config/search/solr/sort_clause_visitors.yml
index a8e190a9..a899f9c4 100644
--- a/lib/Resources/config/search/solr/sort_clause_visitors.yml
+++ b/lib/Resources/config/search/solr/sort_clause_visitors.yml
@@ -17,3 +17,9 @@ services:
         tags:
             - {name: ezpublish.search.solr.query.content.sort_clause_visitor}
             - {name: ezpublish.search.solr.query.location.sort_clause_visitor}
+
+    netgen.search.solr.query.common.sort_clause_visitor.custom_field:
+        class: Netgen\EzPlatformSearchExtra\Core\Search\Solr\Query\Common\SortClauseVisitor\CustomField
+        tags:
+            - {name: ezpublish.search.solr.query.content.sort_clause_visitor}
+            - {name: ezpublish.search.solr.query.location.sort_clause_visitor}