Merge pull request #5 from larapulse/feature/PLD-3_add_options_to_PDOManager

PLD-3 Add custom options attribute to ConnectionManager

Author: SergeyPodgornyy

docs/CHANGELOG.md

@@ -4,6 +4,17 @@ All notable changes to `database` will be documented in this file.
 
 Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) principles.
 
+## 2017-12-12
+
+### Added
+- Ability to add custom options while connection using `ConnectionManager`
+
+### Removed
+- Useless `private` method `setConnection` in `ConnectionManager`
+
+### Fixed
+- Code readability
+
 ## 2017-11-22
 
 ### Deprecated

src/BulkSql/Base.php

@@ -151,7 +151,7 @@ final public function execute()
 
         // On first query check disable indeces
         if ($this->isIndexesDisabled() && $this->affectedCount === 0) {
-            $this->getDbConnection()->exec('ALTER TABLE ' . $this->getTable() . ' DISABLE KEYS');
+            $this->getDbConnection()->exec("ALTER TABLE {$this->getTable()} DISABLE KEYS");
         }
 
         $query = $this->buildQuery();
@@ -182,7 +182,7 @@ final public function finish()
 
         // Re-enable indexes
         if ($this->isIndexesDisabled()) {
-            $this->getDbConnection()->exec('ALTER TABLE ' . $this->getTable() . ' ENABLE KEYS');
+            $this->getDbConnection()->exec("ALTER TABLE {$this->getTable()} ENABLE KEYS");
         }
 
         $this->isFinished = true;

src/ConnectionManager.php

@@ -12,40 +12,31 @@ final class ConnectionManager
      *
      * @var TransactionPDO
      */
-    private $masterConnection = null;
+    private $masterConnection;
 
     /**
      * Slave database connection
      *
      * @var TransactionPDO|null
      */
-    private $slaveConnection = null;
+    private $slaveConnection;
 
     /**
      * PDOManager constructor
-     *
-     * @param string $name      Unique name for connection
-     * @param array  $config    Configuration settings for database connection
-     */
-    public function __construct(string $name, array $config)
-    {
-        $this->setConnection($name, $config);
-    }
-
-    /**
      * Initialize connection to Database for master and slave (if applicable)
      *
      * @param string $name      Unique name for connection
      * @param array  $config    Configuration settings for database connection
+     * @param array  $options   Some specific options
      */
-    private function setConnection(string $name, array $config)
+    public function __construct(string $name, array $config, array $options = [])
     {
         $masterConf = $config['master'] ?? $config;
         $slaveConf = $config['slave'] ?? [];
 
-        $this->masterConnection = Engine::setConnection($name.'_master', $masterConf);
+        $this->masterConnection = Engine::setConnection($name.'_master', $masterConf, $options);
         $this->slaveConnection = $slaveConf
-            ? Engine::setConnection($name.'_slave', $slaveConf)
+            ? Engine::setConnection($name.'_slave', $slaveConf, $options)
             : null;
     }
 

src/Driver/Engine.php

@@ -32,10 +32,11 @@ final class Engine
     /**
      * Set connection with database
      *
-     * @param string $name      Unique name for connection
-     * @param array  $config    Configuration settings for database connection
-     * @param array  $options   Some specific options
+     * @param string $name    Unique name for connection
+     * @param array  $config  Configuration settings for database connection
+     * @param array  $options Some specific options
      *
+     * @throws \League\Database\Exceptions\InvalidArgumentException
      * @return bool|TransactionPDO
      */
     public static function setConnection(string $name, array $config, array $options = [])

src/Driver/TransactionPDO.php

@@ -10,7 +10,7 @@ class TransactionPDO extends PDO
     /**
      * @var array   Database drivers that support SAVEPOINT * statements.
      */
-    protected static $supportedDrivers = ["pgsql", "mysql"];
+    protected static $supportedDrivers = ['pgsql', 'mysql'];
 
     /**
      * @var int     Current transaction depth
@@ -24,7 +24,7 @@ class TransactionPDO extends PDO
      */
     protected function hasSavepoint() : bool
     {
-        return in_array($this->getAttribute(PDO::ATTR_DRIVER_NAME), self::$supportedDrivers);
+        return in_array($this->getAttribute(PDO::ATTR_DRIVER_NAME), self::$supportedDrivers, true);
     }
 
     /**

src/Utils/Transaction.php

@@ -58,9 +58,7 @@ private static function getConnection($connection = null)
      */
     public static function begin($connection = null) : bool
     {
-        return self::getConnection($connection)
-            ? self::getConnection($connection)->beginTransaction()
-            : false;
+        return self::getConnection($connection) && self::getConnection($connection)->beginTransaction();
     }
 
     /**
@@ -72,36 +70,34 @@ public static function begin($connection = null) : bool
      */
     public static function commit($connection = null) : bool
     {
-        return self::getConnection($connection)
-            ? self::getConnection($connection)->commit()
-            : false;
+        return self::getConnection($connection) && self::getConnection($connection)->commit();
     }
 
     /**
      * Rollback transaction on connection
      *
      * @param string|TransactionPDO $connection
      *
+     * @throws \PDOException
      * @return bool
      */
     public static function rollback($connection = null) : bool
     {
-        return self::getConnection($connection)
-            ? self::getConnection($connection)->rollBack()
-            : false;
+        return self::getConnection($connection) && self::getConnection($connection)->rollBack();
     }
 
     /**
      * Perform some callback while transaction execution
      *
-     * @param Closure $callback
-     * @param null    $connection
+     * @param Closure               $callback
+     * @param string|TransactionPDO $connection
      *
      * @throws LogicException
      * @throws TransactionException
      */
     public static function perform(Closure $callback, $connection = null)
     {
+        /** @var TransactionPDO|bool $connection */
         $connection = self::getConnection($connection);
 
         if ($connection === false) {