Use elasticsearch 2.x query style (#8)

* + re #7: Update ElasticaQueryBuilder to use 2.x queries/filters.
+ re #6: Make TimeZone configurable on any builders that use date nodes.
+ The `Number` class was renamed to `Numbr` to prevent issue with scalar type hints in php7.

* node factory fix for php7 name change

* re #7 make ES builder min match null when a must exists

* re #7 add special handling for _exists_ and _missing_ fields

* full text search on some more commonly used field names

* full text search on some more commonly used field names

* nested queries

* re #7 nested queries for nested fields.

Author: gdbrown

CHANGELOG-0.x.md

@@ -2,6 +2,14 @@
 This changelog references the relevant changes done in 0.x versions.
 
 
+## v0.2.0
+__BREAKING CHANGES__
+
+* issue #7: Update ElasticaQueryBuilder to use 2.x queries/filters.  Requires `"ruflin/elastica": "~3.2"`.
+* issue #6: Make TimeZone configurable on any builders that use date nodes.
+* The `Number` class was renamed to `Numbr` to prevent issue with scalar type hints in php7.
+
+
 ## v0.1.2
 * Allow for `gdbots/common` ~0.1 or ~1.0.
 

composer.json

@@ -10,7 +10,7 @@
   },
   "require-dev": {
     "phpunit/phpunit": "~4.3",
-    "ruflin/elastica": "~1.4.3"
+    "ruflin/elastica": "~3.2"
   },
   "autoload": {
     "psr-4": {
@@ -24,7 +24,7 @@
   },
   "extra": {
     "branch-alias": {
-      "dev-master": "0.1.x-dev"
+      "dev-master": "0.2.x-dev"
     }
   }
 }

examples/elastica.php

@@ -39,6 +39,7 @@ public function log($level, $message, array $context = array())
     ->setEmoticonFieldName('emoticons')
     ->setHashtagFieldName('hashtags')
     ->setMentionFieldName('mentions')
+    ->setLocalTimeZone(new DateTimeZone('America/Los_Angeles'))
 ;
 
 $qs = isset($argv[1]) ? $argv[1] : 'test';
@@ -51,7 +52,7 @@ public function log($level, $message, array $context = array())
 $builder->addParsedQuery($parsedQuery);
 
 $options = [Search::OPTION_FROM => 0, Search::OPTION_SIZE => 5];
-$query = $builder->getFilteredQuery();
+$query = $builder->getBoolQuery();
 /*
 $query = (new FunctionScore())
     ->setQuery($query)

src/Builder/AbstractQueryBuilder.php

@@ -9,7 +9,7 @@
 use Gdbots\QueryParser\Node\Hashtag;
 use Gdbots\QueryParser\Node\Mention;
 use Gdbots\QueryParser\Node\Node;
-use Gdbots\QueryParser\Node\Number;
+use Gdbots\QueryParser\Node\Numbr;
 use Gdbots\QueryParser\Node\Phrase;
 use Gdbots\QueryParser\Node\Range;
 use Gdbots\QueryParser\Node\Subquery;
@@ -18,29 +18,6 @@
 use Gdbots\QueryParser\Node\WordRange;
 use Gdbots\QueryParser\ParsedQuery;
 
-/*
- * DEV NOTES...
- *
- * When is it a term? (exact value)
- * - if it's a Date, Emoji, Emoticon, Hashtag, Mention, Number, Url
- * - if it's in a field and the field does not support full text search. i.e. "+status:active"
- *
- *
- * When should "filter" be used?
- * - when a "term" is required or prohibited. and is "inField"
- *
- *
- * When should "should match" be used?
- * - when a word or phrase is not required or prohibited.
- * - when a word that is required is a stop word (possible/likely it's not even in the index).
- * - when a word that is required uses fuzzy or trailing wildcard
- *
- *
- * When should "should match term" be used?
- * - when a term is not in a field node and is not required.
- *
- *
- */
 abstract class AbstractQueryBuilder implements QueryBuilder
 {
     /** @var Field */
@@ -73,16 +50,54 @@ abstract class AbstractQueryBuilder implements QueryBuilder
         'description' => true,
         'overview' => true,
         'summary' => true,
+        'story' => true,
+        'html' => true,
+        'text' => true,
+        'markdown' => true,
+        'content' => true,
+        'contents' => true,
+        'contents-continued' => true,
+        'contents-md' => true,
+        'contents-mobile' => true,
+        'mobile-contents' => true,
+        'txt-contents' => true,
+        'text-contents' => true,
         'abstract' => true,
         'search_text' => true,
+        'cover' => true,
         'bio' => true,
         'mini_bio' => true,
+        'meta_title' => true,
+        'meta_description' => true,
+        'meta_keywords' => true,
+        'og_title' => true,
+        'og_description' => true,
+        'og_keywords' => true,
         'seo_title' => true,
+        'seo_description' => true,
         'seo_keywords' => true,
         'img_credit' => true,
         'img_caption' => true,
         'credit' => true,
         'caption' => true,
+        'img_credits' => true,
+        'img_captions' => true,
+        'image_credits' => true,
+        'image_captions' => true,
+        'credits' => true,
+        'captions' => true,
+        'full_name' => true,
+        'first_name' => true,
+        'last_name' => true,
+        'street1' => true,
+        'street2' => true,
+        'city' => true,
+        'address.street1' => true,
+        'address.street2' => true,
+        'address.city' => true,
+        'ctx_ip_geo.street1' => true,
+        'ctx_ip_geo.street2' => true,
+        'ctx_ip_geo.city' => true,
     ];
 
     /** @var string */
@@ -100,6 +115,9 @@ abstract class AbstractQueryBuilder implements QueryBuilder
     /** @var string */
     protected $mentionFieldName;
 
+    /** @var \DateTimeZone */
+    protected $localTimeZone;
+
     /**
      * @return static
      */
@@ -118,6 +136,26 @@ final public function setFullTextSearchFields(array $fields)
         return $this;
     }
 
+    /**
+     * @param string $fieldName
+     * @return static
+     */
+    final public function addFullTextSearchField($fieldName)
+    {
+        $this->fullTextSearchFields[$fieldName] = true;
+        return $this;
+    }
+
+    /**
+     * @param string $fieldName
+     * @return static
+     */
+    final public function removeFullTextSearchField($fieldName)
+    {
+        unset($this->fullTextSearchFields[$fieldName]);
+        return $this;
+    }
+
     /**
      * @return array
      */
@@ -185,6 +223,16 @@ final public function setMentionFieldName($fieldName)
         return $this;
     }
 
+    /**
+     * @param \DateTimeZone $timeZone
+     * @return static
+     */
+    final public function setLocalTimeZone(\DateTimeZone $timeZone)
+    {
+        $this->localTimeZone = $timeZone;
+        return $this;
+    }
+
     /**
      * @param ParsedQuery $parsedQuery
      * @return static
@@ -321,10 +369,10 @@ final public function addMention(Mention $mention)
     }
 
     /**
-     * @param \Gdbots\QueryParser\Node\Number $number
+     * @param Numbr $number
      * @return static
      */
-    final public function addNumber(Number $number)
+    final public function addNumber(Numbr $number)
     {
         $this->handleTerm($number);
         return $this;