[2.0] DDC-295 - Add OracleSessionInit postConnect Subscriber

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

@@ -0,0 +1,82 @@
+<?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;
+
+/**
+ * Should be used when Oracle Server default enviroment does not match the Doctrine requirements.
+ *
+ * The following enviroment variables are required for the Doctrine default date format:
+ *
+ * NLS_TIME_FORMAT="HH24:MI:SS"
+ * NLS_DATE_FORMAT="YYYY-MM-DD"
+ * NLS_TIMESTAMP_FORMAT="YYYY-MM-DD HH24:MI:SS"
+ * NLS_TIMESTAMP_TZ_FORMAT="YYYY-MM-DD HH24:MI:SS TZH:TZM"
+ *
+ * @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 OracleSessionInit implements EventSubscriber
+{
+    protected $_defaultSessionVars = array(
+        'NLS_TIME_FORMAT' => "HH24:MI:SS",
+        'NLS_DATE_FORMAT' => "YYYY-MM-DD",
+        'NLS_TIMESTAMP_FORMAT' => "YYYY-MM-DD HH24:MI:SS",
+        'NLS_TIMESTAMP_TZ_FORMAT' => "YYYY-MM-DD HH24:MI:SS TZH:TZM",
+    );
+
+    /**
+     * @param array $oracleSessionVars
+     */
+    public function __construct(array $oracleSessionVars = array())
+    {
+        $this->_defaultSessionVars = array_merge($this->_defaultSessionVars, $oracleSessionVars);
+    }
+
+    /**
+     * @param ConnectionEventArgs $args
+     * @return void
+     */
+    public function postConnect(ConnectionEventArgs $args)
+    {
+        if (count($this->_defaultSessionVars)) {
+            array_change_key_case($this->_defaultSessionVars, \CASE_UPPER);
+            $vars = array();
+            foreach ($this->_defaultSessionVars AS $option => $value) {
+                $vars[] = $option." = '".$value."'";
+            }
+            $sql = "ALTER SESSION SET ".implode(" ", $vars);
+            $args->getConnection()->executeUpdate($sql);
+        }
+    }
+
+    public function getSubscribedEvents()
+    {
+        return array(Events::postConnect);
+    }
+}

tests/Doctrine/Tests/DBAL/AllTests.php

@@ -56,6 +56,9 @@ class AllTests
 
         // Connection test
         $suite->addTestSuite('Doctrine\Tests\DBAL\ConnectionTest');
+        
+        // Events and Listeners
+        $suite->addTestSuite('Doctrine\Tests\DBAL\Events\OracleSessionInitTest');
 
         // All Functional DBAL tests
         $suite->addTest(Functional\AllTests::suite());

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

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

tests/dbproperties.xml.dev

@@ -20,6 +20,7 @@
     <var name="db_password" value="" />
     <var name="db_name" value="doctrine_tests" />
     <var name="db_port" value="3306"/>
+    <!--<var name="db_event_subscribers" value="Doctrine\DBAL\Event\Listeners\OracleSessionInit">-->
     
     <!-- Database for temporary connections (i.e. to drop/create the main database) -->
     <var name="tmpdb_type" value="pdo_mysql"/>