Added additional return type enforcement

Author: GrahamCampbell

CHANGELOG.md

@@ -12,6 +12,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Updated to latest labels API
 * Made builder class final
 * Re-worked pagination
+* Client authenticate and setUrl now return void
+* Added additional return type enforcement
 
 [11.0.0-RC1]: https://github.com/GitLabPHP/Client/compare/10.4.0...11.0.0-RC1
 

src/Api/AbstractApi.php

@@ -20,6 +20,7 @@
 use Gitlab\HttpClient\Util\JsonArray;
 use Gitlab\HttpClient\Util\QueryStringBuilder;
 use Http\Message\MultipartStream\MultipartStreamBuilder;
+use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\StreamInterface;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
@@ -74,7 +75,7 @@ public function __construct(Client $client)
      *
      * @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['per_page'])) {
             $params['per_page'] = $this->perPage;
@@ -176,7 +177,7 @@ protected function delete(string $uri, array $params = [], array $headers = [])
      *
      * @return string
      */
-    protected static function encodePath($uri)
+    protected static function encodePath($uri): string
     {
         return \rawurlencode((string) $uri);
     }
@@ -187,7 +188,7 @@ protected static function encodePath($uri)
      *
      * @return string
      */
-    protected function getProjectPath($id, string $uri)
+    protected function getProjectPath($id, string $uri): string
     {
         return 'projects/'.self::encodePath($id).'/'.$uri;
     }
@@ -197,18 +198,18 @@ protected function getProjectPath($id, string $uri)
      *
      * @return OptionsResolver
      */
-    protected function createOptionsResolver()
+    protected function createOptionsResolver(): OptionsResolver
     {
         $resolver = new OptionsResolver();
         $resolver->setDefined('page')
             ->setAllowedTypes('page', 'int')
-            ->setAllowedValues('page', function ($value) {
+            ->setAllowedValues('page', function ($value): bool {
                 return $value > 0;
             })
         ;
         $resolver->setDefined('per_page')
             ->setAllowedTypes('per_page', 'int')
-            ->setAllowedValues('per_page', function ($value) {
+            ->setAllowedValues('per_page', function ($value): bool {
                 return $value > 0 && $value <= 100;
             })
         ;
@@ -224,7 +225,7 @@ protected function createOptionsResolver()
      *
      * @return string
      */
-    private static function prepareUri(string $uri, array $query = [])
+    private static function prepareUri(string $uri, array $query = []): string
     {
         $query = \array_filter($query, function ($value): bool {
             return null !== $value;
@@ -241,7 +242,7 @@ private static function prepareUri(string $uri, array $query = [])
      *
      * @return MultipartStreamBuilder
      */
-    private function createMultipartStreamBuilder(array $params = [], array $files = [])
+    private function createMultipartStreamBuilder(array $params = [], array $files = []): MultipartStreamBuilder
     {
         $builder = new MultipartStreamBuilder($this->client->getStreamFactory());
 
@@ -268,7 +269,7 @@ private function createMultipartStreamBuilder(array $params = [], array $files =
      *
      * @return StreamInterface
      */
-    private static function prepareMultipartBody(MultipartStreamBuilder $builder)
+    private static function prepareMultipartBody(MultipartStreamBuilder $builder): StreamInterface
     {
         return $builder->build();
     }
@@ -281,7 +282,7 @@ private static function prepareMultipartBody(MultipartStreamBuilder $builder)
      *
      * @return array<string,string>
      */
-    private static function addMultipartContentType(array $headers, MultipartStreamBuilder $builder)
+    private static function addMultipartContentType(array $headers, MultipartStreamBuilder $builder): array
     {
         $contentType = \sprintf('%s; boundary=%s', ResponseMediator::MULTIPART_CONTENT_TYPE, $builder->getBoundary());
 
@@ -295,7 +296,7 @@ private static function addMultipartContentType(array $headers, MultipartStreamB
      *
      * @return string|null
      */
-    private static function prepareJsonBody(array $params)
+    private static function prepareJsonBody(array $params): ?string
     {
         $params = \array_filter($params, function ($value): bool {
             return null !== $value;
@@ -315,7 +316,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);
     }
@@ -365,7 +366,7 @@ private static function tryFopen(string $filename, string $mode)
      *
      * @return string
      */
-    private static function guessFileContentType(string $file)
+    private static function guessFileContentType(string $file): string
     {
         if (!\class_exists(\finfo::class, false)) {
             return ResponseMediator::STREAM_CONTENT_TYPE;

src/Api/Issues.php

@@ -15,6 +15,7 @@
 namespace Gitlab\Api;
 
 use Symfony\Component\OptionsResolver\Options;
+use Symfony\Component\OptionsResolver\OptionsResolver;
 
 class Issues extends AbstractApi
 {
@@ -426,9 +427,9 @@ public function showParticipants($project_id, int $issue_iid)
     }
 
     /**
-     * {@inheritdoc}
+     * @return OptionsResolver
      */
-    protected function createOptionsResolver()
+    protected function createOptionsResolver(): OptionsResolver
     {
         $resolver = parent::createOptionsResolver();
         $booleanNormalizer = function (Options $resolver, $value) {

src/Api/IssuesStatistics.php

@@ -54,7 +54,7 @@ public function group($group_id, array $parameters)
     /**
      * @return OptionsResolver
      */
-    protected function createOptionsResolver()
+    protected function createOptionsResolver(): OptionsResolver
     {
         $resolver = new OptionsResolver();
 

src/Api/Jobs.php

@@ -236,9 +236,9 @@ public function play($project_id, int $job_id)
     }
 
     /**
-     * {@inheritdoc}
+     * @return OptionsResolver
      */
-    protected function createOptionsResolver()
+    protected function createOptionsResolver(): OptionsResolver
     {
         $allowedScopeValues = [
             self::SCOPE_CANCELED,

src/Api/Repositories.php

@@ -484,7 +484,10 @@ public function cherryPick($project_id, string $sha, array $params = [])
         return $this->post($this->getProjectPath($project_id, 'repository/commits/'.self::encodePath($sha).'/cherry_pick'), $params);
     }
 
-    protected function createOptionsResolver()
+    /**
+     * @return OptionsResolver
+     */
+    protected function createOptionsResolver(): OptionsResolver
     {
         $allowedTypeValues = [
             self::TYPE_BRANCH,