fix: add phpdocs

Signed-off-by: Mateusz Cholewka <mateusz@cholewka.com.pl>

Author: mtk3d

src/Prometheus/Storage/AbstractRedis.php

@@ -56,7 +56,6 @@ public function wipeStorage(): void
         $searchPattern = '';
 
         $globalPrefix = $this->redis->getOption(RedisClient::OPT_PREFIX);
-        // @phpstan-ignore-next-line false positive, phpstan thinks getOptions returns int
         if (is_string($globalPrefix)) {
             $searchPattern .= $globalPrefix;
         }
@@ -183,15 +182,15 @@ public function updateSummary(array $data): void
         if ($json === false) {
             throw new RuntimeException(json_last_error_msg());
         }
-        $this->redis->setNx($metaKey, $json); /** @phpstan-ignore-line */
+        $this->redis->setNx($metaKey, $json);
 
         // store value key
         $valueKey = $summaryKey.':'.$this->valueKey($data);
         $json = json_encode($this->encodeLabelValues($data['labelValues']));
         if ($json === false) {
             throw new RuntimeException(json_last_error_msg());
         }
-        $this->redis->setNx($valueKey, $json); /** @phpstan-ignore-line */
+        $this->redis->setNx($valueKey, $json);
 
         // trick to handle uniqid collision
         $done = false;
@@ -370,12 +369,10 @@ protected function collectHistograms(): array
 
     protected function removePrefixFromKey(string $key): string
     {
-        // @phpstan-ignore-next-line false positive, phpstan thinks getOptions returns int
         if ($this->redis->getOption(RedisClient::OPT_PREFIX) === null) {
             return $key;
         }
 
-        // @phpstan-ignore-next-line false positive, phpstan thinks getOptions returns int
         return substr($key, strlen($this->redis->getOption(RedisClient::OPT_PREFIX)));
     }
 

src/Prometheus/Storage/Predis.php

@@ -45,6 +45,7 @@ class Predis extends AbstractRedis
     /**
      * Redis constructor.
      *
+     * @param  mixed[]  $parameters
      * @param  mixed[]  $options
      */
     public function __construct(array $parameters = [], array $options = [])
@@ -71,7 +72,7 @@ public static function fromExistingConnection(Client $client): self
         ];
 
         $self = new self;
-        $self->redis = new PredisClient($client, self::$defaultParameters, $allOptions);
+        $self->redis = new PredisClient($client, $allOptions);
 
         return $self;
     }

src/Prometheus/Storage/RedisClients/PHPRedis.php

@@ -13,19 +13,28 @@ class PHPRedis implements RedisClient
      */
     private $redis;
 
+    /**
+     * @var mixed[]
+     */
     private $options = [];
 
     /**
      * @var bool
      */
     private $connectionInitialized = false;
 
+    /**
+     * @param  mixed[]  $options
+     */
     public function __construct(\Redis $redis, array $options)
     {
         $this->redis = $redis;
         $this->options = $options;
     }
 
+    /**
+     * @param  mixed[]  $options
+     */
     public static function create(array $options): self
     {
         $redis = new \Redis;
@@ -43,22 +52,22 @@ public function eval(string $script, array $args = [], int $num_keys = 0): void
         $this->redis->eval($script, $args, $num_keys);
     }
 
-    public function set(string $key, mixed $value, mixed $options = null): void
+    public function set(string $key, mixed $value, mixed $options = null): bool
     {
-        $this->redis->set($key, $value, $options);
+        return $this->redis->set($key, $value, $options);
     }
 
     public function setNx(string $key, mixed $value): void
     {
-        $this->redis->setNx($key, $value);
+        $this->redis->setNx($key, $value); /** @phpstan-ignore-line */
     }
 
     public function hSetNx(string $key, string $field, mixed $value): bool
     {
         return $this->redis->hSetNx($key, $field, $value);
     }
 
-    public function sMembers(string $key): array|false
+    public function sMembers(string $key): array
     {
         return $this->redis->sMembers($key);
     }

src/Prometheus/Storage/RedisClients/Predis.php

@@ -12,17 +12,30 @@ class Predis implements RedisClient
         RedisClient::OPT_PREFIX => 'prefix',
     ];
 
+    /**
+     * @var Client
+     */
     private $client;
 
+    /**
+     * @var mixed[]
+     */
     private $options = [];
 
+    /**
+     * @param  mixed[]  $options
+     */
     public function __construct(Client $redis, array $options)
     {
         $this->client = $redis;
 
         $this->options = $options;
     }
 
+    /**
+     * @param  mixed[]  $parameters
+     * @param  mixed[]  $options
+     */
     public static function create(array $parameters, array $options): self
     {
         $redisClient = new Client($parameters, $options);
@@ -46,11 +59,17 @@ public function eval(string $script, array $args = [], int $num_keys = 0): void
         $this->client->eval($script, $num_keys, ...$args);
     }
 
-    public function set(string $key, mixed $value, mixed $options = null): void
+    public function set(string $key, mixed $value, mixed $options = null): bool
     {
-        $this->client->set($key, $value, ...$this->flattenFlags($options));
+        $result = $this->client->set($key, $value, ...$this->flattenFlags($options));
+
+        return (string) $result === 'OK';
     }
 
+    /**
+     * @param  array<int|string, mixed>  $flags
+     * @return mixed[]
+     */
     private function flattenFlags(array $flags): array
     {
         $result = [];
@@ -73,10 +92,10 @@ public function setNx(string $key, mixed $value): void
 
     public function hSetNx(string $key, string $field, mixed $value): bool
     {
-        return $this->hsetnx($key, $field, $value);
+        return $this->hSetNx($key, $field, $value);
     }
 
-    public function sMembers(string $key): array|false
+    public function sMembers(string $key): array
     {
         return $this->client->smembers($key);
     }

src/Prometheus/Storage/RedisClients/RedisClient.php

@@ -12,22 +12,37 @@ interface RedisClient
 
     public function getOption(int $option): mixed;
 
+    /**
+     * @param  mixed[]  $args
+     */
     public function eval(string $script, array $args = [], int $num_keys = 0): void;
 
-    public function set(string $key, mixed $value, mixed $options = null): void;
+    public function set(string $key, mixed $value, mixed $options = null): bool;
 
     public function setNx(string $key, mixed $value): void;
 
     public function hSetNx(string $key, string $field, mixed $value): bool;
 
-    public function sMembers(string $key): array|false;
+    /**
+     * @return string[]
+     */
+    public function sMembers(string $key): array;
 
+    /**
+     * @return array<string, string>|false
+     */
     public function hGetAll(string $key): array|false;
 
+    /**
+     * @return string[]
+     */
     public function keys(string $pattern);
 
     public function get(string $key): mixed;
 
+    /**
+     * @param  string|string[]  $key
+     */
     public function del(array|string $key, string ...$other_keys): void;
 
     public function ensureOpenConnection(): void;