update README + update Session::start

Author: rancoud

README.md

@@ -10,21 +10,80 @@ composer require rancoud/session
 ```
 
 ## How to use it?
+The most popular
 ```php
+Session::set('key', 'value');
+$value = Session::get('key');
+```
+In read only
+```php
+Session::readOnly();
+Session::set('key', 'value');
+$value = Session::get('key');
+```
+With custom options
+```php
+Session::start(['read_and_close' => true]);
+Session::set('key', 'value');
+$value = Session::get('key');
+```
+With encryption on default php session
+```php
+Session::useDefaultEncryptionDriver('keyForEncryption');
+Session::set('key', 'value');
+$value = Session::get('key');
+```
+With File driver
+```php
+Session::useFileDriver();
+Session::set('key', 'value');
+$value = Session::get('key');
+```
+With Database driver (you have to install rancoud/database)
+```php
+$conf = new \Rancoud\Database\Configurator([
+    'engine'   => 'mysql',
+    'host'     => '127.0.0.1',
+    'user'     => 'root',
+    'password' => '',
+    'database' => 'test_database'
+]);
+$db = new \Rancoud\Database\Database($conf);
+
+// for using a current connection
+Session::useCurrentDatabaseDriver($db);
+
+// for creating a new connection
+//Session::useNewDatabaseDriver($conf);
 
+Session::set('key', 'value');
+$value = Session::get('key');
 ```
+With Redis driver (you have to install predis/predis)
+```php
+$params = [
+    'scheme' => 'tcp',
+    'host'   => '127.0.0.1',
+    'port'   => 6379,
+];
+$redis = new Predis\Client($params);
 
-## Session Constructor
-### Settings
-#### Mandatory
-| Parameter | Type | Description |
-| --- | --- | --- |
-|  |  |  |
+// for using a current connection
+Session::useCurrentRedisDriver($redis);
 
-#### Optionnals
-| Parameter | Type | Default value | Description |
-| --- | --- | --- | --- |
-|  |  |  |  |
+// for creating a new connection
+//Session::useNewRedisDriver($params);
+
+Session::set('key', 'value');
+$value = Session::get('key');
+```
+With your own driver implementing SessionHandlerInterface
+```php
+$driver = new MyCustomDriver();
+Session::useCustomDriver($driver);
+Session::set('key', 'value');
+$value = Session::get('key');
+```
 
 ## Session Methods
 ### General Commands  
@@ -37,7 +96,7 @@ Extends SessionHandler
 ## Database
 You need to install
 ```php
-composer require rancoud/session
+composer require rancoud/database
 ```
 ```sql
 CREATE TABLE IF NOT EXISTS `sessions` (

src/Session.php

@@ -13,6 +13,7 @@
  */
 class Session
 {
+    /** @var bool */
     protected static $hasStarted = false;
     /** @var SessionHandlerInterface */
     protected static $driver = null;
@@ -24,29 +25,35 @@ class Session
     protected static $cookieDomain = null;
     /** @var string */
     protected static $lifetime = 1440;
+    /** @var bool */
+    protected static $readOnly = false;
+    protected static $options = [];
 
     /**
-     * @throws \Exception
+     * @param array $options
+     *
+     * @throws Exception
      */
-    public static function start(): void
+    public static function start(array $options = []): void
     {
         static::throwExceptionIfHasStarted();
 
         static::configureDriver();
         static::setupSessionParameters();
-        static::startSession();
-        static::$driver->gc(static::$lifetime);
+        static::startSession($options);
 
         static::$hasStarted = true;
+        if (array_key_exists('read_and_close', $options) && $options['read_and_close'] === true) {
+            static::$hasStarted = false;
+        }
     }
 
     /**
      * @throws \Exception
      */
     protected static function throwExceptionIfHasStarted(): void
     {
-        $status = static::status();
-        if ($status === PHP_SESSION_ACTIVE) {
+        if (static::hasStarted()) {
             throw new Exception('Session already started');
         }
     }
@@ -432,6 +439,7 @@ protected static function setupIniSession(array $options = []): array
         $options['cookie_httponly'] = $options['cookie_httponly'] ?? '1';
         $options['use_only_cookies'] = $options['use_only_cookies'] ?? '1';
         $options['use_trans_sid'] = $options['use_trans_sid'] ?? '0';
+        $options['read_and_close'] = $options['read_and_close'] ?? static::$readOnly;
 
         return $options;
     }
@@ -468,12 +476,17 @@ public static function abort(): bool
         return session_abort();
     }
 
+    public static function readOnly(): void
+    {
+        static::$readOnly = true;
+    }
+
     /**
-     * @return int
+     * @return bool
      */
-    public static function status(): int
+    public static function hasStarted(): bool
     {
-        return session_status();
+        return static::$hasStarted;
     }
 
     /**
@@ -551,11 +564,8 @@ public static function remove($key): void
      */
     protected static function startSessionIfNotHasStarted(): void
     {
-        $status = static::status();
-        if ($status === PHP_SESSION_NONE) {
+        if (!static::hasStarted()) {
             static::start();
-        } elseif ($status === PHP_SESSION_DISABLED) {
-            throw new Exception('Session disabled');
         }
     }