Add @return to define the return type for non-PHP 7.2 compatible ty…

…pes (#444)
guzzle · Sep 19, 2021 · a613efc · a613efc
1 parent 4095c77
commit a613efc
Show file tree

Hide file tree

Showing 7 changed files with 40 additions and 0 deletions.
diff --git a/src/AppendStream.php b/src/AppendStream.php
@@ -237,6 +237,11 @@ public function write($string): int
         throw new \RuntimeException('Cannot write to an AppendStream');
     }
 
+    /**
+     * {@inheritdoc}
+     *
+     * @return mixed
+     */
     public function getMetadata($key = null)
     {
         return $key ? null : [];

diff --git a/src/BufferStream.php b/src/BufferStream.php
@@ -133,6 +133,11 @@ public function write($string): int
         return strlen($string);
     }
 
+    /**
+     * {@inheritdoc}
+     *
+     * @return mixed
+     */
     public function getMetadata($key = null)
     {
         if ($key === 'hwm') {

diff --git a/src/FnStream.php b/src/FnStream.php
@@ -167,6 +167,11 @@ public function getContents(): string
         return call_user_func($this->_fn_getContents);
     }
 
+    /**
+     * {@inheritdoc}
+     *
+     * @return mixed
+     */
     public function getMetadata($key = null)
     {
         return call_user_func($this->_fn_getMetadata, $key);

diff --git a/src/PumpStream.php b/src/PumpStream.php
@@ -148,6 +148,11 @@ public function getContents(): string
         return $result;
     }
 
+    /**
+     * {@inheritdoc}
+     *
+     * @return mixed
+     */
     public function getMetadata($key = null)
     {
         if (!$key) {

diff --git a/src/ServerRequest.php b/src/ServerRequest.php
@@ -285,6 +285,11 @@ public function withQueryParams(array $query): ServerRequestInterface
         return $new;
     }
 
+    /**
+     * {@inheritdoc}
+     *
+     * @return array|object|null
+     */
     public function getParsedBody()
     {
         return $this->parsedBody;
@@ -303,6 +308,11 @@ public function getAttributes(): array
         return $this->attributes;
     }
 
+    /**
+     * {@inheritdoc}
+     *
+     * @return mixed
+     */
     public function getAttribute($attribute, $default = null)
     {
         if (false === array_key_exists($attribute, $this->attributes)) {

diff --git a/src/Stream.php b/src/Stream.php
@@ -257,6 +257,11 @@ public function write($string): int
         return $result;
     }
 
+    /**
+     * {@inheritdoc}
+     *
+     * @return mixed
+     */
     public function getMetadata($key = null)
     {
         if (!isset($this->stream)) {

diff --git a/src/StreamDecoratorTrait.php b/src/StreamDecoratorTrait.php
@@ -78,6 +78,11 @@ public function close(): void
         $this->stream->close();
     }
 
+    /**
+     * {@inheritdoc}
+     *
+     * @return mixed
+     */
     public function getMetadata($key = null)
     {
         return $this->stream->getMetadata($key);