Merge pull request #396 from GrandLTU/document-return-type

saimaz · saimaz · commit 1dcff15927ad · 2015-06-19T14:39:35.000+03:00
Make setters in documents return $this.
diff --git a/Document/AbstractDocument.php b/Document/AbstractDocument.php
@@ -106,7 +106,7 @@ public function __clone()
      *
      * @param string $documentId
      *
-     * @return DocumentInterface
+     * @return $this
      */
     public function setId($documentId)
     {
@@ -130,7 +130,7 @@ public function getId()
      *
      * @param string $documentScore
      *
-     * @return DocumentInterface
+     * @return $this
      */
     public function setScore($documentScore)
     {
@@ -154,7 +154,7 @@ public function getScore()
      *
      * @param string $parent
      *
-     * @return DocumentInterface
+     * @return $this
      */
     public function setParent($parent)
     {
@@ -214,7 +214,7 @@ public function getHighLight()
      *
      * @param string $ttl
      *
-     * @return DocumentInterface
+     * @return $this
      */
     public function setTtl($ttl)
     {
diff --git a/Document/DocumentInterface.php b/Document/DocumentInterface.php
@@ -23,7 +23,7 @@ interface DocumentInterface
      *
      * @param string $documentId
      *
-     * @return DocumentInterface
+     * @return $this
      */
     public function setId($documentId);
 
@@ -39,7 +39,7 @@ public function getId();
      *
      * @param string $documentScore
      *
-     * @return DocumentInterface
+     * @return $this
      */
     public function setScore($documentScore);
 
@@ -55,7 +55,7 @@ public function getScore();
      *
      * @param string $parent
      *
-     * @return DocumentInterface
+     * @return $this
      */
     public function setParent($parent);
 
@@ -78,7 +78,7 @@ public function hasParent();
      *
      * @param int $ttl
      *
-     * @return DocumentInterface
+     * @return $this
      */
     public function setTtl($ttl);
 
diff --git a/Document/DocumentTrait.php b/Document/DocumentTrait.php
@@ -100,7 +100,7 @@ public function __set($property, $value)
      *
      * @param string $documentId
      *
-     * @return DocumentInterface
+     * @return $this
      */
     public function setId($documentId)
     {
@@ -124,7 +124,7 @@ public function getId()
      *
      * @param string $documentScore
      *
-     * @return DocumentInterface
+     * @return $this
      */
     public function setScore($documentScore)
     {
@@ -148,7 +148,7 @@ public function getScore()
      *
      * @param string $parent
      *
-     * @return DocumentInterface
+     * @return $this
      */
     public function setParent($parent)
     {
@@ -208,7 +208,7 @@ public function getHighLight()
      *
      * @param string $ttl
      *
-     * @return DocumentInterface
+     * @return $this
      */
     public function setTtl($ttl)
     {
diff --git a/Document/Suggester/AbstractSuggester.php b/Document/Suggester/AbstractSuggester.php
@@ -50,10 +50,14 @@ abstract class AbstractSuggester implements SuggesterInterface
      * Setter for input to store.
      *
      * @param string[]|string $input
+     *
+     * @return $this
      */
     public function setInput($input)
     {
         $this->input = $input;
+
+        return $this;
     }
 
     /**
@@ -70,10 +74,14 @@ public function getInput()
      * Setter for string to return.
      *
      * @param string $output
+     *
+     * @return $this
      */
     public function setOutput($output)
     {
         $this->output = $output;
+
+        return $this;
     }
 
     /**
@@ -90,10 +98,14 @@ public function getOutput()
      * Setter for object to be returned in the suggest option.
      *
      * @param object $payload
+     *
+     * @return $this
      */
     public function setPayload($payload)
     {
         $this->payload = (object)$payload;
+
+        return $this;
     }
 
     /**
@@ -110,10 +122,14 @@ public function getPayload()
      * Setter for a weight used to rank suggestions.
      *
      * @param int|string $weight
+     *
+     * @return $this
      */
     public function setWeight($weight)
     {
         $this->weight = $weight;
+
+        return $this;
     }
 
     /**
diff --git a/Document/Suggester/ContextSuggesterInterface.php b/Document/Suggester/ContextSuggesterInterface.php
@@ -27,6 +27,8 @@ public function getContext();
      * Sets context to be used for completion.
      *
      * @param object $context
+     *
+     * @return $this
      */
     public function setContext($context);
 }
diff --git a/Document/Suggester/ContextSuggesterTrait.php b/Document/Suggester/ContextSuggesterTrait.php
@@ -35,9 +35,13 @@ public function getContext()
      * Sets context to be used for completion.
      *
      * @param object $context
+     *
+     * @return $this
      */
     public function setContext($context)
     {
         $this->context = $context;
+
+        return $this;
     }
 }
diff --git a/Document/Suggester/SuggesterInterface.php b/Document/Suggester/SuggesterInterface.php
@@ -20,6 +20,8 @@ interface SuggesterInterface
      * Setter for input to store.
      *
      * @param string $input
+     *
+     * @return $this
      */
     public function setInput($input);
 
@@ -34,6 +36,8 @@ public function getInput();
      * Setter for string to return.
      *
      * @param string $output
+     *
+     * @return $this
      */
     public function setOutput($output);
 
@@ -55,6 +59,8 @@ public function getWeight();
      * Setter for a weight used to rank suggestions.
      *
      * @param int|string $weight
+     *
+     * @return $this
      */
     public function setWeight($weight);
 
@@ -69,6 +75,8 @@ public function getPayload();
      * Setter for object to be returned in the suggest option.
      *
      * @param object $payload
+     *
+     * @return $this
      */
     public function setPayload($payload);
 }
diff --git a/Document/Suggester/SuggesterTrait.php b/Document/Suggester/SuggesterTrait.php
@@ -50,10 +50,14 @@ trait SuggesterTrait
      * Setter for input to store.
      *
      * @param string[]|string $input
+     *
+     * @return $this
      */
     public function setInput($input)
     {
         $this->input = $input;
+
+        return $this;
     }
 
     /**
@@ -70,10 +74,14 @@ public function getInput()
      * Setter for string to return.
      *
      * @param string $output
+     *
+     * @return $this
      */
     public function setOutput($output)
     {
         $this->output = $output;
+
+        return $this;
     }
 
     /**
@@ -90,10 +98,14 @@ public function getOutput()
      * Setter for object to be returned in the suggest option.
      *
      * @param object $payload
+     *
+     * @return $this
      */
     public function setPayload($payload)
     {
         $this->payload = (object)$payload;
+
+        return $this;
     }
 
     /**
@@ -110,10 +122,14 @@ public function getPayload()
      * Setter for a weight used to rank suggestions.
      *
      * @param int|string $weight
+     *
+     * @return $this
      */
     public function setWeight($weight)
     {
         $this->weight = $weight;
+
+        return $this;
     }
 
     /**

Original file line number	Diff line number	Diff line change
`@@ -106,7 +106,7 @@ public function __clone()`
`106`	`106`	`*`
`107`	`107`	`* @param string $documentId`
`108`	`108`	`*`
`109`		`- * @return DocumentInterface`
	`109`	`+ * @return $this`
`110`	`110`	`*/`
`111`	`111`	`public function setId($documentId)`
`112`	`112`	`{`
`@@ -130,7 +130,7 @@ public function getId()`
`130`	`130`	`*`
`131`	`131`	`* @param string $documentScore`
`132`	`132`	`*`
`133`		`- * @return DocumentInterface`
	`133`	`+ * @return $this`
`134`	`134`	`*/`
`135`	`135`	`public function setScore($documentScore)`
`136`	`136`	`{`
`@@ -154,7 +154,7 @@ public function getScore()`
`154`	`154`	`*`
`155`	`155`	`* @param string $parent`
`156`	`156`	`*`
`157`		`- * @return DocumentInterface`
	`157`	`+ * @return $this`
`158`	`158`	`*/`
`159`	`159`	`public function setParent($parent)`
`160`	`160`	`{`
`@@ -214,7 +214,7 @@ public function getHighLight()`
`214`	`214`	`*`
`215`	`215`	`* @param string $ttl`
`216`	`216`	`*`
`217`		`- * @return DocumentInterface`
	`217`	`+ * @return $this`
`218`	`218`	`*/`
`219`	`219`	`public function setTtl($ttl)`
`220`	`220`	`{`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ interface DocumentInterface`
`23`	`23`	`*`
`24`	`24`	`* @param string $documentId`
`25`	`25`	`*`
`26`		`- * @return DocumentInterface`
	`26`	`+ * @return $this`
`27`	`27`	`*/`
`28`	`28`	`public function setId($documentId);`
`29`	`29`
`@@ -39,7 +39,7 @@ public function getId();`
`39`	`39`	`*`
`40`	`40`	`* @param string $documentScore`
`41`	`41`	`*`
`42`		`- * @return DocumentInterface`
	`42`	`+ * @return $this`
`43`	`43`	`*/`
`44`	`44`	`public function setScore($documentScore);`
`45`	`45`
`@@ -55,7 +55,7 @@ public function getScore();`
`55`	`55`	`*`
`56`	`56`	`* @param string $parent`
`57`	`57`	`*`
`58`		`- * @return DocumentInterface`
	`58`	`+ * @return $this`
`59`	`59`	`*/`
`60`	`60`	`public function setParent($parent);`
`61`	`61`
`@@ -78,7 +78,7 @@ public function hasParent();`
`78`	`78`	`*`
`79`	`79`	`* @param int $ttl`
`80`	`80`	`*`
`81`		`- * @return DocumentInterface`
	`81`	`+ * @return $this`
`82`	`82`	`*/`
`83`	`83`	`public function setTtl($ttl);`
`84`	`84`
Original file line number	Diff line number	Diff line change
`@@ -100,7 +100,7 @@ public function __set($property, $value)`
`100`	`100`	`*`
`101`	`101`	`* @param string $documentId`
`102`	`102`	`*`
`103`		`- * @return DocumentInterface`
	`103`	`+ * @return $this`
`104`	`104`	`*/`
`105`	`105`	`public function setId($documentId)`
`106`	`106`	`{`
`@@ -124,7 +124,7 @@ public function getId()`
`124`	`124`	`*`
`125`	`125`	`* @param string $documentScore`
`126`	`126`	`*`
`127`		`- * @return DocumentInterface`
	`127`	`+ * @return $this`
`128`	`128`	`*/`
`129`	`129`	`public function setScore($documentScore)`
`130`	`130`	`{`
`@@ -148,7 +148,7 @@ public function getScore()`
`148`	`148`	`*`
`149`	`149`	`* @param string $parent`
`150`	`150`	`*`
`151`		`- * @return DocumentInterface`
	`151`	`+ * @return $this`
`152`	`152`	`*/`
`153`	`153`	`public function setParent($parent)`
`154`	`154`	`{`
`@@ -208,7 +208,7 @@ public function getHighLight()`
`208`	`208`	`*`
`209`	`209`	`* @param string $ttl`
`210`	`210`	`*`
`211`		`- * @return DocumentInterface`
	`211`	`+ * @return $this`
`212`	`212`	`*/`
`213`	`213`	`public function setTtl($ttl)`
`214`	`214`	`{`
Original file line number	Diff line number	Diff line change
`@@ -50,10 +50,14 @@ abstract class AbstractSuggester implements SuggesterInterface`
`50`	`50`	`* Setter for input to store.`
`51`	`51`	`*`
`52`	`52`	`* @param string[]\|string $input`
	`53`	`+ *`
	`54`	`+ * @return $this`
`53`	`55`	`*/`
`54`	`56`	`public function setInput($input)`
`55`	`57`	`{`
`56`	`58`	`$this->input = $input;`
	`59`	`+`
	`60`	`+ return $this;`
`57`	`61`	`}`
`58`	`62`
`59`	`63`	`/**`
`@@ -70,10 +74,14 @@ public function getInput()`
`70`	`74`	`* Setter for string to return.`
`71`	`75`	`*`
`72`	`76`	`* @param string $output`
	`77`	`+ *`
	`78`	`+ * @return $this`
`73`	`79`	`*/`
`74`	`80`	`public function setOutput($output)`
`75`	`81`	`{`
`76`	`82`	`$this->output = $output;`
	`83`	`+`
	`84`	`+ return $this;`
`77`	`85`	`}`
`78`	`86`
`79`	`87`	`/**`
`@@ -90,10 +98,14 @@ public function getOutput()`
`90`	`98`	`* Setter for object to be returned in the suggest option.`
`91`	`99`	`*`
`92`	`100`	`* @param object $payload`
	`101`	`+ *`
	`102`	`+ * @return $this`
`93`	`103`	`*/`
`94`	`104`	`public function setPayload($payload)`
`95`	`105`	`{`
`96`	`106`	`$this->payload = (object)$payload;`
	`107`	`+`
	`108`	`+ return $this;`
`97`	`109`	`}`
`98`	`110`
`99`	`111`	`/**`
`@@ -110,10 +122,14 @@ public function getPayload()`
`110`	`122`	`* Setter for a weight used to rank suggestions.`
`111`	`123`	`*`
`112`	`124`	`* @param int\|string $weight`
	`125`	`+ *`
	`126`	`+ * @return $this`
`113`	`127`	`*/`
`114`	`128`	`public function setWeight($weight)`
`115`	`129`	`{`
`116`	`130`	`$this->weight = $weight;`
	`131`	`+`
	`132`	`+ return $this;`
`117`	`133`	`}`
`118`	`134`
`119`	`135`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -27,6 +27,8 @@ public function getContext();`
`27`	`27`	`* Sets context to be used for completion.`
`28`	`28`	`*`
`29`	`29`	`* @param object $context`
	`30`	`+ *`
	`31`	`+ * @return $this`
`30`	`32`	`*/`
`31`	`33`	`public function setContext($context);`
`32`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -35,9 +35,13 @@ public function getContext()`
`35`	`35`	`* Sets context to be used for completion.`
`36`	`36`	`*`
`37`	`37`	`* @param object $context`
	`38`	`+ *`
	`39`	`+ * @return $this`
`38`	`40`	`*/`
`39`	`41`	`public function setContext($context)`
`40`	`42`	`{`
`41`	`43`	`$this->context = $context;`
	`44`	`+`
	`45`	`+ return $this;`
`42`	`46`	`}`
`43`	`47`	`}`
Original file line number	Diff line number	Diff line change
`@@ -50,10 +50,14 @@ trait SuggesterTrait`
`50`	`50`	`* Setter for input to store.`
`51`	`51`	`*`
`52`	`52`	`* @param string[]\|string $input`
	`53`	`+ *`
	`54`	`+ * @return $this`
`53`	`55`	`*/`
`54`	`56`	`public function setInput($input)`
`55`	`57`	`{`
`56`	`58`	`$this->input = $input;`
	`59`	`+`
	`60`	`+ return $this;`
`57`	`61`	`}`
`58`	`62`
`59`	`63`	`/**`
`@@ -70,10 +74,14 @@ public function getInput()`
`70`	`74`	`* Setter for string to return.`
`71`	`75`	`*`
`72`	`76`	`* @param string $output`
	`77`	`+ *`
	`78`	`+ * @return $this`
`73`	`79`	`*/`
`74`	`80`	`public function setOutput($output)`
`75`	`81`	`{`
`76`	`82`	`$this->output = $output;`
	`83`	`+`
	`84`	`+ return $this;`
`77`	`85`	`}`
`78`	`86`
`79`	`87`	`/**`
`@@ -90,10 +98,14 @@ public function getOutput()`
`90`	`98`	`* Setter for object to be returned in the suggest option.`
`91`	`99`	`*`
`92`	`100`	`* @param object $payload`
	`101`	`+ *`
	`102`	`+ * @return $this`
`93`	`103`	`*/`
`94`	`104`	`public function setPayload($payload)`
`95`	`105`	`{`
`96`	`106`	`$this->payload = (object)$payload;`
	`107`	`+`
	`108`	`+ return $this;`
`97`	`109`	`}`
`98`	`110`
`99`	`111`	`/**`
`@@ -110,10 +122,14 @@ public function getPayload()`
`110`	`122`	`* Setter for a weight used to rank suggestions.`
`111`	`123`	`*`
`112`	`124`	`* @param int\|string $weight`
	`125`	`+ *`
	`126`	`+ * @return $this`
`113`	`127`	`*/`
`114`	`128`	`public function setWeight($weight)`
`115`	`129`	`{`
`116`	`130`	`$this->weight = $weight;`
	`131`	`+`
	`132`	`+ return $this;`
`117`	`133`	`}`
`118`	`134`
`119`	`135`	`/**`