Cleanup linting (#1385)

ruflin · Oct 5, 2017 · e140c86 · e140c86
1 parent 81123eb
commit e140c86
Show file tree

Hide file tree

Showing 73 changed files with 337 additions and 339 deletions.
diff --git a/lib/Elastica/Client.php b/lib/Elastica/Client.php
@@ -305,8 +305,8 @@ public function removeHeader($header)
      *
      * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html
      *
-     * @param array|\Elastica\Document[] $docs Array of Elastica\Document
-     * @param array $requestParams
+     * @param array|\Elastica\Document[] $docs          Array of Elastica\Document
+     * @param array                      $requestParams
      *
      * @throws \Elastica\Exception\InvalidException If docs is empty
      *
@@ -337,8 +337,8 @@ public function updateDocuments(array $docs, array $requestParams = [])
      *
      * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html
      *
-     * @param array|\Elastica\Document[] $docs Array of Elastica\Document
-     * @param array $requestParams
+     * @param array|\Elastica\Document[] $docs          Array of Elastica\Document
+     * @param array                      $requestParams
      *
      * @throws \Elastica\Exception\InvalidException If docs is empty
      *

diff --git a/lib/Elastica/Index.php b/lib/Elastica/Index.php
@@ -549,7 +549,7 @@ public function requestEndpoint(AbstractEndpoint $endpoint)
      * Detailed arguments can be found here in the link
      *
      * @param array $body String to be analyzed
-     * @param array  $args OPTIONAL Additional arguments
+     * @param array $args OPTIONAL Additional arguments
      *
      * @return array Server response
      *

diff --git a/lib/Elastica/Pipeline.php b/lib/Elastica/Pipeline.php
@@ -15,12 +15,13 @@
  * Handles Pipeline management & definition.
  *
  * @author   Federico Panini <fpanini@gmail.com>
+ *
  * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest-processors.html
  */
 class Pipeline extends Param
 {
     /**
-     * @var string $id name of the pipeline
+     * @var string name of the pipeline
      */
     protected $id;
 
@@ -32,17 +33,16 @@ class Pipeline extends Param
     protected $_client;
 
     /**
-     * Processors array
+     * Processors array.
      *
-     * @var array $_processors
+     * @var array
      */
     protected $_processors = [];
 
     /**
      * Create a new Pipeline Object.
      *
      * @param Client $client
-     *
      */
     public function __construct(Client $client)
     {
@@ -53,6 +53,7 @@ public function __construct(Client $client)
      * Create a Pipeline.
      *
      * @return Response
+     *
      * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/put-pipeline-api.html
      */
     public function create()
@@ -78,7 +79,9 @@ public function create()
 
     /**
      * Get a Pipeline Object.
+     *
      * @param string $id Pipeline name
+     *
      * @return Response
      *
      * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/get-pipeline-api.html
@@ -95,6 +98,7 @@ public function getPipeline(string $id)
      * Delete a Pipeline.
      *
      * @param string $id Pipeline name
+     *
      * @return Response
      *
      * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-pipeline-api.html
@@ -118,7 +122,7 @@ public function simulate()
     /**
      * Sets query as raw array. Will overwrite all already set arguments.
      *
-     * @param array $processors  array
+     * @param array $processors array
      *
      * @return $this
      */
@@ -192,6 +196,7 @@ public function setDescription(string $description)
     public function toArray()
     {
         $this->_params['processors'] = [$this->_processors['processors']];
+
         return $this->getParams();
     }
 
@@ -218,4 +223,4 @@ public function requestEndpoint(AbstractEndpoint $endpoint)
 
         return $this->getClient()->requestEndpoint($cloned);
     }
-}
+}
diff --git a/lib/Elastica/Processor/AbstractProcessor.php b/lib/Elastica/Processor/AbstractProcessor.php
@@ -7,9 +7,9 @@
  * Elastica Prcessor object.
  *
  * @author   Federico Panini <fpanini@gmail.com>
+ *
  * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest-processors.html
  */
 abstract class AbstractProcessor extends Param
 {
-
-}
+}
diff --git a/lib/Elastica/Processor/Append.php b/lib/Elastica/Processor/Append.php
@@ -5,14 +5,15 @@
  * Elastica Append Processor.
  *
  * @author   Federico Panini <fpanini@gmail.com>
+ *
  * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/append-processor.html
  */
 class Append extends AbstractProcessor
 {
     /**
      * Append constructor.
      *
-     * @param string $field field name
+     * @param string       $field field name
      * @param string|array $value field values to append
      */
     public function __construct(string $field, $value)
@@ -34,7 +35,7 @@ public function setField(string $field)
     }
 
     /**
-     * Set field value
+     * Set field value.
      *
      * @param string|array $value
      *
@@ -44,4 +45,4 @@ public function setValue($value)
     {
         return $this->setParam('value', $value);
     }
-}
+}
diff --git a/lib/Elastica/Processor/Attachment.php b/lib/Elastica/Processor/Attachment.php
@@ -50,7 +50,7 @@ public function setIndexedChars(int $indexedChars)
     }
 
     /**
-     * Set properties. Default all properties. Can be content, title, name, author, keywords, date, content_type, content_length, language
+     * Set properties. Default all properties. Can be content, title, name, author, keywords, date, content_type, content_length, language.
      *
      * @param array $properties
      *
@@ -72,4 +72,4 @@ public function setIgnoreMissing(bool $ignoreMissing)
     {
         return $this->setParam('ignore_missing', $ignoreMissing);
     }
-}
+}
diff --git a/lib/Elastica/Processor/Convert.php b/lib/Elastica/Processor/Convert.php
@@ -5,6 +5,7 @@
  * Elastica Convert Processor.
  *
  * @author   Federico Panini <fpanini@gmail.com>
+ *
  * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/append-processor.html
  */
 class Convert extends AbstractProcessor
@@ -62,4 +63,4 @@ public function setIgnoreMissing(bool $ignoreMissing)
     {
         return $this->setParam('ignore_missing', $ignoreMissing);
     }
-}
+}
diff --git a/lib/Elastica/Processor/Date.php b/lib/Elastica/Processor/Date.php
@@ -5,6 +5,7 @@
  * Elastica Date Processor.
  *
  * @author   Federico Panini <fpanini@gmail.com>
+ *
  * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/date-processor.html
  */
 class Date extends AbstractProcessor
@@ -13,7 +14,7 @@ class Date extends AbstractProcessor
      * Date constructor.
      *
      * @param string $field
-     * @param array $formats
+     * @param array  $formats
      */
     public function __construct(string $field, array $formats)
     {
@@ -80,4 +81,4 @@ public function setLocale(string $locale)
     {
         return $this->setParam('locale', $locale);
     }
-}
+}
diff --git a/lib/Elastica/Processor/DateIndexName.php b/lib/Elastica/Processor/DateIndexName.php
@@ -5,6 +5,7 @@
  * Elastica DateIndexName Processor.
  *
  * @author   Federico Panini <fpanini@gmail.com>
+ *
  * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/date-index-name-processor.html
  */
 class DateIndexName extends AbstractProcessor
@@ -70,7 +71,7 @@ public function setIndexNamePrefix(string $indexPrefixName)
     }
 
     /**
-     * Set format to be used when printing parsed date. An valid Joda pattern is expected here. Default yyyy-MM-dd
+     * Set format to be used when printing parsed date. An valid Joda pattern is expected here. Default yyyy-MM-dd.
      *
      * @param string $indexNameFormat
      *
@@ -104,4 +105,4 @@ public function setLocale(string $locale)
     {
         return $this->setParam('locale', $locale);
     }
-}
+}
diff --git a/lib/Elastica/Processor/DotExpander.php b/lib/Elastica/Processor/DotExpander.php
@@ -5,6 +5,7 @@
  * Elastica Rename Processor.
  *
  * @author   Federico Panini <fpanini@gmail.com>
+ *
  * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/dot-expand-processor.html
  */
 class DotExpander extends AbstractProcessor
@@ -25,4 +26,4 @@ public function setField(string $field)
     {
         return $this->setParam('field', $field);
     }
-}
+}
diff --git a/lib/Elastica/Processor/Fail.php b/lib/Elastica/Processor/Fail.php
@@ -5,12 +5,14 @@
  * Elastica Fail Processor.
  *
  * @author   Federico Panini <fpanini@gmail.com>
+ *
  * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/fail-processor.html
  */
 class Fail extends AbstractProcessor
 {
     /**
      * Fail constructor.
+     *
      * @param string $message
      */
     public function __construct(string $message)
@@ -29,4 +31,4 @@ public function setMessage(string $message)
     {
         return $this->setParam('message', $message);
     }
-}
+}
diff --git a/lib/Elastica/Processor/Join.php b/lib/Elastica/Processor/Join.php
@@ -5,6 +5,7 @@
  * Elastica Join Processor.
  *
  * @author   Federico Panini <fpanini@gmail.com>
+ *
  * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/join-processor.html
  */
 class Join extends AbstractProcessor
@@ -44,4 +45,4 @@ public function setSeparator(string $separator)
     {
         return $this->setParam('separator', $separator);
     }
-}
+}
diff --git a/lib/Elastica/Processor/Json.php b/lib/Elastica/Processor/Json.php
@@ -5,6 +5,7 @@
  * Elastica Json Processor.
  *
  * @author   Federico Panini <fpanini@gmail.com>
+ *
  * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/json-processor.html
  */
 class Json extends AbstractProcessor
@@ -49,4 +50,4 @@ public function setAddToRoot(bool $addToRoot)
     {
         return $this->setParam('add_to_root', $addToRoot);
     }
-}
+}
diff --git a/lib/Elastica/Processor/Kv.php b/lib/Elastica/Processor/Kv.php
@@ -5,6 +5,7 @@
  * Elastica KV Processor.
  *
  * @author   Federico Panini <fpanini@gmail.com>
+ *
  * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/kv-processor.html
  */
 class Kv extends AbstractProcessor
@@ -106,4 +107,4 @@ public function setIgnoreMissing(bool $ignoreMissing)
     {
         return $this->setParam('ignore_missing', $ignoreMissing);
     }
-}
+}
diff --git a/lib/Elastica/Processor/Lowercase.php b/lib/Elastica/Processor/Lowercase.php
@@ -5,6 +5,7 @@
  * Elastica Lowercase Processor.
  *
  * @author   Federico Panini <fpanini@gmail.com>
+ *
  * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/lowercase-processor.html
  */
 class Lowercase extends AbstractProcessor
@@ -30,4 +31,4 @@ public function setField(string $field)
     {
         return $this->setParam('field', $field);
     }
-}
+}
diff --git a/lib/Elastica/Processor/Remove.php b/lib/Elastica/Processor/Remove.php
@@ -5,6 +5,7 @@
  * Elastica Remove Processor.
  *
  * @author   Federico Panini <fpanini@gmail.com>
+ *
  * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/remove-processor.html
  */
 class Remove extends AbstractProcessor
@@ -30,4 +31,4 @@ public function setField($field)
     {
         return $this->setParam('field', $field);
     }
-}
+}
diff --git a/lib/Elastica/Processor/Rename.php b/lib/Elastica/Processor/Rename.php
@@ -5,6 +5,7 @@
  * Elastica Rename Processor.
  *
  * @author   Federico Panini <fpanini@gmail.com>
+ *
  * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/rename-processor.html
  */
 class Rename extends AbstractProcessor
@@ -56,4 +57,4 @@ public function setIgnoreMissing(bool $ignoreMissing)
     {
         return $this->setParam('ignore_missing', $ignoreMissing);
     }
-}
+}
diff --git a/lib/Elastica/Processor/Set.php b/lib/Elastica/Processor/Set.php
@@ -5,6 +5,7 @@
  * Elastica Set Processor.
  *
  * @author   Federico Panini <fpanini@gmail.com>
+ *
  * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest-processors.html
  */
 class Set extends AbstractProcessor
@@ -34,7 +35,7 @@ public function setField(string $field)
     }
 
     /**
-     * Set field value
+     * Set field value.
      *
      * @param string $value
      *
@@ -56,4 +57,4 @@ public function setOverride(bool $override)
     {
         return $this->setParam('override', $override);
     }
-}
+}