geckon01/predis
1
0
Fork 0
mirror of https://github.com/predis/predis.git synced 2026-09-13 20:07:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add missing @return annotations (#1265)

Browse Source 
* Add missing `@return` annotations

* formatting

* formatting

* Update ProcessorChain.php

* Update Handler.php

---------

Co-authored-by: Till Krüss <tillkruss@users.noreply.github.com>
This commit is contained in:
Nicolas Grekas
2023-04-19 22:51:42 +02:00
committed by GitHub
parent d2cd99492d
commit bf2075a176
11 changed files with 52 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/Cluster/SlotMap.php
+2 -1
View File
@@ -19,6 +19,7 @@ use IteratorAggregate;
use OutOfBoundsException;
use Predis\Connection\NodeConnectionInterface;
use ReturnTypeWillChange;
use Traversable;
/**
* Slot map for redis-cluster.
@@ -198,7 +199,7 @@ class SlotMap implements ArrayAccess, IteratorAggregate, Countable
/**
* Returns an iterator over the slot map.
*
* @return ArrayIterator
* @return Traversable<int, string>
*/
#[ReturnTypeWillChange]
public function getIterator()
src/Collection/Iterator/CursorBasedIterator.php
+5 -5
View File
@@ -138,7 +138,7 @@ abstract class CursorBasedIterator implements Iterator
}
/**
* {@inheritdoc}
* @return void
*/
#[ReturnTypeWillChange]
public function rewind()
@@ -148,7 +148,7 @@ abstract class CursorBasedIterator implements Iterator
}
/**
* {@inheritdoc}
* @return mixed
*/
#[ReturnTypeWillChange]
public function current()
@@ -157,7 +157,7 @@ abstract class CursorBasedIterator implements Iterator
}
/**
* {@inheritdoc}
* @return int|null
*/
#[ReturnTypeWillChange]
public function key()
@@ -166,7 +166,7 @@ abstract class CursorBasedIterator implements Iterator
}
/**
* {@inheritdoc}
* @return void
*/
#[ReturnTypeWillChange]
public function next()
@@ -186,7 +186,7 @@ abstract class CursorBasedIterator implements Iterator
}
/**
* {@inheritdoc}
* @return bool
*/
#[ReturnTypeWillChange]
public function valid()
src/Collection/Iterator/ListKey.php
+5 -5
View File
@@ -128,7 +128,7 @@ class ListKey implements Iterator
}
/**
* {@inheritdoc}
* @return void
*/
#[ReturnTypeWillChange]
public function rewind()
@@ -138,7 +138,7 @@ class ListKey implements Iterator
}
/**
* {@inheritdoc}
* @return mixed
*/
#[ReturnTypeWillChange]
public function current()
@@ -147,7 +147,7 @@ class ListKey implements Iterator
}
/**
* {@inheritdoc}
* @return int|null
*/
#[ReturnTypeWillChange]
public function key()
@@ -156,7 +156,7 @@ class ListKey implements Iterator
}
/**
* {@inheritdoc}
* @return void
*/
#[ReturnTypeWillChange]
public function next()
@@ -173,7 +173,7 @@ class ListKey implements Iterator
}
/**
* {@inheritdoc}
* @return bool
*/
#[ReturnTypeWillChange]
public function valid()
src/Command/Processor/ProcessorChain.php
+9 -4
View File
@@ -93,7 +93,8 @@ class ProcessorChain implements ArrayAccess, ProcessorInterface
}
/**
* {@inheritdoc}
* @param int $index
* @return bool
*/
#[ReturnTypeWillChange]
public function offsetExists($index)
@@ -102,7 +103,8 @@ class ProcessorChain implements ArrayAccess, ProcessorInterface
}
/**
* {@inheritdoc}
* @param int $index
* @return ProcessorInterface
*/
#[ReturnTypeWillChange]
public function offsetGet($index)
@@ -111,7 +113,9 @@ class ProcessorChain implements ArrayAccess, ProcessorInterface
}
/**
* {@inheritdoc}
* @param int $index
* @param ProcessorInterface $processor
* @return void
*/
#[ReturnTypeWillChange]
public function offsetSet($index, $processor)
@@ -126,7 +130,8 @@ class ProcessorChain implements ArrayAccess, ProcessorInterface
}
/**
* {@inheritdoc}
* @param int $index
* @return void
*/
#[ReturnTypeWillChange]
public function offsetUnset($index)
src/Connection/Cluster/PredisCluster.php
+3 -2
View File
@@ -21,6 +21,7 @@ use Predis\Command\CommandInterface;
use Predis\Connection\NodeConnectionInterface;
use Predis\NotSupportedException;
use ReturnTypeWillChange;
use Traversable;
/**
* Abstraction for a cluster of aggregate connections to various Redis servers
@@ -200,7 +201,7 @@ class PredisCluster implements ClusterInterface, IteratorAggregate, Countable
}
/**
* {@inheritdoc}
* @return int
*/
#[ReturnTypeWillChange]
public function count()
@@ -209,7 +210,7 @@ class PredisCluster implements ClusterInterface, IteratorAggregate, Countable
}
/**
* {@inheritdoc}
* @return Traversable<string, NodeConnectionInterface>
*/
#[ReturnTypeWillChange]
public function getIterator()
src/Connection/Cluster/RedisCluster.php
+3 -2
View File
@@ -31,6 +31,7 @@ use Predis\Response\ErrorInterface as ErrorResponseInterface;
use Predis\Response\ServerException;
use ReturnTypeWillChange;
use Throwable;
use Traversable;
/**
* Abstraction for a Redis-backed cluster of nodes (Redis >= 3.0.0).
@@ -589,7 +590,7 @@ class RedisCluster implements ClusterInterface, IteratorAggregate, Countable
}
/**
* {@inheritdoc}
* @return int
*/
#[ReturnTypeWillChange]
public function count()
@@ -598,7 +599,7 @@ class RedisCluster implements ClusterInterface, IteratorAggregate, Countable
}
/**
* {@inheritdoc}
* @return Traversable<string, NodeConnectionInterface>
*/
#[ReturnTypeWillChange]
public function getIterator()
src/Monitor/Consumer.php
+3 -3
View File
@@ -90,7 +90,7 @@ class Consumer implements Iterator
}
/**
* {@inheritdoc}
* @return void
*/
#[ReturnTypeWillChange]
public function rewind()
@@ -110,7 +110,7 @@ class Consumer implements Iterator
}
/**
* {@inheritdoc}
* @return int|null
*/
#[ReturnTypeWillChange]
public function key()
@@ -119,7 +119,7 @@ class Consumer implements Iterator
}
/**
* {@inheritdoc}
* @return void
*/
#[ReturnTypeWillChange]
public function next()
src/PubSub/AbstractConsumer.php
+3 -3
View File
@@ -151,7 +151,7 @@ abstract class AbstractConsumer implements Iterator
abstract protected function writeRequest($method, $arguments);
/**
* {@inheritdoc}
* @return void
*/
#[ReturnTypeWillChange]
public function rewind()
@@ -172,7 +172,7 @@ abstract class AbstractConsumer implements Iterator
}
/**
* {@inheritdoc}
* @return int|null
*/
#[ReturnTypeWillChange]
public function key()
@@ -181,7 +181,7 @@ abstract class AbstractConsumer implements Iterator
}
/**
* {@inheritdoc}
* @return int|null
*/
#[ReturnTypeWillChange]
public function next()
src/Response/Iterator/MultiBulkIterator.php
+5 -5
View File
@@ -34,7 +34,7 @@ abstract class MultiBulkIterator implements Iterator, Countable, ResponseInterfa
protected $size;
/**
* {@inheritdoc}
* @return void
*/
#[ReturnTypeWillChange]
public function rewind()
@@ -43,7 +43,7 @@ abstract class MultiBulkIterator implements Iterator, Countable, ResponseInterfa
}
/**
* {@inheritdoc}
* @return mixed
*/
#[ReturnTypeWillChange]
public function current()
@@ -52,7 +52,7 @@ abstract class MultiBulkIterator implements Iterator, Countable, ResponseInterfa
}
/**
* {@inheritdoc}
* @return int|null
*/
#[ReturnTypeWillChange]
public function key()
@@ -61,7 +61,7 @@ abstract class MultiBulkIterator implements Iterator, Countable, ResponseInterfa
}
/**
* {@inheritdoc}
* @return void
*/
#[ReturnTypeWillChange]
public function next()
@@ -72,7 +72,7 @@ abstract class MultiBulkIterator implements Iterator, Countable, ResponseInterfa
}
/**
* {@inheritdoc}
* @return bool
*/
#[ReturnTypeWillChange]
public function valid()
src/Response/Iterator/MultiBulkTuple.php
+1 -1
View File
@@ -63,7 +63,7 @@ class MultiBulkTuple extends MultiBulk implements OuterIterator
}
/**
* {@inheritdoc}
* @return MultiBulk
*/
#[ReturnTypeWillChange]
public function getInnerIterator()
src/Session/Handler.php
+13 -6
View File
@@ -53,7 +53,9 @@ class Handler implements SessionHandlerInterface
}
/**
* {@inheritdoc}
* @param string $save_path
* @param string $session_id
* @return bool
*/
#[ReturnTypeWillChange]
public function open($save_path, $session_id)
@@ -63,7 +65,7 @@ class Handler implements SessionHandlerInterface
}
/**
* {@inheritdoc}
* @return bool
*/
#[ReturnTypeWillChange]
public function close()
@@ -73,7 +75,8 @@ class Handler implements SessionHandlerInterface
}
/**
* {@inheritdoc}
* @param int $maxlifetime
* @return bool
*/
#[ReturnTypeWillChange]
public function gc($maxlifetime)
@@ -83,7 +86,8 @@ class Handler implements SessionHandlerInterface
}
/**
* {@inheritdoc}
* @param string $session_id
* @return string
*/
#[ReturnTypeWillChange]
public function read($session_id)
@@ -96,7 +100,9 @@ class Handler implements SessionHandlerInterface
}
/**
* {@inheritdoc}
* @param string $session_id
* @param string $session_data
* @return bool
*/
#[ReturnTypeWillChange]
public function write($session_id, $session_data)
@@ -107,7 +113,8 @@ class Handler implements SessionHandlerInterface
}
/**
* {@inheritdoc}
* @param string $session_id
* @return bool
*/
#[ReturnTypeWillChange]
public function destroy($session_id)