TASK: Changes according to review

Author: daniellienert

.travis.yml

@@ -20,7 +20,7 @@ before_install:
   - cd ..
   - git clone https://github.com/neos/neos-base-distribution.git -b ${NEOS_TARGET_VERSION}
   - cd neos-base-distribution
-  - composer require typo3/typo3cr-search:2.1.2 flowpack/elasticsearch-contentrepositoryadaptor
+  - composer require neos/content-repository-search:~2.1.0 flowpack/elasticsearch-contentrepositoryadaptor
 install:
   - composer install
   - cd ..

Classes/Flowpack/ElasticSearch/ContentRepositoryAdaptor/Driver/AbstractDriver.php

@@ -17,7 +17,7 @@
 use TYPO3\TYPO3CR\Domain\Model\NodeInterface;
 
 /**
- * Abstract Fulltext Indexer
+ * Abstract Elasticsearch driver
  */
 abstract class AbstractDriver
 {

Classes/Flowpack/ElasticSearch/ContentRepositoryAdaptor/Driver/AbstractIndexerDriver.php

@@ -17,7 +17,7 @@
 use TYPO3\TYPO3CR\Domain\Model\NodeInterface;
 
 /**
- * Abstract Fulltext Indexer
+ * Abstract Fulltext Indexer Driver
  */
 abstract class AbstractIndexerDriver extends AbstractDriver
 {

Classes/Flowpack/ElasticSearch/ContentRepositoryAdaptor/Driver/AbstractQuery.php

@@ -16,7 +16,7 @@
 use TYPO3\Flow\Utility\Arrays;
 
 /**
- * Default Filtered Query
+ * Abstract Elasticsearch Query
  */
 abstract class AbstractQuery implements QueryInterface, \JsonSerializable, \ArrayAccess, ProtectedContextAwareInterface
 {
@@ -77,7 +77,7 @@ public function toArray()
     /**
      * {@inheritdoc}
      */
-    public function getRequestAsJSON()
+    public function getRequestAsJson()
     {
         return json_encode($this);
     }

Classes/Flowpack/ElasticSearch/ContentRepositoryAdaptor/Driver/DocumentDriverInterface.php

@@ -10,12 +10,13 @@
  * information, please view the LICENSE file which was distributed with this
  * source code.
  */
+
 use Flowpack\ElasticSearch\Domain\Model\Index;
 use TYPO3\TYPO3CR\Domain\Model\NodeInterface;
 use TYPO3\TYPO3CR\Domain\Model\NodeType;
 
 /**
- * Document Driver Interface
+ * Elasticsearch Document Driver Interface
  */
 interface DocumentDriverInterface
 {

Classes/Flowpack/ElasticSearch/ContentRepositoryAdaptor/Driver/IndexDriverInterface.php

@@ -12,7 +12,7 @@
  */
 
 /**
- * Elastic Index Driver Interface
+ * Elasticsearch Index Driver Interface
  */
 interface IndexDriverInterface
 {

Classes/Flowpack/ElasticSearch/ContentRepositoryAdaptor/Driver/IndexerDriverInterface.php

@@ -10,6 +10,7 @@
  * information, please view the LICENSE file which was distributed with this
  * source code.
  */
+
 use Flowpack\ElasticSearch\Domain\Model\Document as ElasticSearchDocument;
 use TYPO3\TYPO3CR\Domain\Model\NodeInterface;
 

Classes/Flowpack/ElasticSearch/ContentRepositoryAdaptor/Driver/QueryInterface.php

@@ -30,7 +30,7 @@ public function toArray();
      *
      * @return string
      */
-    public function getRequestAsJSON();
+    public function getRequestAsJson();
 
     /**
      * Get the current count request as JSON string
@@ -39,12 +39,13 @@ public function getRequestAsJSON();
      *
      * @return string
      */
-    public function getCountRequestAsJSON();
+    public function getCountRequestAsJson();
 
     /**
      * Add a sort filter to the request
      *
      * @param array $configuration
+     * @return void
      * @api
      */
     public function addSortFilter($configuration);
@@ -53,6 +54,7 @@ public function addSortFilter($configuration);
      * Set the size (limit) of the request
      *
      * @param integer $size
+     * @return void
      * @api
      */
     public function size($size);
@@ -61,6 +63,7 @@ public function size($size);
      * Set the from (offset) of the request
      *
      * @param integer $size
+     * @return void
      * @api
      */
     public function from($size);
@@ -69,6 +72,7 @@ public function from($size);
      * Match the searchword against the fulltext index
      *
      * @param string $searchWord
+     * @return void
      * @api
      */
     public function fulltext($searchWord);
@@ -79,6 +83,7 @@ public function fulltext($searchWord);
      *
      * @param integer|boolean $fragmentSize The result fragment size for highlight snippets. If this parameter is FALSE, highlighting will be disabled.
      * @param integer $fragmentCount The number of highlight fragments to show.
+     * @return void
      * @api
      */
     public function highlight($fragmentSize, $fragmentCount = null);
@@ -88,7 +93,8 @@ public function highlight($fragmentSize, $fragmentCount = null);
      *
      * @param string $name
      * @param array $aggregationDefinition
-     * @param null $parentPath
+     * @param string $parentPath
+     * @return void
      * @api
      * @throws Exception\QueryBuildingException
      */
@@ -99,6 +105,7 @@ public function aggregation($name, array $aggregationDefinition, $parentPath = n
      *
      * @param string $name
      * @param array $suggestionDefinition
+     * @return void
      * @api
      */
     public function suggestions($name, array $suggestionDefinition);
@@ -109,6 +116,7 @@ public function suggestions($name, array $suggestionDefinition);
      * @param string $filterType
      * @param mixed $filterOptions
      * @param string $clauseType one of must, should, must_not
+     * @return void
      * @throws Exception\QueryBuildingException
      * @api
      */
@@ -117,6 +125,7 @@ public function queryFilter($filterType, $filterOptions, $clauseType = 'must');
     /**
      * @param string $path
      * @param string $value
+     * @return void
      */
     public function setValueByPath($path, $value);
 
@@ -127,6 +136,7 @@ public function setValueByPath($path, $value);
      *
      * @param string $path
      * @param array $data
+     * @return void
      * @throws Exception\QueryBuildingException
      */
     public function appendAtPath($path, array $data);
@@ -143,6 +153,7 @@ public function setByPath($path, $requestPart);
 
     /**
      * @param array $request
+     * @return void
      */
     public function replaceRequest(array $request);
 }

Classes/Flowpack/ElasticSearch/ContentRepositoryAdaptor/Driver/RequestDriverInterface.php

@@ -13,7 +13,7 @@
 use Flowpack\ElasticSearch\Domain\Model\Index;
 
 /**
- * Request Driver Interface
+ * Elasticsearch Request Driver Interface
  */
 interface RequestDriverInterface
 {

Classes/Flowpack/ElasticSearch/ContentRepositoryAdaptor/Driver/Version1/DocumentDriver.php

@@ -21,7 +21,7 @@
 use TYPO3\TYPO3CR\Domain\Model\NodeType;
 
 /**
- * Document Driver for Elastic version 1.x
+ * Document driver for Elasticsearch version 1.x
  *
  * @Flow\Scope("singleton")
  */