Rajout de doctrine/orm
[zf2.biz/application_blanche.git] / vendor / doctrine / dbal / lib / Doctrine / DBAL / Sharding / PoolingShardConnection.php
diff --git a/vendor/doctrine/dbal/lib/Doctrine/DBAL/Sharding/PoolingShardConnection.php b/vendor/doctrine/dbal/lib/Doctrine/DBAL/Sharding/PoolingShardConnection.php
new file mode 100644 (file)
index 0000000..6453e63
--- /dev/null
@@ -0,0 +1,201 @@
+<?php
+/*
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the MIT license. For more information, see
+ * <http://www.doctrine-project.org>.
+ */
+
+namespace Doctrine\DBAL\Sharding;
+
+use Doctrine\DBAL\Connection;
+use Doctrine\DBAL\Event\ConnectionEventArgs;
+use Doctrine\DBAL\Events;
+use Doctrine\DBAL\Driver;
+use Doctrine\DBAL\Configuration;
+
+use Doctrine\Common\EventManager;
+
+use Doctrine\DBAL\Sharding\ShardChoser\ShardChoser;
+
+/**
+ * Sharding implementation that pools many different connections
+ * internally and serves data from the currently active connection.
+ *
+ * The internals of this class are:
+ *
+ * - All sharding clients are specified and given a shard-id during
+ *   configuration.
+ * - By default, the global shard is selected. If no global shard is configured
+ *   an exception is thrown on access.
+ * - Selecting a shard by distribution value delegates the mapping
+ *   "distributionValue" => "client" to the ShardChooser interface.
+ * - An exception is thrown if trying to switch shards during an open
+ *   transaction.
+ *
+ * Instantiation through the DriverManager looks like:
+ *
+ * @example
+ *
+ * $conn = DriverManager::getConnection(array(
+ *    'wrapperClass' => 'Doctrine\DBAL\Sharding\PoolingShardConnection',
+ *    'driver' => 'pdo_mysql',
+ *    'global' => array('user' => '', 'password' => '', 'host' => '', 'dbname' => ''),
+ *    'shards' => array(
+ *        array('id' => 1, 'user' => 'slave1', 'password', 'host' => '', 'dbname' => ''),
+ *        array('id' => 2, 'user' => 'slave2', 'password', 'host' => '', 'dbname' => ''),
+ *    ),
+ *    'shardChoser' => 'Doctrine\DBAL\Sharding\ShardChoser\MultiTenantShardChoser',
+ * ));
+ * $shardManager = $conn->getShardManager();
+ * $shardManager->selectGlobal();
+ * $shardManager->selectShard($value);
+ *
+ * @author Benjamin Eberlei <kontakt@beberlei.de>
+ */
+class PoolingShardConnection extends Connection
+{
+    /**
+     * @var array
+     */
+    private $activeConnections;
+
+    /**
+     * @var int
+     */
+    private $activeShardId;
+
+    /**
+     * @var array
+     */
+    private $connections;
+
+    /**
+     * @var ShardManager
+     */
+    private $shardManager;
+
+    public function __construct(array $params, Driver $driver, Configuration $config = null, EventManager $eventManager = null)
+    {
+        if ( !isset($params['global']) || !isset($params['shards'])) {
+            throw new \InvalidArgumentException("Connection Parameters require 'global' and 'shards' configurations.");
+        }
+
+        if ( !isset($params['shardChoser'])) {
+            throw new \InvalidArgumentException("Missing Shard Choser configuration 'shardChoser'");
+        }
+
+        if (is_string($params['shardChoser'])) {
+            $params['shardChoser'] = new $params['shardChoser'];
+        }
+
+        if ( ! ($params['shardChoser'] instanceof ShardChoser)) {
+            throw new \InvalidArgumentException("The 'shardChoser' configuration is not a valid instance of Doctrine\DBAL\Sharding\ShardChoser\ShardChoser"); 
+        }
+
+        $this->connections[0] = array_merge($params, $params['global']);
+
+        foreach ($params['shards'] as $shard) {
+            if ( ! isset($shard['id'])) {
+                throw new \InvalidArgumentException("Missing 'id' for one configured shard. Please specificy a unique shard-id.");
+            }
+
+            if ( !is_numeric($shard['id']) || $shard['id'] < 1) {
+                throw new \InvalidArgumentException("Shard Id has to be a non-negative number.");
+            }
+
+            if (isset($this->connections[$shard['id']])) {
+                throw new \InvalidArgumentException("Shard " . $shard['id'] . " is duplicated in the configuration.");
+            }
+
+            $this->connections[$shard['id']] = array_merge($params, $shard);
+        }
+
+        parent::__construct($params, $driver, $config, $eventManager);
+    }
+
+    /**
+     * Connect to a given shard
+     *
+     * @param mixed $shardId
+     * @return bool
+     */
+    public function connect($shardId = null)
+    {
+        if ($shardId === null && $this->_conn) {
+            return false;
+        }
+
+        if ($shardId !== null && $shardId === $this->activeShardId) {
+            return false;
+        }
+
+        if ($this->getTransactionNestingLevel() > 0) {
+            throw new ShardingException("Cannot switch shard when transaction is active.");
+        }
+
+        $this->activeShardId = (int)$shardId;
+
+        if (isset($this->activeConnections[$this->activeShardId])) {
+            $this->_conn = $this->activeConnections[$this->activeShardId];
+            return false;
+        }
+
+        $this->_conn = $this->activeConnections[$this->activeShardId] = $this->connectTo($this->activeShardId);
+
+        if ($this->_eventManager->hasListeners(Events::postConnect)) {
+            $eventArgs = new Event\ConnectionEventArgs($this);
+            $this->_eventManager->dispatchEvent(Events::postConnect, $eventArgs);
+        }
+
+        return true;
+    }
+
+
+    /**
+     * Connect to a specific connection
+     *
+     * @param  string $shardId
+     * @return Driver
+     */
+    protected function connectTo($shardId)
+    {
+        $params = $this->getParams();
+
+        $driverOptions = isset($params['driverOptions']) ? $params['driverOptions'] : array();
+
+        $connectionParams = $this->connections[$shardId];
+
+        $user = isset($connectionParams['user']) ? $connectionParams['user'] : null;
+        $password = isset($connectionParams['password']) ? $connectionParams['password'] : null;
+
+        return $this->_driver->connect($connectionParams, $user, $password, $driverOptions);
+    }
+
+    public function isConnected($shardId = null)
+    {
+        if ($shardId === null) {
+            return $this->_conn !== null;
+        }
+
+        return isset($this->activeConnections[$shardId]);
+    }
+
+    public function close()
+    {
+        $this->_conn             = null;
+        $this->activeConnections = null;
+    }
+}
+