Merge pull request #37 from cheprasov/dev-1.2.2

v1.2.2

Author: cheprasov

CHANGELOG.md

@@ -1,5 +1,12 @@
 ## CHANGELOG
 
+### v1.2.2 (2016-03-30)
+- Fixed annotations and phpDocs.
+- Fixed some tests.
+
+### v1.2.1 (2016-03-04)
+- Fixed some cluster commands (Redis >= 3.0): __CLUSTER COUNT-FAILURE-REPORTS__ and __CLUSTER SAVECONFIG__.
+
 ### v1.2.0 (2016-01-30)
 - Updated command __MIGRATE__ (Redis >= 3.2): many fixes to the variable number of arguments (new) mode using the KEYS option.
 

README.md

@@ -1,17 +1,17 @@
 [![MIT license](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT)
 [![Latest Stable Version](https://poser.pugx.org/cheprasov/php-redis-client/v/stable)](https://packagist.org/packages/cheprasov/php-redis-client)
 [![Total Downloads](https://poser.pugx.org/cheprasov/php-redis-client/downloads)](https://packagist.org/packages/cheprasov/php-redis-client)
-# RedisClient v1.2.1 for PHP >= 5.5
+# RedisClient v1.2.2 for PHP >= 5.5
 
 ## About
-RedisClient is a fast, fully-functional and user-friendly client for Redis, optimized for performance. RedisClient supports latest versions of Redis starting from __2.6__
+RedisClient is a fast, fully-functional and user-friendly client for Redis, optimized for performance. RedisClient supports the latest versions of Redis starting from __2.6__ to __3.2.0-RC3__
 
 ## Main features
 - Support Redis versions from __2.6__ to __3.2.0-RC3__.
-- Support TCP/IP and UNIX sockets.
+- Support __TCP/IP__ and __UNIX__ sockets.
 - Support __PubSub__ and __Monitor__ functionallity.
 - Support __Pipeline__ and __Transactions__.
-- Support RAW commands as strings `"SET foo bar"` or as arrays `['SET', 'foo', 'bar']`.
+- Support __RAW__ commands as strings `"SET foo bar"` or as arrays `['SET', 'foo', 'bar']`.
 - Connections to Redis are established lazily by the client upon the first command.
 - Easy to use with IDE, client has PHPDocs for all supported versions.
 - By default, the client works with the latest stable version of Redis.

composer.json

@@ -1,7 +1,7 @@
 {
   "name": "cheprasov/php-redis-client",
-  "version": "1.2.1",
-  "description": "Php client for Redis",
+  "version": "1.2.2",
+  "description": "Php client for Redis. It is a fast, fully-functional and user-friendly client for Redis, optimized for performance. RedisClient supports the latest versions of Redis starting from 2.6 to 3.2.0-RC3",
   "homepage": "http://github.com/cheprasov/php-redis-client",
   "minimum-stability": "stable",
   "license": "MIT",

src/RedisClient/Client/AbstractRedisClient.php

@@ -20,7 +20,7 @@
 
 abstract class AbstractRedisClient {
 
-    const VERSION = '1.2.1';
+    const VERSION = '1.2.2';
 
     const CONFIG_SERVER = 'server';
     const CONFIG_TIMEOUT = 'timeout';

src/RedisClient/Command/Traits/AbstractCommandsTrait.php

@@ -10,10 +10,6 @@
  */
 namespace RedisClient\Command\Traits;
 
-/**
- * @method mixed eval($script, $keys = null, $args = null)
- * @method string echo($message)
- */
 trait AbstractCommandsTrait {
 
     /**

src/RedisClient/Command/Traits/Version2x6/ConnectionCommandsTrait.php

@@ -11,8 +11,10 @@
 namespace RedisClient\Command\Traits\Version2x6;
 
 /**
- * Connection
+ * Connection Commands
  * @link http://redis.io/commands#connection
+ *
+ * @method string echo($message)
  */
 trait ConnectionCommandsTrait {
 

src/RedisClient/Command/Traits/Version2x6/HashesCommandsTrait.php

@@ -14,7 +14,7 @@
 use RedisClient\Command\Response\ResponseParser;
 
 /**
- * trait HashesCommandsTrait
+ * Hashes Commands
  * @link http://redis.io/commands#hash
  */
 trait HashesCommandsTrait {

src/RedisClient/Command/Traits/Version2x6/KeysCommandsTrait.php

@@ -13,7 +13,8 @@
 use RedisClient\Command\Parameter\Parameter;
 
 /**
- * trait KeysCommandsTrait
+ * Keys Commands
+ * @link http://redis.io/commands#generic
  */
 trait KeysCommandsTrait {
 

src/RedisClient/Command/Traits/Version2x6/ListsCommandsTrait.php

@@ -13,7 +13,8 @@
 use RedisClient\Command\Response\ResponseParser;
 
 /**
- * trait ListsCommandsTrait
+ * Lists Commands
+ * @link http://redis.io/commands#list
  */
 trait ListsCommandsTrait {
 

src/RedisClient/Command/Traits/Version2x6/PubSubCommandsTrait.php

@@ -11,7 +11,7 @@
 namespace RedisClient\Command\Traits\Version2x6;
 
 /**
- * PubSub
+ * PubSub Commands
  * @link http://redis.io/commands#pubsub
  */
 trait PubSubCommandsTrait {

src/RedisClient/Command/Traits/Version2x6/ScriptingCommandsTrait.php

@@ -11,8 +11,10 @@
 namespace RedisClient\Command\Traits\Version2x6;
 
 /**
- * ScriptingCommandsTrait
+ * Scripting Commands
  * @link http://redis.io/commands#scripting
+ *
+ * @method mixed eval($script, $keys = null, $args = null)
  */
 trait ScriptingCommandsTrait {
 

src/RedisClient/Command/Traits/Version2x6/ServerCommandsTrait.php

@@ -13,11 +13,16 @@
 use RedisClient\Command\Parameter\Parameter;
 use RedisClient\Command\Response\ResponseParser;
 
+/**
+ * Server Commands
+ * @link http://redis.io/commands#server
+ */
 trait ServerCommandsTrait {
 
     /**
      * BGREWRITEAOF
      * Available since 1.0.0.
+     * @link http://redis.io/commands/bgrewriteaof
      *
      * @return bool|string Always true
      */
@@ -28,6 +33,7 @@ public function bgrewriteaof() {
     /**
      * BGSAVE
      * Available since 1.0.0.
+     * @link http://redis.io/commands/bgsave
      *
      * @return string
      */
@@ -39,6 +45,7 @@ public function bgsave() {
      * CLIENT GETNAME
      * Available since 2.6.9.
      * Time complexity: O(1)
+     * @link http://redis.io/commands/client-getname
      *
      * @return string|null The connection name, or a null bulk reply if no name is set.
      */
@@ -51,6 +58,7 @@ public function clientGetname() {
      * CLIENT KILL [ip:port] [ID client-id] [TYPE normal|slave|pubsub] [ADDR ip:port] [SKIPME yes/no]
      * Available since 2.4.0.
      * Time complexity: O(N) where N is the number of client connections
+     * @link http://redis.io/commands/client-kill
      *
      * @param string|array|null $addr
      * @param int|null $clientId
@@ -91,6 +99,7 @@ public function clientKill($addr = null, $clientId = null, $type = null, $addr2
      * CLIENT LIST
      * Available since 2.4.0.
      * Time complexity: O(N) where N is the number of client connections
+     * @link http://redis.io/commands/client-list
      *
      * @return string
      */
@@ -102,6 +111,7 @@ public function clientList() {
      * CLIENT SETNAME connection-name
      * Available since 2.6.9.
      * Time complexity: O(1)
+     * @link http://redis.io/commands/client-setname
      *
      * @param string $connectionName
      * @param bool True if the connection name was successfully set.
@@ -113,6 +123,7 @@ public function clientSetname($connectionName) {
     /**
      * CONFIG GET parameter
      * Available since 2.0.0.
+     * @link http://redis.io/commands/config-get
      *
      * @param string|string[]
      * @return array
@@ -125,6 +136,7 @@ public function configGet($parameter) {
      * CONFIG RESETSTAT
      * Available since 2.0.0.
      * Time complexity: O(1)
+     * @link http://redis.io/commands/config-resetstat
      *
      * @return bool always True
      */
@@ -135,6 +147,7 @@ public function configResetstat() {
     /**
      * CONFIG SET parameter value
      * Available since 2.0.0.
+     * @link http://redis.io/commands/config-set
      *
      * @param string $parameter
      * @param string $value
@@ -147,6 +160,7 @@ public function configSet($parameter, $value) {
     /**
      * DBSIZE
      * Available since 1.0.0.
+     * @link http://redis.io/commands/dbsize
      *
      * @return int The number of keys in the currently-selected database.
      */
@@ -157,6 +171,7 @@ public function dbsize() {
     /**
      * DEBUG OBJECT key
      * Available since 1.0.0.
+     * @link http://redis.io/commands/debug-object
      *
      * @param string $key
      * @return string
@@ -168,6 +183,7 @@ public function debugObject($key) {
     /**
      * DEBUG SEGFAULT
      * Available since 1.0.0.
+     * @link http://redis.io/commands/debug-segfault
      *
      * @return string
      */
@@ -178,6 +194,7 @@ public function debugSegfault() {
     /**
      * FLUSHALL
      * Available since 1.0.0.
+     * @link http://redis.io/commands/flushall
      *
      * @return bool
      */
@@ -188,6 +205,7 @@ public function flushall() {
     /**
      * FLUSHDB
      * Available since 1.0.0.
+     * @link http://redis.io/commands/flushdb
      *
      * @return bool
      */
@@ -198,6 +216,7 @@ public function flushdb() {
     /**
      * INFO [section]
      * Available since 1.0.0.
+     * @link http://redis.io/commands/info
      *
      * @param string $section
      * @return string
@@ -209,6 +228,7 @@ public function info($section = null) {
     /**
      * LASTSAVE
      * Available since 1.0.0.
+     * @link http://redis.io/commands/lastsave
      *
      * @return int an UNIX time stamp.
      */
@@ -219,6 +239,7 @@ public function lastsave() {
     /**
      * MONITOR
      * Available since 1.0.0.
+     * @link http://redis.io/commands/monitor
      *
      * @param \Closure $callback
      * @return mixed
@@ -230,6 +251,7 @@ public function monitor(\Closure $callback) {
     /**
      * SAVE
      * Available since 1.0.0.
+     * @link http://redis.io/commands/save
      *
      * @return bool The commands returns True on success
      */
@@ -238,8 +260,9 @@ public function save() {
     }
 
     /**
-     * SHUTDOWN [NOSAVE] [SAVE]
+     * SHUTDOWN [NOSAVE|SAVE]
      * Available since 1.0.0.
+     * @link http://redis.io/commands/shutdown
      *
      * @param string|null $save NOSAVE or SAVE
      */
@@ -250,6 +273,7 @@ public function shutdown($save) {
     /**
      * SLAVEOF host port
      * Available since 1.0.0.
+     * @link http://redis.io/commands/slaveof
      *
      * @param string $host
      * @param string $port
@@ -262,6 +286,7 @@ public function slaveof($host, $port) {
     /**
      * SLOWLOG subcommand [argument]
      * Available since 2.2.12.
+     * @link http://redis.io/commands/slowlog
      *
      * @param string $subcommand GET|LEN|RESET
      * @param string|null $argument
@@ -278,7 +303,7 @@ public function slowlog($subcommand, $argument = null) {
     /**
      * SYNC
      * Available since 1.0.0.
-     *
+     * @link http://redis.io/commands/sync
      */
     public function sync() {
         return $this->returnCommand(['SYNC']);
@@ -288,6 +313,7 @@ public function sync() {
      * TIME
      * Available since 2.6.0.
      * Time complexity: O(1)
+     * @link http://redis.io/commands/time
      *
      * @return string
      */

src/RedisClient/Command/Traits/Version2x6/SetsCommandsTrait.php

@@ -10,6 +10,10 @@
  */
 namespace RedisClient\Command\Traits\Version2x6;
 
+/**
+ * Sets Commands
+ * @link http://redis.io/commands#set
+ */
 trait SetsCommandsTrait {
 
     /**

src/RedisClient/Command/Traits/Version2x6/SortedSetsCommandsTrait.php

@@ -14,7 +14,8 @@
 use RedisClient\Command\Response\ResponseParser;
 
 /**
- * trait SortedSetsCommandsTrait
+ * SortedSets Commands
+ * @link http://redis.io/commands#set
  * @link http://redis.io/topics/data-types#sorted-sets
  */
 trait SortedSetsCommandsTrait {

src/RedisClient/Command/Traits/Version2x6/StringsCommandsTrait.php

@@ -13,6 +13,10 @@
 use InvalidArgumentException;
 use RedisClient\Command\Parameter\Parameter;
 
+/**
+ * Strings Commands
+ * @link http://redis.io/commands#string
+ */
 trait StringsCommandsTrait {
 
     /**

src/RedisClient/Command/Traits/Version2x6/TransactionsCommandsTrait.php

@@ -11,7 +11,8 @@
 namespace RedisClient\Command\Traits\Version2x6;
 
 /**
- * trait TransactionsCommandsTrait
+ * Transactions Commands
+ * @link http://redis.io/commands#transactions
  * @link http://redis.io/topics/transactions
  */
 trait TransactionsCommandsTrait {
@@ -65,6 +66,7 @@ public function unwatch() {
      * WATCH key [key ...]
      * Available since 2.2.0.
      * Time complexity: O(1) for every key.
+     * @link http://redis.io/commands/watch
      *
      * @param string|string[] $keys
      * @return bool Always True

src/RedisClient/Command/Traits/Version2x8/HashesCommandsTrait.php

@@ -13,7 +13,7 @@
 use RedisClient\Command\Traits\Version2x6\HashesCommandsTrait as HashesCommandsTraitVersion2x6;
 
 /**
- * trait HashesCommandsTrait
+ * Hashes Commands
  * @link http://redis.io/commands#hash
  */
 trait HashesCommandsTrait {

src/RedisClient/Command/Traits/Version2x8/HyperLogLogCommandsTrait.php

@@ -11,7 +11,7 @@
 namespace RedisClient\Command\Traits\Version2x8;
 
 /**
- * HyperLogLog
+ * HyperLogLog Commands
  * @link http://redis.io/commands#hyperloglog
  */
 trait HyperLogLogCommandsTrait {