Scalar return types and type hints

WyriHaximus · WyriHaximus · commit 90f131f5313d · 2016-11-21T22:44:41.000+01:00
diff --git a/src/Definition/AccessToken.php b/src/Definition/AccessToken.php
@@ -20,23 +20,23 @@ public function __construct($accessToken)
     /**
      * @return string
      */
-    public function getAccessToken()
+    public function getAccessToken(): string
     {
         return $this->accessToken;
     }
 
     /**
      * @return string
      */
-    public function getToken()
+    public function getToken(): string
     {
         return (string) $this->accessToken;
     }
 
     /**
      * @return string
      */
-    public function __toString()
+    public function __toString(): string
     {
         return (string) $this->accessToken;
     }
diff --git a/src/Definition/ConsumerKey.php b/src/Definition/ConsumerKey.php
@@ -20,15 +20,15 @@ public function __construct($consumerKey)
     /**
      * @return string
      */
-    public function getConsumerKey()
+    public function getConsumerKey(): string
     {
         return (string) $this->consumerKey;
     }
 
     /**
      * @return string
      */
-    public function __toString()
+    public function __toString(): string
     {
         return (string) $this->consumerKey;
     }
diff --git a/src/Definition/ConsumerSecret.php b/src/Definition/ConsumerSecret.php
@@ -20,15 +20,15 @@ public function __construct($consumerSecret)
     /**
      * @return string
      */
-    public function getConsumerSecret()
+    public function getConsumerSecret(): string
     {
         return (string) $this->consumerSecret;
     }
 
     /**
      * @return string
      */
-    public function __toString()
+    public function __toString(): string
     {
         return (string) $this->consumerSecret;
     }
diff --git a/src/Definition/RequestToken.php b/src/Definition/RequestToken.php
@@ -20,23 +20,23 @@ public function __construct($requestToken)
     /**
      * @return string
      */
-    public function getRequestToken()
+    public function getRequestToken(): string
     {
         return $this->requestToken;
     }
 
     /**
      * @return string
      */
-    public function getToken()
+    public function getToken(): string
     {
         return (string) $this->requestToken;
     }
 
     /**
      * @return string
      */
-    public function __toString()
+    public function __toString(): string
     {
         return (string) $this->requestToken;
     }
diff --git a/src/Definition/TokenSecret.php b/src/Definition/TokenSecret.php
@@ -20,15 +20,15 @@ public function __construct($tokenSecret)
     /**
      * @return string
      */
-    public function getTokenSecret()
+    public function getTokenSecret(): string
     {
         return (string) $this->tokenSecret;
     }
 
     /**
      * @return string
      */
-    public function __toString()
+    public function __toString(): string
     {
         return (string) $this->tokenSecret;
     }
diff --git a/src/RequestSigning/RequestSigner.php b/src/RequestSigning/RequestSigner.php
@@ -52,9 +52,9 @@ public function __construct(ConsumerKey $consumerKey, ConsumerSecret $consumerSe
     /**
      * @param AccessToken $accessToken
      * @param TokenSecret $tokenSecret
-     * @return static
+     * @return RequestSigner
      */
-    public function withAccessToken(AccessToken $accessToken, TokenSecret $tokenSecret)
+    public function withAccessToken(AccessToken $accessToken, TokenSecret $tokenSecret): RequestSigner
     {
         $clone = clone $this;
         $clone->accessToken = $accessToken;
@@ -67,9 +67,9 @@ public function withAccessToken(AccessToken $accessToken, TokenSecret $tokenSecr
     }
 
     /**
-     * @return static
+     * @return RequestSigner
      */
-    public function withoutAccessToken()
+    public function withoutAccessToken(): RequestSigner
     {
         $clone = clone $this;
         $clone->accessToken = null;
@@ -85,7 +85,7 @@ public function withoutAccessToken()
      * @param RequestInterface $request
      * @return RequestInterface
      */
-    public function sign(RequestInterface $request)
+    public function sign(RequestInterface $request): RequestInterface
     {
         $parameters = [
             'oauth_consumer_key' => (string) $this->consumerKey,
@@ -106,9 +106,9 @@ public function sign(RequestInterface $request)
 
     public function signToRequestAuthorization(
         RequestInterface $request,
-        $callbackUri,
+        string $callbackUri,
         array $additionalParameters = []
-    ) {
+    ): RequestInterface {
         $parameters = [
             'oauth_consumer_key' => (string) $this->consumerKey,
             'oauth_nonce' => $this->generateNonce(),
@@ -130,7 +130,7 @@ public function signToRequestAuthorization(
      * @param array $parameters
      * @return array
      */
-    private function mergeSignatureParameter(RequestInterface $request, array $parameters)
+    private function mergeSignatureParameter(RequestInterface $request, array $parameters): array
     {
         $body = [];
         if ($request->getMethod() === 'POST' &&
@@ -148,7 +148,7 @@ private function mergeSignatureParameter(RequestInterface $request, array $param
     /**
      * @return string
      */
-    private function generateTimestamp()
+    private function generateTimestamp(): string
     {
         $dateTime = new \DateTimeImmutable();
 
@@ -159,7 +159,7 @@ private function generateTimestamp()
      * @param int $length
      * @return string
      */
-    private function generateNonce($length = 32)
+    private function generateNonce(int $length = 32): string
     {
         $pool = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ';
 
@@ -170,7 +170,7 @@ private function generateNonce($length = 32)
      * @param array $parameters
      * @return string
      */
-    private function generateAuthorizationheader(array $parameters)
+    private function generateAuthorizationheader(array $parameters): string
     {
         array_walk($parameters, function (&$value, $key) {
             $value = rawurlencode($key).'="'.rawurlencode($value).'"';
diff --git a/src/Signature/HmacMd5Signature.php b/src/Signature/HmacMd5Signature.php
@@ -7,7 +7,7 @@ final class HmacMd5Signature extends HmacSignature
     /**
      * @return string
      */
-    protected function getHashingAlgorithm()
+    protected function getHashingAlgorithm(): string
     {
         return 'md5';
     }
diff --git a/src/Signature/HmacSha1Signature.php b/src/Signature/HmacSha1Signature.php
@@ -7,7 +7,7 @@ final class HmacSha1Signature extends HmacSignature
     /**
      * @return string
      */
-    protected function getHashingAlgorithm()
+    protected function getHashingAlgorithm(): string
     {
         return 'sha1';
     }
diff --git a/src/Signature/HmacSha256Signature.php b/src/Signature/HmacSha256Signature.php
@@ -7,7 +7,7 @@ final class HmacSha256Signature extends HmacSignature
     /**
      * @return string
      */
-    protected function getHashingAlgorithm()
+    protected function getHashingAlgorithm(): string
     {
         return 'sha256';
     }
diff --git a/src/Signature/HmacSha384Signature.php b/src/Signature/HmacSha384Signature.php
@@ -7,7 +7,7 @@ final class HmacSha384Signature extends HmacSignature
     /**
      * @return string
      */
-    protected function getHashingAlgorithm()
+    protected function getHashingAlgorithm(): string
     {
         return 'sha384';
     }
diff --git a/src/Signature/HmacSha512Signature.php b/src/Signature/HmacSha512Signature.php
@@ -7,7 +7,7 @@ final class HmacSha512Signature extends HmacSignature
     /**
      * @return string
      */
-    protected function getHashingAlgorithm()
+    protected function getHashingAlgorithm(): string
     {
         return 'sha512';
     }
diff --git a/src/Signature/HmacSignature.php b/src/Signature/HmacSignature.php
@@ -9,12 +9,12 @@ abstract class HmacSignature extends Signature
     /**
      * @return string
      */
-    abstract protected function getHashingAlgorithm();
+    abstract protected function getHashingAlgorithm(): string;
 
     /**
      * @return string
      */
-    public function getMethod()
+    public function getMethod(): string
     {
         return sprintf('HMAC-%s', strtoupper($this->getHashingAlgorithm()));
     }
@@ -25,7 +25,7 @@ public function getMethod()
      * @param string $method
      * @return string
      */
-    public function sign(UriInterface $uri, array $parameters = [], $method = 'POST')
+    public function sign(UriInterface $uri, array $parameters = [], string $method = 'POST'): string
     {
         $baseString = $this->generateBaseString($uri, $parameters, $method);
 
@@ -38,7 +38,7 @@ public function sign(UriInterface $uri, array $parameters = [], $method = 'POST'
      * @param string $method
      * @return string
      */
-    private function generateBaseString(UriInterface $uri, array $parameters = [], $method = 'POST')
+    private function generateBaseString(UriInterface $uri, array $parameters = [], string $method = 'POST'): string
     {
         $baseString = [rawurlencode($method)];
 
@@ -74,7 +74,7 @@ private function generateBaseString(UriInterface $uri, array $parameters = [], $
      * @param $string
      * @return string
      */
-    private function hash($string)
+    private function hash(string $string): string
     {
         return hash_hmac($this->getHashingAlgorithm(), $string, $this->getKey(), true);
     }
diff --git a/src/Signature/Signature.php b/src/Signature/Signature.php
@@ -28,9 +28,9 @@ public function __construct(ConsumerSecret $consumerSecret)
 
     /**
      * @param TokenSecret $tokenSecret
-     * @return static
+     * @return Signature
      */
-    public function withTokenSecret(TokenSecret $tokenSecret)
+    public function withTokenSecret(TokenSecret $tokenSecret): Signature
     {
         $clone = clone $this;
         $clone->tokenSecret = $tokenSecret;
@@ -39,9 +39,9 @@ public function withTokenSecret(TokenSecret $tokenSecret)
     }
 
     /**
-     * @return static
+     * @return Signature
      */
-    public function withoutTokenSecret()
+    public function withoutTokenSecret(): Signature
     {
         $clone = clone $this;
         $clone->tokenSecret = null;
@@ -52,7 +52,7 @@ public function withoutTokenSecret()
     /**
      * @return string
      */
-    protected function getKey()
+    protected function getKey(): string
     {
         $key = rawurlencode((string) $this->consumerSecret).'&';
 
@@ -66,13 +66,13 @@ protected function getKey()
     /**
      * @return string
      */
-    abstract public function getMethod();
+    abstract public function getMethod(): string;
 
     /**
      * @param UriInterface $uri
      * @param array $parameters
      * @param string $method
      * @return string
      */
-    abstract public function sign(UriInterface $uri, array $parameters = [], $method = 'POST');
+    abstract public function sign(UriInterface $uri, array $parameters = [], string $method = 'POST'): string;
 }
diff --git a/tests/Signature/HmacMd5SignatureTest.php b/tests/Signature/HmacMd5SignatureTest.php
@@ -15,7 +15,7 @@ public function testGetMethod()
         $this->assertSame('HMAC-MD5', (new HmacMd5Signature(new ConsumerSecret('secret')))->getMethod());
     }
 
-    public function provideSign()
+    public function provideSign(): array
     {
         return [
             [
@@ -46,7 +46,7 @@ public function provideSign()
      * @param $signedSignature
      * @dataProvider provideSign
      */
-    public function testSign(UriInterface $uri, $signedSignature, $signedTokenSecretSignature)
+    public function testSign(UriInterface $uri, string $signedSignature, string $signedTokenSecretSignature)
     {
         $secret = new ConsumerSecret('consumerSecret');
         $signature = new HmacMd5Signature($secret);
diff --git a/tests/Signature/HmacSha1SignatureTest.php b/tests/Signature/HmacSha1SignatureTest.php
@@ -15,7 +15,7 @@ public function testGetMethod()
         $this->assertSame('HMAC-SHA1', (new HmacSha1Signature(new ConsumerSecret('secret')))->getMethod());
     }
 
-    public function provideSign()
+    public function provideSign(): array
     {
         return [
             [
@@ -46,7 +46,7 @@ public function provideSign()
      * @param $signedSignature
      * @dataProvider provideSign
      */
-    public function testSign(UriInterface $uri, $signedSignature, $signedTokenSecretSignature)
+    public function testSign(UriInterface $uri, string $signedSignature, string $signedTokenSecretSignature)
     {
         $secret = new ConsumerSecret('consumerSecret');
         $signature = new HmacSha1Signature($secret);
diff --git a/tests/Signature/HmacSha256SignatureTest.php b/tests/Signature/HmacSha256SignatureTest.php
@@ -15,7 +15,7 @@ public function testGetMethod()
         $this->assertSame('HMAC-SHA256', (new HmacSha256Signature(new ConsumerSecret('secret')))->getMethod());
     }
 
-    public function provideSign()
+    public function provideSign(): array
     {
         return [
             [
@@ -46,7 +46,7 @@ public function provideSign()
      * @param $signedSignature
      * @dataProvider provideSign
      */
-    public function testSign(UriInterface $uri, $signedSignature, $signedTokenSecretSignature)
+    public function testSign(UriInterface $uri, string $signedSignature, string $signedTokenSecretSignature)
     {
         $secret = new ConsumerSecret('consumerSecret');
         $signature = new HmacSha256Signature($secret);
diff --git a/tests/Signature/HmacSha384SignatureTest.php b/tests/Signature/HmacSha384SignatureTest.php
@@ -15,7 +15,7 @@ public function testGetMethod()
         $this->assertSame('HMAC-SHA384', (new HmacSha384Signature(new ConsumerSecret('secret')))->getMethod());
     }
 
-    public function provideSign()
+    public function provideSign(): array
     {
         return [
             [
@@ -46,7 +46,7 @@ public function provideSign()
      * @param $signedSignature
      * @dataProvider provideSign
      */
-    public function testSign(UriInterface $uri, $signedSignature, $signedTokenSecretSignature)
+    public function testSign(UriInterface $uri, string $signedSignature, string $signedTokenSecretSignature)
     {
         $secret = new ConsumerSecret('consumerSecret');
         $signature = new HmacSha384Signature($secret);
diff --git a/tests/Signature/HmacSha512SignatureTest.php b/tests/Signature/HmacSha512SignatureTest.php

Original file line number	Diff line number	Diff line change
`@@ -20,23 +20,23 @@ public function __construct($accessToken)`
`20`	`20`	`/**`
`21`	`21`	`* @return string`
`22`	`22`	`*/`
`23`		`- public function getAccessToken()`
	`23`	`+ public function getAccessToken(): string`
`24`	`24`	`{`
`25`	`25`	`return $this->accessToken;`
`26`	`26`	`}`
`27`	`27`
`28`	`28`	`/**`
`29`	`29`	`* @return string`
`30`	`30`	`*/`
`31`		`- public function getToken()`
	`31`	`+ public function getToken(): string`
`32`	`32`	`{`
`33`	`33`	`return (string) $this->accessToken;`
`34`	`34`	`}`
`35`	`35`
`36`	`36`	`/**`
`37`	`37`	`* @return string`
`38`	`38`	`*/`
`39`		`- public function __toString()`
	`39`	`+ public function __toString(): string`
`40`	`40`	`{`
`41`	`41`	`return (string) $this->accessToken;`
`42`	`42`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,15 +20,15 @@ public function __construct($consumerKey)`
`20`	`20`	`/**`
`21`	`21`	`* @return string`
`22`	`22`	`*/`
`23`		`- public function getConsumerKey()`
	`23`	`+ public function getConsumerKey(): string`
`24`	`24`	`{`
`25`	`25`	`return (string) $this->consumerKey;`
`26`	`26`	`}`
`27`	`27`
`28`	`28`	`/**`
`29`	`29`	`* @return string`
`30`	`30`	`*/`
`31`		`- public function __toString()`
	`31`	`+ public function __toString(): string`
`32`	`32`	`{`
`33`	`33`	`return (string) $this->consumerKey;`
`34`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ final class HmacMd5Signature extends HmacSignature`
`7`	`7`	`/**`
`8`	`8`	`* @return string`
`9`	`9`	`*/`
`10`		`- protected function getHashingAlgorithm()`
	`10`	`+ protected function getHashingAlgorithm(): string`
`11`	`11`	`{`
`12`	`12`	`return 'md5';`
`13`	`13`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ final class HmacSha1Signature extends HmacSignature`
`7`	`7`	`/**`
`8`	`8`	`* @return string`
`9`	`9`	`*/`
`10`		`- protected function getHashingAlgorithm()`
	`10`	`+ protected function getHashingAlgorithm(): string`
`11`	`11`	`{`
`12`	`12`	`return 'sha1';`
`13`	`13`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ final class HmacSha256Signature extends HmacSignature`
`7`	`7`	`/**`
`8`	`8`	`* @return string`
`9`	`9`	`*/`
`10`		`- protected function getHashingAlgorithm()`
	`10`	`+ protected function getHashingAlgorithm(): string`
`11`	`11`	`{`
`12`	`12`	`return 'sha256';`
`13`	`13`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ final class HmacSha384Signature extends HmacSignature`
`7`	`7`	`/**`
`8`	`8`	`* @return string`
`9`	`9`	`*/`
`10`		`- protected function getHashingAlgorithm()`
	`10`	`+ protected function getHashingAlgorithm(): string`
`11`	`11`	`{`
`12`	`12`	`return 'sha384';`
`13`	`13`	`}`