Add some explanation in DatabaseTest::getConnection()

This commit is contained in:
Pierre Rudloff 2018-05-16 13:14:50 +02:00
parent f7064be41f
commit f3ca3b2bd5
1 changed files with 6 additions and 0 deletions

View File

@ -22,6 +22,12 @@ abstract class DatabaseTest extends TestCase
/** /**
* Get database connection. * 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 * @return PHPUnit_Extensions_Database_DB_IDatabaseConnection
* @see https://phpunit.de/manual/5.7/en/database.html * @see https://phpunit.de/manual/5.7/en/database.html
*/ */