Merge pull request #29 from cheprasov/dev-with-versions

v1.0-rc1

Author: cheprasov

README.md

@@ -10,30 +10,48 @@ RedisClient is a fast, fully-functional and user-friendly client for Redis, opti
 - Support TCP/IP and UNIX sockets.
 - Support __PubSub__ and __monitor__ functionallity.
 - Support __pipeline__.
+- 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.
 
 ## Usage
 
 ### Create a new instance of RedisClient
 ```php
 <?php
-require (dirname(__DIR__).'/src/autoloader.php');
-// or require ('vendor/autoload.php');
+require (dirname(__DIR__).'/vendor/autoload.php');
+// or require (dirname(__DIR__).'/src/autoloader.php');
 
 use RedisClient\RedisClient;
 use RedisClient\Client\Version\RedisClient2x6;
 
+// Create new Instance for Redis version 2.8.x with config via factory
+
+$Redis = ClientFactory::create([
+    'server' => 'tcp://127.0.0.1:6379', // or 'unix:///tmp/redis.sock'
+    'timeout' => 2,
+    'version' => '2.8.24'
+]);
+
+echo 'RedisClient: '. $Redis->getSupportedVersion() . PHP_EOL;
+// RedisClient: 2.8
+
+// Create new instance of client without factory
+
 $Redis = new RedisClient([
     'server' => 'tcp://127.0.0.1:6379', // or 'unix:///tmp/redis.sock'
     'timeout' => 2
 ]);
 
-echo 'RedisClient: '. $Redis->getVersion() . PHP_EOL;
+echo 'RedisClient: '. $Redis->getSupportedVersion() . PHP_EOL;
 echo 'Redis: '. $Redis->info('Server')['redis_version'] . PHP_EOL;
 
+// By default, the client works with the latest stable version of Redis.
 // RedisClient: 3.0
 // Redis: 3.0.3
+
+
 ```
 ### Example
 Please, see examples here: https://github.com/cheprasov/php-redis-client/tree/master/examples

examples/create_new_instance.php

@@ -15,35 +15,34 @@
 
 namespace Examples;
 
-require (dirname(__DIR__).'/src/autoloader.php');
-// or require ('vendor/autoload.php');
+require (dirname(__DIR__).'/vendor/autoload.php');
+// or require (dirname(__DIR__).'/src/autoloader.php');
 
 use RedisClient\RedisClient;
 use RedisClient\Client\Version\RedisClient2x6;
+use RedisClient\ClientFactory;
 
 // Example 1. Create new Instance with default config
 
 $Redis = new RedisClient();
-
-echo 'RedisClient: '. $Redis->getVersion() . PHP_EOL;
+// By default, the client works with the latest stable version of Redis.
+echo 'RedisClient: '. $Redis->getSupportedVersion() . PHP_EOL;
 echo 'Redis: '. $Redis->info('Server')['redis_version'] . PHP_EOL;
 
-// result:
 // RedisClient: 3.0
 // Redis: 3.0.3
 
 
 // Example 2. Create new Instance with config
+// By default, the client works with the latest stable version of Redis.
 
 $Redis = new RedisClient([
     'server' => 'tcp://127.0.0.1:6379', // or 'unix:///tmp/redis.sock'
     'timeout' => 2
 ]);
 
-echo 'RedisClient: '. $Redis->getVersion() . PHP_EOL;
+echo 'RedisClient: '. $Redis->getSupportedVersion() . PHP_EOL;
 echo 'Redis: '. $Redis->info('Server')['redis_version'] . PHP_EOL;
-
-// result:
 // RedisClient: 3.0
 // Redis: 3.0.3
 
@@ -55,9 +54,16 @@
     'timeout' => 2
 ]);
 
-echo 'RedisClient: '. $Redis->getVersion() . PHP_EOL;
-echo 'Redis: '. $Redis->info('Server')['redis_version'] . PHP_EOL;
-
-// result:
+echo 'RedisClient: '. $Redis->getSupportedVersion() . PHP_EOL;
 // RedisClient: 2.6
-// Redis: 3.0.3
+
+// Example 4. Create new Instance for Redis version 2.8.x with config via factory
+
+$Redis = ClientFactory::create([
+    'server' => 'tcp://127.0.0.1:6379', // or 'unix:///tmp/redis.sock'
+    'timeout' => 2,
+    'version' => '2.8.24'
+]);
+
+echo 'RedisClient: '. $Redis->getSupportedVersion() . PHP_EOL;
+// RedisClient: 2.8

examples/monitor.php

@@ -10,13 +10,13 @@
  */
 
 /**
- * Using Monitor
+ * Monitor
  */
 
 namespace Examples;
 
-require (dirname(__DIR__).'/src/autoloader.php');
-// or require ('vendor/autoload.php');
+require (dirname(__DIR__).'/vendor/autoload.php');
+// or require (dirname(__DIR__).'/src/autoloader.php');
 
 use RedisClient\RedisClient;
 

examples/pipeline.php

@@ -10,13 +10,13 @@
  */
 
 /**
- * Using pipeline
+ * Pipeline
  */
 
 namespace Examples;
 
-require (dirname(__DIR__).'/src/autoloader.php');
-// or require ('vendor/autoload.php');
+require (dirname(__DIR__).'/vendor/autoload.php');
+// or require (dirname(__DIR__).'/src/autoloader.php');
 
 use RedisClient\Pipeline\Pipeline;
 use RedisClient\Pipeline\PipelineInterface;

examples/pubsub.php

@@ -10,13 +10,13 @@
  */
 
 /**
- * Using PubSub
+ * PubSub
  */
 
 namespace Examples;
 
-require (dirname(__DIR__).'/src/autoloader.php');
-// or require ('vendor/autoload.php');
+require (dirname(__DIR__).'/vendor/autoload.php');
+// or require (dirname(__DIR__).'/src/autoloader.php');
 
 use RedisClient\RedisClient;
 

examples/raw_commands.php

@@ -0,0 +1,41 @@
+<?php
+/**
+ * This file is part of RedisClient.
+ * git: https://github.com/cheprasov/php-redis-client
+ *
+ * (C) Alexander Cheprasov <cheprasov.84@ya.ru>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+/**
+ * RAW commands
+ */
+
+namespace Examples;
+
+require (dirname(__DIR__).'/vendor/autoload.php');
+// or require (dirname(__DIR__).'/src/autoloader.php');
+
+use RedisClient\RedisClient;
+
+$Redis = new RedisClient();
+
+// Example 1. As string[] by <executeRaw>
+// Every part of command must be a separate string
+// <executeRaw> is better way to use raw commands than <executeRawString>
+
+$Redis->executeRaw(['SET', 'foo', 'bar']);
+echo 'result: '. $Redis->executeRaw(['GET', 'foo']) .PHP_EOL;
+// bar
+
+// Example s. As string by <executeRawString>
+$Redis->executeRawString('SET foo bar');
+echo 'result: '. $Redis->executeRawString('GET foo') .PHP_EOL;
+// bar
+
+// You can use quotes for keys and arguments
+$Redis->executeRawString('SET "key with spaces" "or value with spaces"');
+echo 'result: '. $Redis->executeRawString('GET "key with spaces"') .PHP_EOL;
+// or value with spaces

examples/transactions.php

@@ -10,13 +10,13 @@
  */
 
 /**
- * Using transactions
+ * Transactions
  */
 
 namespace Examples;
 
-require (dirname(__DIR__).'/src/autoloader.php');
-// or require ('vendor/autoload.php');
+require (dirname(__DIR__).'/vendor/autoload.php');
+// or require (dirname(__DIR__).'/src/autoloader.php');
 
 use RedisClient\Pipeline\Pipeline;
 use RedisClient\Pipeline\PipelineInterface;

src/RedisClient/Client/Version/RedisClient2x6.php

@@ -15,10 +15,6 @@
 use RedisClient\Pipeline\PipelineInterface;
 use RedisClient\Pipeline\Version\Pipeline2x6;
 
-/**
- * Class RedisClient
- * @package RedisClient
- */
 class RedisClient2x6 extends AbstractRedisClient {
     use CommandsTrait;
 

src/RedisClient/Client/Version/RedisClient2x8.php

@@ -15,10 +15,6 @@
 use RedisClient\Pipeline\PipelineInterface;
 use RedisClient\Pipeline\Version\Pipeline2x8;
 
-/**
- * Class RedisClient
- * @package RedisClient
- */
 class RedisClient2x8 extends AbstractRedisClient {
     use CommandsTrait;
 

src/RedisClient/Client/Version/RedisClient3x0.php

@@ -15,10 +15,6 @@
 use RedisClient\Pipeline\PipelineInterface;
 use RedisClient\Pipeline\Version\Pipeline3x0;
 
-/**
- * Class RedisClient
- * @package RedisClient
- */
 class RedisClient3x0 extends AbstractRedisClient {
     use CommandsTrait;