Merge pull request #788 from im-denisenko/feature/fix-fluent

Fix fluent interface inconsistency
ruflin · Feb 21, 2015 · 690a98a · 690a98a
2 parents 7f62b40 + 52763f9
commit 690a98a
Show file tree

Hide file tree

Showing 155 changed files with 1,478 additions and 1,234 deletions.
diff --git a/lib/Elastica/AbstractUpdateAction.php b/lib/Elastica/AbstractUpdateAction.php
@@ -20,8 +20,8 @@ class AbstractUpdateAction extends Param
     /**
      * Sets the id of the document.
      *
-     * @param  string             $id
-     * @return \Elastica\Document
+     * @param  string $id
+     * @return $this
      */
     public function setId($id)
     {
@@ -49,8 +49,8 @@ public function hasId()
     /**
      * Sets lifetime of document
      *
-     * @param  string             $ttl
-     * @return \Elastica\Document
+     * @param  string $ttl
+     * @return $this
      */
     public function setTtl($ttl)
     {
@@ -76,8 +76,8 @@ public function hasTtl()
     /**
      * Sets the document type name
      *
-     * @param  string             $type Type name
-     * @return \Elastica\Document Current object
+     * @param  string $type Type name
+     * @return $this
      */
     public function setType($type)
     {
@@ -92,8 +92,9 @@ public function setType($type)
     /**
      * Return document type name
      *
-     * @return string                               Document type name
      * @throws \Elastica\Exception\InvalidException
+     *
+     * @return string Document type name
      */
     public function getType()
     {
@@ -103,8 +104,8 @@ public function getType()
     /**
      * Sets the document index name
      *
-     * @param  string             $index Index name
-     * @return \Elastica\Document Current object
+     * @param  string $index Index name
+     * @return $this
      */
     public function setIndex($index)
     {
@@ -118,8 +119,9 @@ public function setIndex($index)
     /**
      * Get the document index name
      *
-     * @return string                               Index name
      * @throws \Elastica\Exception\InvalidException
+     *
+     * @return string Index name
      */
     public function getIndex()
     {
@@ -129,8 +131,8 @@ public function getIndex()
     /**
      * Sets the version of a document for use with optimistic concurrency control
      *
-     * @param  int                $version Document version
-     * @return \Elastica\Document Current object
+     * @param  int   $version Document version
+     * @return $this
      * @link http://www.elasticsearch.org/blog/2011/02/08/versioning.html
      */
     public function setVersion($version)
@@ -160,8 +162,8 @@ public function hasVersion()
      * Sets the version_type of a document
      * Default in ES is internal, but you can set to external to use custom versioning
      *
-     * @param  int                $versionType Document version type
-     * @return \Elastica\Document Current object
+     * @param  int   $versionType Document version type
+     * @return $this
      * @link http://www.elasticsearch.org/guide/reference/api/index_.html
      */
     public function setVersionType($versionType)
@@ -190,8 +192,8 @@ public function hasVersionType()
     /**
      * Sets parent document id
      *
-     * @param  string|int         $parent Parent document id
-     * @return \Elastica\Document Current object
+     * @param  string|int $parent Parent document id
+     * @return $this
      * @link http://www.elasticsearch.org/guide/reference/mapping/parent-field.html
      */
     public function setParent($parent)
@@ -220,8 +222,8 @@ public function hasParent()
     /**
      * Set operation type
      *
-     * @param  string             $opType Only accept create
-     * @return \Elastica\Document Current object
+     * @param  string $opType Only accept create
+     * @return $this
      */
     public function setOpType($opType)
     {
@@ -248,8 +250,8 @@ public function hasOpType()
     /**
      * Set percolate query param
      *
-     * @param  string             $value percolator filter
-     * @return \Elastica\Document
+     * @param  string $value percolator filter
+     * @return $this
      */
     public function setPercolate($value = '*')
     {
@@ -277,8 +279,8 @@ public function hasPercolate()
     /**
      * Set routing query param
      *
-     * @param  string             $value routing
-     * @return \Elastica\Document
+     * @param  string $value routing
+     * @return $this
      */
     public function setRouting($value)
     {
@@ -304,8 +306,8 @@ public function hasRouting()
     }
 
     /**
-     * @param  array|string       $fields
-     * @return \Elastica\Document
+     * @param  array|string $fields
+     * @return $this
      */
     public function setFields($fields)
     {
@@ -317,7 +319,7 @@ public function setFields($fields)
     }
 
     /**
-     * @return \Elastica\Document
+     * @return $this
      */
     public function setFieldsSource()
     {
@@ -341,8 +343,8 @@ public function hasFields()
     }
 
     /**
-     * @param  int                $num
-     * @return \Elastica\Document
+     * @param  int   $num
+     * @return $this
      */
     public function setRetryOnConflict($num)
     {
@@ -366,8 +368,8 @@ public function hasRetryOnConflict()
     }
 
     /**
-     * @param  string             $timestamp
-     * @return \Elastica\Document
+     * @param  string $timestamp
+     * @return $this
      */
     public function setTimestamp($timestamp)
     {
@@ -391,8 +393,8 @@ public function hasTimestamp()
     }
 
     /**
-     * @param  bool               $refresh
-     * @return \Elastica\Document
+     * @param  bool  $refresh
+     * @return $this
      */
     public function setRefresh($refresh = true)
     {
@@ -416,8 +418,8 @@ public function hasRefresh()
     }
 
     /**
-     * @param  string             $timeout
-     * @return \Elastica\Document
+     * @param  string $timeout
+     * @return $this
      */
     public function setTimeout($timeout)
     {
@@ -441,8 +443,8 @@ public function hasTimeout()
     }
 
     /**
-     * @param  string             $timeout
-     * @return \Elastica\Document
+     * @param  string $timeout
+     * @return $this
      */
     public function setConsistency($timeout)
     {
@@ -466,8 +468,8 @@ public function hasConsistency()
     }
 
     /**
-     * @param  string             $timeout
-     * @return \Elastica\Document
+     * @param  string $timeout
+     * @return $this
      */
     public function setReplication($timeout)
     {
@@ -492,7 +494,7 @@ public function hasReplication()
 
     /**
      * @param  \Elastica\Document|array $data
-     * @return \Elastica\Document
+     * @return $this
      */
     public function setUpsert($data)
     {

diff --git a/lib/Elastica/Aggregation/AbstractAggregation.php b/lib/Elastica/Aggregation/AbstractAggregation.php
@@ -8,14 +8,12 @@
 abstract class AbstractAggregation extends Param
 {
     /**
-     * The name of this aggregation
-     * @var string
+     * @var string The name of this aggregation
      */
     protected $_name;
 
     /**
-     * Subaggregations belonging to this aggregation
-     * @var array
+     * @var array Subaggregations belonging to this aggregation
      */
     protected $_aggs = array();
 
@@ -34,6 +32,8 @@ public function __construct($name)
     public function setName($name)
     {
         $this->_name = $name;
+
+        return $this;
     }
 
     /**
@@ -56,8 +56,9 @@ public function getAggs()
 
     /**
      * Add a sub-aggregation
-     * @param  AbstractAggregation                  $aggregation
      * @throws \Elastica\Exception\InvalidException
+     *
+     * @param  AbstractAggregation $aggregation
      * @return $this
      */
     public function addAggregation(AbstractAggregation $aggregation)

diff --git a/lib/Elastica/Aggregation/AbstractSimpleAggregation.php b/lib/Elastica/Aggregation/AbstractSimpleAggregation.php
@@ -8,7 +8,7 @@ abstract class AbstractSimpleAggregation extends AbstractAggregation
 {
     /**
      * Set the field for this aggregation
-     * @param  string                    $field the name of the document field on which to perform this aggregation
+     * @param  string $field the name of the document field on which to perform this aggregation
      * @return $this
      */
     public function setField($field)
@@ -18,7 +18,7 @@ public function setField($field)
 
     /**
      * Set a script for this aggregation
-     * @param  string|Script             $script
+     * @param  string|Script $script
      * @return $this
      */
     public function setScript($script)

diff --git a/lib/Elastica/Aggregation/DateHistogram.php b/lib/Elastica/Aggregation/DateHistogram.php
@@ -11,8 +11,8 @@ class DateHistogram extends Histogram
 {
     /**
      * Set pre-rounding based on interval
-     * @param  string        $preZone
-     * @return DateHistogram
+     * @param  string $preZone
+     * @return $this
      */
     public function setPreZone($preZone)
     {
@@ -21,8 +21,8 @@ public function setPreZone($preZone)
 
     /**
      * Set post-rounding based on interval
-     * @param  string        $postZone
-     * @return DateHistogram
+     * @param  string $postZone
+     * @return $this
      */
     public function setPostZone($postZone)
     {
@@ -31,8 +31,8 @@ public function setPostZone($postZone)
 
     /**
      * Set pre-zone adjustment for larger time intervals (day and above)
-     * @param  string        $adjust
-     * @return DateHistogram
+     * @param  string $adjust
+     * @return $this
      */
     public function setPreZoneAdjustLargeInterval($adjust)
     {
@@ -41,8 +41,8 @@ public function setPreZoneAdjustLargeInterval($adjust)
 
     /**
      * Adjust for granularity of date data
-     * @param  int           $factor set to 1000 if date is stored in seconds rather than milliseconds
-     * @return DateHistogram
+     * @param  int   $factor set to 1000 if date is stored in seconds rather than milliseconds
+     * @return $this
      */
     public function setFactor($factor)
     {
@@ -51,8 +51,8 @@ public function setFactor($factor)
 
     /**
      * Set the offset for pre-rounding
-     * @param  string        $offset "1d", for example
-     * @return DateHistogram
+     * @param  string $offset "1d", for example
+     * @return $this
      */
     public function setPreOffset($offset)
     {
@@ -61,8 +61,8 @@ public function setPreOffset($offset)
 
     /**
      * Set the offset for post-rounding
-     * @param  string        $offset "1d", for example
-     * @return DateHistogram
+     * @param  string $offset "1d", for example
+     * @return $this
      */
     public function setPostOffset($offset)
     {
@@ -72,8 +72,8 @@ public function setPostOffset($offset)
     /**
      * Set the format for returned bucket key_as_string values
      * @link http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-aggregations-bucket-daterange-aggregation.html#date-format-pattern
-     * @param  string        $format see link for formatting options
-     * @return DateHistogram
+     * @param  string $format see link for formatting options
+     * @return $this
      */
     public function setFormat($format)
     {

diff --git a/lib/Elastica/Aggregation/DateRange.php b/lib/Elastica/Aggregation/DateRange.php
@@ -12,7 +12,7 @@ class DateRange extends Range
     /**
      * Set the formatting for the returned date values
      * @param  string $format see documentation for formatting options
-     * @return Range
+     * @return $this
      */
     public function setFormat($format)
     {

diff --git a/lib/Elastica/Aggregation/Filter.php b/lib/Elastica/Aggregation/Filter.php
@@ -14,7 +14,7 @@ class Filter extends AbstractAggregation
     /**
      * Set the filter for this aggregation
      * @param  AbstractFilter $filter
-     * @return Filter
+     * @return $this
      */
     public function setFilter(AbstractFilter $filter)
     {

diff --git a/lib/Elastica/Aggregation/Filters.php b/lib/Elastica/Aggregation/Filters.php
@@ -18,7 +18,7 @@ class Filters extends AbstractAggregation
      *
      * @param  AbstractFilter $filter
      * @param  string         $name
-     * @return Filters
+     * @return $this
      */
     public function addFilter(AbstractFilter $filter, $name = '')
     {