Added additional return type enforcement

Author: GrahamCampbell

CHANGELOG.md

@@ -7,6 +7,7 @@ CHANGE LOG
 * Dropped support for PHP 7.1
 * Made builder class final
 * Re-worked pagination
+* Added additional return type enforcement
 
 
 ## V3.3 (27/11/2020)

src/Api/AbstractApi.php

@@ -17,6 +17,7 @@
 use Bitbucket\HttpClient\Message\ResponseMediator;
 use Bitbucket\HttpClient\Util\JsonArray;
 use Bitbucket\HttpClient\Util\QueryStringBuilder;
+use Psr\Http\Message\ResponseInterface;
 
 /**
  * @author Joseph Bielawski <stloyd@gmail.com>
@@ -62,7 +63,7 @@ public function __construct(Client $client)
      *
      * @return Client
      */
-    protected function getClient()
+    protected function getClient(): Client
     {
         return $this->client;
     }
@@ -78,7 +79,7 @@ protected function getClient()
      *
      * @return \Psr\Http\Message\ResponseInterface
      */
-    protected function getAsResponse(string $uri, array $params = [], array $headers = [])
+    protected function getAsResponse(string $uri, array $params = [], array $headers = []): ResponseInterface
     {
         if (null !== $this->perPage && !isset($params['pagelen'])) {
             $params['pagelen'] = $this->perPage;
@@ -98,7 +99,7 @@ protected function getAsResponse(string $uri, array $params = [], array $headers
      *
      * @return array
      */
-    protected function get(string $uri, array $params = [], array $headers = [])
+    protected function get(string $uri, array $params = [], array $headers = []): array
     {
         $response = $this->getAsResponse($uri, $params, $headers);
 
@@ -116,7 +117,7 @@ protected function get(string $uri, array $params = [], array $headers = [])
      *
      * @return array
      */
-    protected function post(string $uri, array $params = [], array $headers = [])
+    protected function post(string $uri, array $params = [], array $headers = []): array
     {
         $body = self::prepareJsonBody($params);
 
@@ -138,7 +139,7 @@ protected function post(string $uri, array $params = [], array $headers = [])
      *
      * @return array
      */
-    protected function postRaw(string $uri, $body = null, array $headers = [])
+    protected function postRaw(string $uri, $body = null, array $headers = []): array
     {
         $response = $this->client->getHttpClient()->post(self::prepareUri($uri), $headers, $body ?? '');
 
@@ -156,7 +157,7 @@ protected function postRaw(string $uri, $body = null, array $headers = [])
      *
      * @return array
      */
-    protected function put(string $uri, array $params = [], array $headers = [])
+    protected function put(string $uri, array $params = [], array $headers = []): array
     {
         $body = self::prepareJsonBody($params);
 
@@ -178,7 +179,7 @@ protected function put(string $uri, array $params = [], array $headers = [])
      *
      * @return array
      */
-    protected function putRaw(string $uri, $body = null, array $headers = [])
+    protected function putRaw(string $uri, $body = null, array $headers = []): array
     {
         $response = $this->client->getHttpClient()->put(self::prepareUri($uri), $headers, $body ?? '');
 
@@ -196,7 +197,7 @@ protected function putRaw(string $uri, $body = null, array $headers = [])
      *
      * @return array
      */
-    protected function delete(string $uri, array $params = [], array $headers = [])
+    protected function delete(string $uri, array $params = [], array $headers = []): array
     {
         $body = self::prepareJsonBody($params);
 
@@ -218,7 +219,7 @@ protected function delete(string $uri, array $params = [], array $headers = [])
      *
      * @return array
      */
-    protected function deleteRaw(string $uri, $body = null, array $headers = [])
+    protected function deleteRaw(string $uri, $body = null, array $headers = []): array
     {
         $response = $this->client->getHttpClient()->delete(self::prepareUri($uri), $headers, $body ?? '');
 
@@ -233,7 +234,7 @@ protected function deleteRaw(string $uri, $body = null, array $headers = [])
      *
      * @return string
      */
-    private static function prepareUri(string $uri, array $query = [])
+    private static function prepareUri(string $uri, array $query = []): string
     {
         return \sprintf('%s%s%s', self::URI_PREFIX, $uri, QueryStringBuilder::build($query));
     }
@@ -245,7 +246,7 @@ private static function prepareUri(string $uri, array $query = [])
      *
      * @return string|null
      */
-    private static function prepareJsonBody(array $params)
+    private static function prepareJsonBody(array $params): ?string
     {
         if (0 === \count($params)) {
             return null;
@@ -261,7 +262,7 @@ private static function prepareJsonBody(array $params)
      *
      * @return array<string,string>
      */
-    private static function addJsonContentType(array $headers)
+    private static function addJsonContentType(array $headers): array
     {
         return \array_merge([ResponseMediator::CONTENT_TYPE_HEADER => ResponseMediator::JSON_CONTENT_TYPE], $headers);
     }

src/Client.php

@@ -26,12 +26,14 @@
 use Bitbucket\HttpClient\Plugin\Authentication;
 use Bitbucket\HttpClient\Plugin\ExceptionThrower;
 use Bitbucket\HttpClient\Plugin\History;
+use Http\Client\Common\HttpMethodsClientInterface;
 use Http\Client\Common\Plugin\AddHostPlugin;
 use Http\Client\Common\Plugin\HeaderDefaultsPlugin;
 use Http\Client\Common\Plugin\HistoryPlugin;
 use Http\Client\Common\Plugin\RedirectPlugin;
 use Http\Discovery\Psr17FactoryDiscovery;
 use Psr\Http\Client\ClientInterface;
+use Psr\Http\Message\ResponseInterface;
 
 /**
  * The Bitbucket API 2.0 client.
@@ -121,7 +123,7 @@ public function __construct(Builder $httpClientBuilder = null)
      *
      * @return Client
      */
-    public static function createWithHttpClient(ClientInterface $httpClient)
+    public static function createWithHttpClient(ClientInterface $httpClient): self
     {
         $builder = new Builder($httpClient);
 
@@ -131,47 +133,47 @@ public static function createWithHttpClient(ClientInterface $httpClient)
     /**
      * @return \Bitbucket\Api\Addon
      */
-    public function addon()
+    public function addon(): Addon
     {
         return new Addon($this);
     }
 
     /**
      * @return \Bitbucket\Api\CurrentUser
      */
-    public function currentUser()
+    public function currentUser(): CurrentUser
     {
         return new CurrentUser($this);
     }
 
     /**
      * @return \Bitbucket\Api\HookEvents
      */
-    public function hookEvents()
+    public function hookEvents(): HookEvents
     {
         return new HookEvents($this);
     }
 
     /**
      * @return \Bitbucket\Api\PullRequests
      */
-    public function pullRequests()
+    public function pullRequests(): PullRequests
     {
         return new PullRequests($this);
     }
 
     /**
      * @return \Bitbucket\Api\Repositories
      */
-    public function repositories()
+    public function repositories(): Repositories
     {
         return new Repositories($this);
     }
 
     /**
      * @return \Bitbucket\Api\Snippets
      */
-    public function snippets()
+    public function snippets(): Snippets
     {
         return new Snippets($this);
     }
@@ -181,7 +183,7 @@ public function snippets()
      *
      * @return \Bitbucket\Api\Users
      */
-    public function users(string $username)
+    public function users(string $username): Users
     {
         return new Users($this, $username);
     }
@@ -191,7 +193,7 @@ public function users(string $username)
      *
      * @return \Bitbucket\Api\Workspaces
      */
-    public function workspaces(string $workspace)
+    public function workspaces(string $workspace): Workspaces
     {
         return new Workspaces($this, $workspace);
     }
@@ -229,7 +231,7 @@ public function setUrl(string $url): void
      *
      * @return \Psr\Http\Message\ResponseInterface|null
      */
-    public function getLastResponse()
+    public function getLastResponse(): ?ResponseInterface
     {
         return $this->responseHistory->getLastResponse();
     }
@@ -239,7 +241,7 @@ public function getLastResponse()
      *
      * @return \Http\Client\Common\HttpMethodsClientInterface
      */
-    public function getHttpClient()
+    public function getHttpClient(): HttpMethodsClientInterface
     {
         return $this->getHttpClientBuilder()->getHttpClient();
     }
@@ -249,7 +251,7 @@ public function getHttpClient()
      *
      * @return \Bitbucket\HttpClient\Builder
      */
-    protected function getHttpClientBuilder()
+    protected function getHttpClientBuilder(): Builder
     {
         return $this->httpClientBuilder;
     }

src/HttpClient/Builder.php

@@ -14,6 +14,7 @@
 namespace Bitbucket\HttpClient;
 
 use Http\Client\Common\HttpMethodsClient;
+use Http\Client\Common\HttpMethodsClientInterface;
 use Http\Client\Common\Plugin;
 use Http\Client\Common\Plugin\Cache\Generator\HeaderCacheKeyGenerator;
 use Http\Client\Common\Plugin\CachePlugin;
@@ -101,7 +102,7 @@ public function __construct(
     /**
      * @return \Http\Client\Common\HttpMethodsClientInterface
      */
-    public function getHttpClient()
+    public function getHttpClient(): HttpMethodsClientInterface
     {
         if (null === $this->pluginClient) {
             $plugins = $this->plugins;

src/HttpClient/Message/FileResource.php

@@ -62,7 +62,7 @@ public function __construct(string $name, $resource, array $options = [])
      *
      * @return string
      */
-    public function getName()
+    public function getName(): string
     {
         return $this->name;
     }
@@ -82,7 +82,7 @@ public function getResource()
      *
      * @return array
      */
-    public function getOptions()
+    public function getOptions(): array
     {
         return $this->options;
     }

src/HttpClient/Message/ResponseMediator.php

@@ -75,7 +75,7 @@ public static function getContent(ResponseInterface $response)
      *
      * @return array<string,string>
      */
-    public static function getPagination(ResponseInterface $response)
+    public static function getPagination(ResponseInterface $response): array
     {
         try {
             /** @var array<string,string> */
@@ -102,7 +102,7 @@ private static function paginationFilter($key)
      *
      * @return string|null
      */
-    public static function getErrorMessage(ResponseInterface $response)
+    public static function getErrorMessage(ResponseInterface $response): ?string
     {
         try {
             /** @var scalar|array */
@@ -121,7 +121,7 @@ public static function getErrorMessage(ResponseInterface $response)
      *
      * @return string|null
      */
-    private static function getMessageFromError(array $error)
+    private static function getMessageFromError(array $error): ?string
     {
         /** @var scalar|array */
         $message = $error['message'] ?? '';
@@ -150,7 +150,7 @@ private static function getMessageFromError(array $error)
      *
      * @return string
      */
-    private static function getDetailAsString(array $error)
+    private static function getDetailAsString(array $error): string
     {
         /** @var string|array $detail */
         $detail = $error['detail'] ?? '';

src/HttpClient/Plugin/Authentication.php

@@ -78,7 +78,7 @@ public function handleRequest(RequestInterface $request, callable $next, callabl
      *
      * @return string
      */
-    private static function buildAuthorizationHeader(string $method, string $token, string $password = null)
+    private static function buildAuthorizationHeader(string $method, string $token, string $password = null): string
     {
         switch ($method) {
             case Client::AUTH_HTTP_PASSWORD:

src/HttpClient/Plugin/ExceptionThrower.php

@@ -14,6 +14,7 @@
 namespace Bitbucket\HttpClient\Plugin;
 
 use Bitbucket\Exception\ApiLimitExceededException;
+use Bitbucket\Exception\ExceptionInterface;
 use Bitbucket\Exception\RuntimeException;
 use Bitbucket\Exception\ValidationFailedException;
 use Bitbucket\HttpClient\Message\ResponseMediator;
@@ -63,7 +64,7 @@ public function handleRequest(RequestInterface $request, callable $next, callabl
      *
      * @return \Bitbucket\Exception\ErrorException|\Bitbucket\Exception\RuntimeException
      */
-    private static function createException(int $status, string $message)
+    private static function createException(int $status, string $message): ExceptionInterface
     {
         if (400 === $status || 422 === $status) {
             return new ValidationFailedException($message, $status);

src/HttpClient/Plugin/History.php

@@ -40,7 +40,7 @@ final class History implements Journal
      *
      * @return \Psr\Http\Message\ResponseInterface|null
      */
-    public function getLastResponse()
+    public function getLastResponse(): ?ResponseInterface
     {
         return $this->lastResponse;
     }

src/HttpClient/Util/JsonArray.php

@@ -33,7 +33,7 @@ final class JsonArray
      *
      * @return array
      */
-    public static function decode(string $json)
+    public static function decode(string $json): array
     {
         /** @var scalar|array|null */
         $data = \json_decode($json, true);
@@ -58,7 +58,7 @@ public static function decode(string $json)
      *
      * @return string
      */
-    public static function encode(array $value)
+    public static function encode(array $value): string
     {
         $json = \json_encode($value);