Hashes::hGet() - Code Metrics - webdcg/redis - Measure and Improve Code Quality continuously with Scrutinizer

Hashes::hGet() A
last analyzed 2020-02-26 04:32 UTC

↳ Parent: Hashes

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	2

<?php

namespace Webdcg\Redis\Traits;

trait Hashes
{
    /**
     * Removes a value from the hash stored at key. If the hash table doesn't
     * exist, or the key doesn't exist, FALSE is returned.
     * See: https://redis.io/commands/hdel.
     *
     * @param  string $key
     * @param  splat $fields
     *
     * @return int          LONG the number of deleted keys, 0 if the key doesn't
     *                      exist, FALSE if the key isn't a hash.
     */
    public function hDel(string $key, ...$fields): int
    {
        return $this->redis->hDel($key, ...$fields);
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    /**
     * Verify if the specified member exists in a key.
     * See: https://redis.io/commands/hexists.
     *
     * @param  string $key
     * @param  string $field
     *
     * @return bool             If the member exists in the hash table, return
     *                          TRUE, otherwise return FALSE.
     */
    public function hExists(string $key, string $field): bool
    {
        return $this->redis->hExists($key, $field);
    }

    /**
     * Gets a value from the hash stored at key. If the hash table doesn't
     * exist, or the key doesn't exist, FALSE is returned.
     * See: https://redis.io/commands/hget.
     *
     * @param  string $key
     * @param  string $field
     *
     * @return mixed       STRING The value, if the command executed successfully
     *                      BOOL FALSE in case of failure
     */
    public function hGet(string $key, string $field)
    {
        return $this->redis->hGet($key, $field);
    }

    /**
     * Returns the whole hash, as an array of strings indexed by strings.
     * The order is random and corresponds to redis' own internal
     * representation of the set structure.
     * See: https://redis.io/commands/hgetall.
     *
     * @param  string $key
     *
     * @return array        An array of elements, the contents of the hash.
     */
    public function hGetAll(string $key): array
    {
        return $this->redis->hGetAll($key);
    }

    /**
     * Increments the value of a member from a hash by a given amount.
     * See: https://redis.io/commands/hincrby.
     *
     * @param  string      $key
     * @param  string      $field       (integer) value that will be added to
     *                                  the member's value
     * @param  int|integer $increment
     *
     * @return int                      LONG the new value
     */
    public function hIncrBy(string $key, string $field, int $increment = 1): int
    {
        return $this->redis->hIncrBy($key, $field, $increment);
    }

    /**
     * Increments the value of a hash member by the provided float value.
     * See: https://redis.io/commands/hincrbyfloat.
     *
     * @param  string $key
     * @param  string $field
     * @param  float  $increment    (float) value that will be added to the
     *                              member's value
     *
     * @return float                the new value
     */
    public function hIncrByFloat(string $key, string $field, float $increment = 1.0): float
    {
        return $this->redis->hIncrByFloat($key, $field, $increment);
    }

    /**
     * Returns the keys in a hash, as an array of strings.
     * The order is random and corresponds to redis' own internal
     * representation of the set structure.
     * See: https://redis.io/commands/hkeys.
     *
     * @param  string $key
     *
     * @return array        An array of elements, the keys of the hash.
     *                      This works like PHP's array_keys().
     */
    public function hKeys(string $key): array
    {
        return $this->redis->hKeys($key);
    }

    /**
     * Returns the length of a hash, in number of items.
     * See: https://redis.io/commands/hlen.
     *
     * @param  string $key
     *
     * @return int          LONG the number of items in a hash, FALSE if the
     *                      key doesn't exist or isn't a hash.
     */
    public function hLen(string $key): int
    {
        return $this->redis->hLen($key);
    }

    /**
     * Retrieve the values associated to the specified fields in the hash.
     * See: https://redis.io/commands/hmget.
     *
     * @param  string $key
     * @param  array  $fields
     *
     * @return array            An array of elements, the values of the
     *                          specified fields in the hash, with the hash
     *                          keys as array keys.
     */
    public function hMGet(string $key, array $fields): array
    {
        return $this->redis->hMGet($key, $fields);
    }

    /**
     * Fills in a whole hash. Non-string values are converted to string, using
     * the standard (string) cast. NULL values are stored as empty strings.
     * See: https://redis.io/commands/hmset.
     *
     * @param  string $key
     * @param  array  $hash key → value array
     *
     * @return bool         TRUE if the field was set, FALSE if it was
     *                      already present.
     */
    public function hMSet(string $key, array $hash): bool
    {
        return $this->redis->hMSet($key, $hash);
    }

    /**
     * Adds a value to the hash stored at key.
     * See: https://redis.io/commands/hset.
     *
     * @param  string $key
     * @param  string $field
     * @param  mixed $value
     *
     * @return int          LONG 1 if value didn't exist and was added
     *                      successfully, 0 if the value was already present
     *                      and was replaced, FALSE if there was an error.
     */
    public function hSet(string $key, string $field, $value): int
    {
        return $this->redis->hSet($key, $field, $value);
    }

    /**
     * Adds a value to the hash stored at key only if this field isn't already
     * in the hash.
     * See: https://redis.io/commands/hsetnx.
     *
     * @param  string $key
     * @param  string $field
     * @param  string $value
     *
     * @return bool             TRUE if the field was set, FALSE if it was
     *                          already present.
     */
    public function hSetNx(string $key, string $field, string $value): bool
    {
        return $this->redis->hSetNx($key, $field, $value);
    }

    /**
     * Returns the values in a hash, as an array of strings.
     * The order is random and corresponds to redis' own internal
     * representation of the set structure.
     * See: https://redis.io/commands/hvals.
     *
     * @param  string $key
     *
     * @return array        An array of elements, the values of the hash.
     *                      This works like PHP's array_values().
     */
    public function hVals(string $key): array
    {
        return $this->redis->hVals($key);
    }

    /**
     * Scan a HASH value for members, with an optional pattern and count.
     *
     * @param  string      $key
     * @param  [type]      $iterator    Long (reference)

     * @param  string      $pattern     Optional pattern to match against
     * @param  int|integer $count       How many keys to return in a go (only a
     *                                  suggestion to Redis)
     *
     * @return array                    An array of members that match our pattern
     */
    public function hScan(string $key, &$iterator, string $pattern = '*', int $count = 10)
    {
        return $this->redis->hScan($key, $iterator, $pattern, $count);
    }

    /**
     * Get the string length of the value associated with field in the hash
     * stored at key.
     * See: https://redis.io/commands/hstrlen.
     *
     * @param  string $key
     * @param  string $field
     *
     * @return int              LONG the string length of the value associated
     *                          with field, or zero when field is not present
     *                          in the hash or key does not exist at all.
     */
    public function hStrLen(string $key, string $field): int
    {
        return $this->redis->hStrLen($key, $field);
    }
}


1			<?php
2
3			namespace Webdcg\Redis\Traits;
4
5			trait Hashes
6			{
7			/**
8			* Removes a value from the hash stored at key. If the hash table doesn't
9			* exist, or the key doesn't exist, FALSE is returned.
10			* See: https://redis.io/commands/hdel.
11			*
12			* @param string $key
13			* @param splat $fields
14			*
15			* @return int LONG the number of deleted keys, 0 if the key doesn't
16			* exist, FALSE if the key isn't a hash.
17			*/
18			public function hDel(string $key, ...$fields): int
19			{
20			return $this->redis->hDel($key, ...$fields);
			0 ignored issues – show Bug introduced 2020-01-26 01:26 UTC by Report Bug Copy Issue Report The property `redis` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
21			}
22
23			/**
24			* Verify if the specified member exists in a key.
25			* See: https://redis.io/commands/hexists.
26			*
27			* @param string $key
28			* @param string $field
29			*
30			* @return bool If the member exists in the hash table, return
31			* TRUE, otherwise return FALSE.
32			*/
33			public function hExists(string $key, string $field): bool
34			{
35			return $this->redis->hExists($key, $field);
36			}
37
38			/**
39			* Gets a value from the hash stored at key. If the hash table doesn't
40			* exist, or the key doesn't exist, FALSE is returned.
41			* See: https://redis.io/commands/hget.
42			*
43			* @param string $key
44			* @param string $field
45			*
46			* @return mixed STRING The value, if the command executed successfully
47			* BOOL FALSE in case of failure
48			*/
49			public function hGet(string $key, string $field)
50			{
51			return $this->redis->hGet($key, $field);
52			}
53
54			/**
55			* Returns the whole hash, as an array of strings indexed by strings.
56			* The order is random and corresponds to redis' own internal
57			* representation of the set structure.
58			* See: https://redis.io/commands/hgetall.
59			*
60			* @param string $key
61			*
62			* @return array An array of elements, the contents of the hash.
63			*/
64			public function hGetAll(string $key): array
65			{
66			return $this->redis->hGetAll($key);
67			}
68
69			/**
70			* Increments the value of a member from a hash by a given amount.
71			* See: https://redis.io/commands/hincrby.
72			*
73			* @param string $key
74			* @param string $field (integer) value that will be added to
75			* the member's value
76			* @param int\|integer $increment
77			*
78			* @return int LONG the new value
79			*/
80			public function hIncrBy(string $key, string $field, int $increment = 1): int
81			{
82			return $this->redis->hIncrBy($key, $field, $increment);
83			}
84
85			/**
86			* Increments the value of a hash member by the provided float value.
87			* See: https://redis.io/commands/hincrbyfloat.
88			*
89			* @param string $key
90			* @param string $field
91			* @param float $increment (float) value that will be added to the
92			* member's value
93			*
94			* @return float the new value
95			*/
96			public function hIncrByFloat(string $key, string $field, float $increment = 1.0): float
97			{
98			return $this->redis->hIncrByFloat($key, $field, $increment);
99			}
100
101			/**
102			* Returns the keys in a hash, as an array of strings.
103			* The order is random and corresponds to redis' own internal
104			* representation of the set structure.
105			* See: https://redis.io/commands/hkeys.
106			*
107			* @param string $key
108			*
109			* @return array An array of elements, the keys of the hash.
110			* This works like PHP's array_keys().
111			*/
112			public function hKeys(string $key): array
113			{
114			return $this->redis->hKeys($key);
115			}
116
117			/**
118			* Returns the length of a hash, in number of items.
119			* See: https://redis.io/commands/hlen.
120			*
121			* @param string $key
122			*
123			* @return int LONG the number of items in a hash, FALSE if the
124			* key doesn't exist or isn't a hash.
125			*/
126			public function hLen(string $key): int
127			{
128			return $this->redis->hLen($key);
129			}
130
131			/**
132			* Retrieve the values associated to the specified fields in the hash.
133			* See: https://redis.io/commands/hmget.
134			*
135			* @param string $key
136			* @param array $fields
137			*
138			* @return array An array of elements, the values of the
139			* specified fields in the hash, with the hash
140			* keys as array keys.
141			*/
142			public function hMGet(string $key, array $fields): array
143			{
144			return $this->redis->hMGet($key, $fields);
145			}
146
147			/**
148			* Fills in a whole hash. Non-string values are converted to string, using
149			* the standard (string) cast. NULL values are stored as empty strings.
150			* See: https://redis.io/commands/hmset.
151			*
152			* @param string $key
153			* @param array $hash key → value array
154			*
155			* @return bool TRUE if the field was set, FALSE if it was
156			* already present.
157			*/
158			public function hMSet(string $key, array $hash): bool
159			{
160			return $this->redis->hMSet($key, $hash);
161			}
162
163			/**
164			* Adds a value to the hash stored at key.
165			* See: https://redis.io/commands/hset.
166			*
167			* @param string $key
168			* @param string $field
169			* @param mixed $value
170			*
171			* @return int LONG 1 if value didn't exist and was added
172			* successfully, 0 if the value was already present
173			* and was replaced, FALSE if there was an error.
174			*/
175			public function hSet(string $key, string $field, $value): int
176			{
177			return $this->redis->hSet($key, $field, $value);
178			}
179
180			/**
181			* Adds a value to the hash stored at key only if this field isn't already
182			* in the hash.
183			* See: https://redis.io/commands/hsetnx.
184			*
185			* @param string $key
186			* @param string $field
187			* @param string $value
188			*
189			* @return bool TRUE if the field was set, FALSE if it was
190			* already present.
191			*/
192			public function hSetNx(string $key, string $field, string $value): bool
193			{
194			return $this->redis->hSetNx($key, $field, $value);
195			}
196
197			/**
198			* Returns the values in a hash, as an array of strings.
199			* The order is random and corresponds to redis' own internal
200			* representation of the set structure.
201			* See: https://redis.io/commands/hvals.
202			*
203			* @param string $key
204			*
205			* @return array An array of elements, the values of the hash.
206			* This works like PHP's array_values().
207			*/
208			public function hVals(string $key): array
209			{
210			return $this->redis->hVals($key);
211			}
212
213			/**
214			* Scan a HASH value for members, with an optional pattern and count.
215			*
216			* @param string $key
217			* @param [type] $iterator Long (reference)
			0 ignored issues – show Documentation introduced 2020-01-26 05:12 UTC by Report Bug Copy Issue Report The doc-type `[type]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
218			* @param string $pattern Optional pattern to match against
219			* @param int\|integer $count How many keys to return in a go (only a
220			* suggestion to Redis)
221			*
222			* @return array An array of members that match our pattern
223			*/
224			public function hScan(string $key, &$iterator, string $pattern = '*', int $count = 10)
225			{
226			return $this->redis->hScan($key, $iterator, $pattern, $count);
227			}
228
229			/**
230			* Get the string length of the value associated with field in the hash
231			* stored at key.
232			* See: https://redis.io/commands/hstrlen.
233			*
234			* @param string $key
235			* @param string $field
236			*
237			* @return int LONG the string length of the value associated
238			* with field, or zero when field is not present
239			* in the hash or key does not exist at all.
240			*/
241			public function hStrLen(string $key, string $field): int
242			{
243			return $this->redis->hStrLen($key, $field);
244			}
245			}
246

webdcg / redis

Hashes::hGet() A last analyzed 2020-02-26 04:32 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Hashes::hGet() A
last analyzed 2020-02-26 04:32 UTC