From 9bb2785da0c84bcc4a95f737b7da14c58c5d4380 Mon Sep 17 00:00:00 2001
From: Patrick Webster <noxwizard@phpbb.com>
Date: Mon, 2 Apr 2012 05:57:48 -0500
Subject: [PATCH] [ticket/10678] More formatting and docblocks

PHPBB3-10678
---
 tests/test_framework/phpbb_database_test_case.php      | 10 +++++++++-
 .../phpbb_database_test_connection_manager.php         |  6 +++---
 2 files changed, 12 insertions(+), 4 deletions(-)

diff --git a/tests/test_framework/phpbb_database_test_case.php b/tests/test_framework/phpbb_database_test_case.php
index b8be6a852a..53c3702aa6 100644
--- a/tests/test_framework/phpbb_database_test_case.php
+++ b/tests/test_framework/phpbb_database_test_case.php
@@ -32,7 +32,7 @@ abstract class phpbb_database_test_case extends PHPUnit_Extensions_Database_Test
 	{
 		$db_config = $this->get_database_config();
 
-		//Firebird requires table and column names to be uppercase
+		// Firebird requires table and column names to be uppercase
 		if ($db_config['dbms'] == 'firebird')
 		{
 			$xml_data = file_get_contents($path);
@@ -129,6 +129,14 @@ abstract class phpbb_database_test_case extends PHPUnit_Extensions_Database_Test
 		return new phpbb_database_test_connection_manager($config);
 	}
 
+	/**
+	* Converts a match in the middle of a string to uppercase.
+	* This is necessary for tranforming the fixture information for Firebird tests
+	*
+	* @param $matches The array of matches from a regular expression
+	*
+	* @return string The string with the specified match converted to uppercase
+	*/
 	public static function to_upper($matches)
 	{
 		return $matches[1] . strtoupper($matches[2]) . $matches[3];
diff --git a/tests/test_framework/phpbb_database_test_connection_manager.php b/tests/test_framework/phpbb_database_test_connection_manager.php
index 2334e08f78..3c4a112d0d 100644
--- a/tests/test_framework/phpbb_database_test_connection_manager.php
+++ b/tests/test_framework/phpbb_database_test_connection_manager.php
@@ -84,8 +84,8 @@ class phpbb_database_test_connection_manager
 			break;
 		}
 
-		//These require different connection strings on the phpBB side than they do in PDO
-		//so you must provide a DSN string for ODBC separately
+		// These require different connection strings on the phpBB side than they do in PDO
+		// so you must provide a DSN string for ODBC separately
 		if (!empty($this->config['custom_dsn']) && ($this->config['dbms'] == 'mssql' || $this->config['dbms'] == 'firebird'))
 		{
 			$dsn = 'odbc:' . $this->config['custom_dsn'];
@@ -106,7 +106,7 @@ class phpbb_database_test_connection_manager
 						$this->pdo = new phpbb_database_connection_ODBC_PDO_wrapper('firebird', 0, $dsn, $this->config['dbuser'], $this->config['dbpasswd']);
 						break;
 					}
-					//Fall through if they're using the firebird PDO driver and not the generic ODBC driver
+					// Fall through if they're using the firebird PDO driver and not the generic ODBC driver
 
 				default:
 					$this->pdo = new PDO($dsn, $this->config['dbuser'], $this->config['dbpasswd']);