Method docblocks

Author: WyriHaximus

src/Definition/RequestToken.php

@@ -10,7 +10,7 @@ final class RequestToken implements Token
     private $requestToken;
 
     /**
-     * @param string $token
+     * @param string $requestToken
      */
     public function __construct($requestToken)
     {

src/RequestSigning/RequestSigner.php

@@ -145,20 +145,31 @@ private function mergeSignatureParameter(RequestInterface $request, array $param
         return $parameters;
     }
 
+    /**
+     * @return string
+     */
     private function generateTimestamp()
     {
         $dateTime = new \DateTimeImmutable();
 
         return $dateTime->format('U');
     }
 
+    /**
+     * @param int $length
+     * @return string
+     */
     private function generateNonce($length = 32)
     {
         $pool = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ';
 
         return substr(str_shuffle(str_repeat($pool, 5)), 0, $length);
     }
 
+    /**
+     * @param array $parameters
+     * @return string
+     */
     private function generateAuthorizationheader(array $parameters)
     {
         array_walk($parameters, function (&$value, $key) {

src/Signature/HmacMd5Signature.php

@@ -4,6 +4,9 @@
 
 final class HmacMd5Signature extends HmacSignature
 {
+    /**
+     * @return string
+     */
     protected function getHashingAlgorithm()
     {
         return 'md5';

src/Signature/HmacSha1Signature.php

@@ -4,6 +4,9 @@
 
 final class HmacSha1Signature extends HmacSignature
 {
+    /**
+     * @return string
+     */
     protected function getHashingAlgorithm()
     {
         return 'sha1';

src/Signature/HmacSha256Signature.php

@@ -4,6 +4,9 @@
 
 final class HmacSha256Signature extends HmacSignature
 {
+    /**
+     * @return string
+     */
     protected function getHashingAlgorithm()
     {
         return 'sha256';

src/Signature/HmacSha384Signature.php

@@ -4,6 +4,9 @@
 
 final class HmacSha384Signature extends HmacSignature
 {
+    /**
+     * @return string
+     */
     protected function getHashingAlgorithm()
     {
         return 'sha384';

src/Signature/HmacSha512Signature.php

@@ -4,6 +4,9 @@
 
 final class HmacSha512Signature extends HmacSignature
 {
+    /**
+     * @return string
+     */
     protected function getHashingAlgorithm()
     {
         return 'sha512';

src/Signature/HmacSignature.php

@@ -6,13 +6,25 @@
 
 abstract class HmacSignature extends Signature
 {
+    /**
+     * @return string
+     */
     abstract protected function getHashingAlgorithm();
 
+    /**
+     * @return string
+     */
     public function getMethod()
     {
         return sprintf('HMAC-%s', strtoupper($this->getHashingAlgorithm()));
     }
 
+    /**
+     * @param UriInterface $uri
+     * @param array $parameters
+     * @param string $method
+     * @return string
+     */
     public function sign(UriInterface $uri, array $parameters = [], $method = 'POST')
     {
         $baseString = $this->generateBaseString($uri, $parameters, $method);
@@ -58,6 +70,10 @@ private function generateBaseString(UriInterface $uri, array $parameters = [], $
         return implode('&', $baseString);
     }
 
+    /**
+     * @param $string
+     * @return string
+     */
     private function hash($string)
     {
         return hash_hmac($this->getHashingAlgorithm(), $string, $this->getKey(), true);

src/Signature/Signature.php

@@ -49,6 +49,9 @@ public function withoutTokenSecret()
         return $clone;
     }
 
+    /**
+     * @return string
+     */
     protected function getKey()
     {
         $key = rawurlencode((string) $this->consumerSecret).'&';
@@ -60,7 +63,16 @@ protected function getKey()
         return $key;
     }
 
+    /**
+     * @return string
+     */
     abstract public function getMethod();
 
+    /**
+     * @param UriInterface $uri
+     * @param array $parameters
+     * @param string $method
+     * @return string
+     */
     abstract public function sign(UriInterface $uri, array $parameters = [], $method = 'POST');
 }