Merge pull request #724 from webdevsHub/QueryBuilder

QueryBuilder

Author: ruflin

changes.txt

@@ -9,6 +9,9 @@ CHANGES
 2014-11-19
 - Avoid remove previously added params when adding a suggest to the query #726
 
+2014-11-16
+- Added Elastica\QueryBuilder #724
+
 2014-11-13
 - fixed reserved words in queries which composed of upper case letters (Util::replaceBooleanWords) #722
 

lib/Elastica/Exception/QueryBuilderException.php

@@ -0,0 +1,12 @@
+<?php
+namespace Elastica\Exception;
+
+/**
+ * QueryBuilder exception
+ *
+ * @package Elastica
+ * @author Manuel Andreo Garcia <[email protected]>
+ */
+class QueryBuilderException extends \RuntimeException implements ExceptionInterface
+{
+}

lib/Elastica/QueryBuilder.php

@@ -0,0 +1,114 @@
+<?php
+
+namespace Elastica;
+
+use Elastica\Exception\QueryBuilderException;
+use Elastica\QueryBuilder\DSL;
+use Elastica\QueryBuilder\Facade;
+use Elastica\QueryBuilder\Version;
+use Elastica\QueryBuilder\Version\Version140;
+
+/**
+ * Query Builder
+ *
+ * @package Elastica
+ * @author Manuel Andreo Garcia <[email protected]>
+ */
+class QueryBuilder
+{
+    /**
+     * @var Version
+     */
+    private $_version;
+
+    /**
+     * @var Facade[]
+     */
+    private $_facades = array();
+
+    /**
+     * Constructor
+     *
+     * @param Version $version
+     */
+    public function __construct(Version $version = null)
+    {
+        $this->_version = $version ?: new Version140();
+
+        $this->addDSL(new DSL\Query());
+        $this->addDSL(new DSL\Filter());
+        $this->addDSL(new DSL\Aggregation());
+        $this->addDSL(new DSL\Suggest());
+    }
+
+    /**
+     * Returns Facade for custom DSL object
+     *
+     * @param $dsl
+     * @param array $arguments
+     * @return Facade
+     * @throws QueryBuilderException
+     */
+    public function __call($dsl, array $arguments)
+    {
+        if (false === isset($this->_facades[$dsl])) {
+            throw new QueryBuilderException('DSL "' . $dsl . '" not supported');
+        }
+
+        return $this->_facades[$dsl];
+    }
+
+    /**
+     * Adds a new DSL object
+     *
+     * @param DSL $dsl
+     */
+    public function addDSL(DSL $dsl)
+    {
+        $this->_facades[$dsl->getType()] = new Facade($dsl, $this->_version);
+    }
+
+    /*
+     * convenience methods
+     */
+
+    /**
+     * Query DSL
+     *
+     * @return DSL\Query
+     */
+    public function query()
+    {
+        return $this->_facades[DSL::TYPE_QUERY];
+    }
+
+    /**
+     * Filter DSL
+     *
+     * @return DSL\Filter
+     */
+    public function filter()
+    {
+        return $this->_facades[DSL::TYPE_FILTER];
+    }
+
+    /**
+     * Aggregation DSL
+     *
+     * @return DSL\Aggregation
+     */
+    public function aggregation()
+    {
+        return $this->_facades[DSL::TYPE_AGGREGATION];
+    }
+
+    /**
+     * Suggest DSL
+     *
+     * @return DSL\Suggest
+     */
+    public function suggest()
+    {
+        return $this->_facades[DSL::TYPE_SUGGEST];
+    }
+}

lib/Elastica/QueryBuilder/DSL.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Elastica\QueryBuilder;
+
+/**
+ * DSL Interface
+ *
+ * @package Elastica
+ * @author Manuel Andreo Garcia <[email protected]>
+ */
+interface DSL
+{
+    const TYPE_QUERY = 'query';
+    const TYPE_FILTER = 'filter';
+    const TYPE_AGGREGATION = 'aggregation';
+    const TYPE_SUGGEST = 'suggest';
+
+    /**
+     * must return type for QueryBuilder usage
+     *
+     * @return string
+     */
+    public function getType();
+}