From: Pierre Rudloff <contact@rudloff.pro>
Date: Wed, 16 May 2018 11:14:50 +0000 (+0200)
Subject: Add some explanation in DatabaseTest::getConnection()
X-Git-Url: https://git.mxchange.org/?a=commitdiff_plain;h=f3ca3b2bd5c15d8bc42b05250e3a562b72a42a0c;p=friendica.git

Add some explanation in DatabaseTest::getConnection()
---

diff --git a/tests/DatabaseTest.php b/tests/DatabaseTest.php
index 7819b46ab8..5a9a563a5d 100644
--- a/tests/DatabaseTest.php
+++ b/tests/DatabaseTest.php
@@ -22,6 +22,12 @@ abstract class DatabaseTest extends TestCase
 
 	/**
 	 * Get database connection.
+	 *
+	 * This function is executed before each test in order to get a database connection that can be used by tests.
+	 * If no prior connection is available, it tries to create one using the USER, PASS and DB environment variables.
+	 *
+	 * If it could not connect to the database, the test is skipped.
+	 *
 	 * @return PHPUnit_Extensions_Database_DB_IDatabaseConnection
 	 * @see https://phpunit.de/manual/5.7/en/database.html
 	 */