[2.0] DDC-296 - Implement and document Mysql Session Init 'postConnect' Subscriber

lib/Doctrine/DBAL/Event/Listeners/MysqlSessionInit.php

@@ -0,0 +1,75 @@
+<?php
+/*
+ *  $Id$
+ *
+ * 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 LGPL. For more information, see
+ * <http://www.doctrine-project.org>.
+*/
+
+namespace Doctrine\DBAL\Event\Listeners;
+
+use Doctrine\DBAL\Event\ConnectionEventArgs;
+use Doctrine\DBAL\Events;
+use Doctrine\Common\EventSubscriber;
+
+/**
+ * MySQL Session Init Event Subscriber which allows to set the Client Encoding of the Connection
+ *
+ * @license     http://www.opensource.org/licenses/lgpl-license.php LGPL
+ * @link        www.doctrine-project.com
+ * @since       1.0
+ * @version     $Revision$
+ * @author      Benjamin Eberlei <kontakt@beberlei.de>
+ */
+class MysqlSessionInit implements EventSubscriber
+{
+    /**
+     * @var string
+     */
+    private $_charset;
+
+    /**
+     * @var string
+     */
+    private $_collation;
+
+    /**
+     * Configure Charset and Collation options of MySQL Client for each Connection
+     *
+     * @param string $charset
+     * @param string $collation
+     */
+    public function __construct($charset = 'utf8', $collation = false)
+    {
+        $this->_charset = $charset;
+        $this->_collation = $collation;
+    }
+
+    /**
+     * @param ConnectionEventArgs $args
+     * @return void
+     */
+    public function postConnect(ConnectionEventArgs $args)
+    {
+        $collation = ($this->_collation) ? " COLLATE '".$this->_collation : "'";
+        $args->getConnection()->executeUpdate("SET NAMES '".$this->_charset . "'" . $collation);
+    }
+
+    public function getSubscribedEvents()
+    {
+        return array(Events::postConnect);
+    }
+}

tests/Doctrine/Tests/DBAL/AllTests.php

@@ -59,6 +59,7 @@ class AllTests
         
         // Events and Listeners
         $suite->addTestSuite('Doctrine\Tests\DBAL\Events\OracleSessionInitTest');
+        $suite->addTestSuite('Doctrine\Tests\DBAL\Events\MysqlSessionInitTest');
 
         // All Functional DBAL tests
         $suite->addTest(Functional\AllTests::suite());

tests/Doctrine/Tests/DBAL/Events/MysqlSessionInitTest.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace Doctrine\Tests\DBAL\Events;
+
+use Doctrine\Tests\DbalTestCase;
+use Doctrine\DBAL\Event\Listeners\MysqlSessionInit;
+use Doctrine\DBAL\Event\ConnectionEventArgs;
+use Doctrine\DBAL\Events;
+
+require_once __DIR__ . '/../../TestInit.php';
+
+class MysqlSessionInitTest extends DbalTestCase
+{
+    public function testPostConnect()
+    {
+        $connectionMock = $this->getMock('Doctrine\DBAL\Connection', array(), array(), '', false);
+        $connectionMock->expects($this->once())
+                       ->method('executeUpdate')
+                       ->with($this->equalTo("SET NAMES 'foo' COLLATE 'bar"));
+
+        $eventArgs = new ConnectionEventArgs($connectionMock);
+
+
+        $listener = new MysqlSessionInit('foo', 'bar');
+        $listener->postConnect($eventArgs);
+    }
+
+    public function testGetSubscribedEvents()
+    {
+        $listener = new MysqlSessionInit();
+        $this->assertEquals(array(Events::postConnect), $listener->getSubscribedEvents());
+    }
+}