Query builder

CHANGELOG.md

@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Added
 - Support for the analytics component
 - Function builder
+- Query builder
 - Solarium\Component\FacetSet::setMatches()
 - Solarium\Component\FacetSet::setExcludeTerms()
 - Solarium\Component\Facet\Field::setMatches()

docs/queries/query-helper/query-builder.md

@@ -0,0 +1,84 @@
+Query builder
+-------------
+
+The query builder is a simple helper class to help writing and maintaining (filter) queries using Solr's query language.
+While the query will only accept a single (composite) expression, the addition of filter queries can consist of multiple expressions.
+
+Query example
+-------------
+```php
+<?php
+
+use Solarium\Builder\Select\QueryBuilder;
+
+// ...
+
+$query = $client->createSelect();
+
+$expr = QueryBuilder::expr();
+$builder = QueryBuilder::create()
+    ->where($expr->andX(
+        $expr->eq('foo', 'bar'),
+        $expr->eq('baz', 'qux')
+    ))
+;
+
+$query->setQueryFromQueryBuilder($builder);
+
+// which would be equal to
+$query->setQuery('foo:"bar" AND baz:"qux"');
+```
+
+Filter Query example
+-------------
+```php
+<?php
+
+use Solarium\Builder\Select\QueryBuilder;
+
+// ...
+
+$query = $client->createSelect();
+
+$expr = QueryBuilder::expr();
+$builder = QueryBuilder::create()
+    ->where($expr->eq('foo', 'bar')),
+    ->andWhere($expr->neq('baz', 'qux')
+);
+
+$query->addFilterQueriesFromQueryBuilder($builder);
+
+// which would be equal to
+$value = 'foo:"bar"';
+$query->addFilterQuery(['key' => sha1($value), 'query' => $value]);
+$value = '-baz:"qux"';
+$query->addFilterQuery(['key' => sha1($value), 'query' => $value]);
+```
+
+Complex filter queries
+----------------------
+While the ``addFilterQueriesFromQueryBuilder`` method only provides in setting the facet query key and actual query, the ``QueryBuilder`` can be used in the construction of more complex facet queries.
+If one, for example, need to add a tag to the filter query the following method could be used.
+```php
+<?php
+
+use Solarium\Builder\Select\QueryBuilder;
+use Solarium\Builder\Select\QueryExpressionVisitor;
+
+// ...
+
+$query = $client->createSelect();
+
+$expr = QueryBuilder::expr();
+$visitor = new QueryExpressionVisitor();
+
+$builder = QueryBuilder::create()
+    ->where($expr->eq('foo', 'bar'))
+);
+
+$query->addFilterQuery([
+  'key' => 'my-key, 
+  'query' => $visitor->dispatch($builder->getExpression()[0]),
+  'local_tag' => 'my-tag',
+]);
+``` 

src/Builder/AbstractExpressionVisitor.php

@@ -16,8 +16,6 @@
 /**
  * Expression Visitor.
  *
- * @codeCoverageIgnore
- *
  * @author wicliff <[email protected]>
  */
 abstract class AbstractExpressionVisitor

src/Builder/Comparison.php

@@ -14,8 +14,6 @@
 /**
  * Comparison.
  *
- * @codeCoverageIgnore
- *
  * @author wicliff <[email protected]>
  */
 class Comparison implements ExpressionInterface
@@ -80,6 +78,11 @@ class Comparison implements ExpressionInterface
      */
     public const MATCH = 'MATCH';
 
+    /**
+     * Empty.
+     */
+    public const EMPTY = 'EMPTY';
+
     /**
      * @var string
      */

src/Builder/CompositeComparison.php

@@ -16,8 +16,6 @@
 /**
  * Composite Expression.
  *
- * @codeCoverageIgnore
- *
  * @author wicliff <[email protected]>
  */
 class CompositeComparison implements ExpressionInterface

src/Builder/Select/ExpressionBuilder.php

@@ -0,0 +1,189 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Solarium package.
+ *
+ * For the full copyright and license information, please view the COPYING
+ * file that was distributed with this source code.
+ */
+
+namespace Solarium\Builder\Select;
+
+use Solarium\Builder\Comparison;
+use Solarium\Builder\CompositeComparison;
+
+/**
+ * Expression Builder.
+ *
+ * @author wicliff <[email protected]>
+ */
+class ExpressionBuilder
+{
+    /**
+     * @param null $x
+     *
+     * @throws \Solarium\Exception\RuntimeException
+     *
+     * @return \Solarium\Builder\CompositeComparison
+     */
+    public function andX($x = null): CompositeComparison
+    {
+        return new CompositeComparison(CompositeComparison::TYPE_AND, \func_get_args());
+    }
+
+    /**
+     * @param null $x
+     *
+     * @throws \Solarium\Exception\RuntimeException
+     *
+     * @return \Solarium\Builder\CompositeComparison
+     */
+    public function orX($x = null): CompositeComparison
+    {
+        return new CompositeComparison(CompositeComparison::TYPE_OR, \func_get_args());
+    }
+
+    /**
+     * @param string $field
+     * @param mixed  $value
+     *
+     * @return \Solarium\Builder\Comparison
+     */
+    public function eq(string $field, $value): Comparison
+    {
+        return new Comparison($field, Comparison::EQ, $value);
+    }
+
+    /**
+     * @param string $field
+     * @param mixed  $value
+     *
+     * @return \Solarium\Builder\Comparison
+     */
+    public function neq(string $field, $value): Comparison
+    {
+        return new Comparison($field, Comparison::NEQ, $value);
+    }
+
+    /**
+     * @param string $field
+     * @param mixed  $value
+     *
+     * @return \Solarium\Builder\Comparison
+     */
+    public function lt(string $field, $value): Comparison
+    {
+        return new Comparison($field, Comparison::LT, $value);
+    }
+
+    /**
+     * @param string $field
+     * @param mixed  $value
+     *
+     * @return \Solarium\Builder\Comparison
+     */
+    public function gt(string $field, $value): Comparison
+    {
+        return new Comparison($field, Comparison::GT, $value);
+    }
+
+    /**
+     * @param string $field
+     * @param mixed  $value
+     *
+     * @return \Solarium\Builder\Comparison
+     */
+    public function lte(string $field, $value): Comparison
+    {
+        return new Comparison($field, Comparison::LTE, $value);
+    }
+
+    /**
+     * @param string $field
+     * @param mixed  $value
+     *
+     * @return \Solarium\Builder\Comparison
+     */
+    public function gte(string $field, $value): Comparison
+    {
+        return new Comparison($field, Comparison::GTE, $value);
+    }
+
+    /**
+     * @param string $field
+     * @param mixed  $value
+     *
+     * @return \Solarium\Builder\Comparison
+     */
+    public function in(string $field, $value): Comparison
+    {
+        return new Comparison($field, Comparison::IN, $value);
+    }
+
+    /**
+     * @param string $field
+     * @param mixed  $value
+     *
+     * @return \Solarium\Builder\Comparison
+     */
+    public function notIn(string $field, $value): Comparison
+    {
+        return new Comparison($field, Comparison::NIN, $value);
+    }
+
+    /**
+     * @param string $field
+     * @param mixed  $value
+     *
+     * @return \Solarium\Builder\Comparison
+     */
+    public function range(string $field, $value): Comparison
+    {
+        return new Comparison($field, Comparison::RANGE, $value);
+    }
+
+    /**
+     * @param string $field
+     * @param mixed  $value
+     *
+     * @return \Solarium\Builder\Comparison
+     */
+    public function regexp(string $field, $value): Comparison
+    {
+        return new Comparison($field, Comparison::REGEXP, $value);
+    }
+
+    /**
+     * @param string $field
+     * @param mixed  $value
+     *
+     * @return \Solarium\Builder\Comparison
+     */
+    public function like(string $field, $value): Comparison
+    {
+        return new Comparison($field, Comparison::LIKE, $value);
+    }
+
+    /**
+     * @param string $field
+     * @param mixed  $value
+     *
+     * @return \Solarium\Builder\Comparison
+     */
+    public function match(string $field, $value): Comparison
+    {
+        return new Comparison($field, Comparison::MATCH, $value);
+    }
+
+    /**
+     * @param string $field
+     *
+     * @return \Solarium\Builder\Comparison
+     */
+    public function empty(string $field): Comparison
+    {
+        return new Comparison($field, Comparison::EMPTY, null);
+    }
+}