Docs - Fix @SInCE tag

Arch - Remove getDatabase() from interface (needs to be protected, but that's not allowed in an interface; hadn't thought of that. Sorry, Allon!)
joomla-framework · Mar 2, 2022 · bf0c004 · bf0c004
1 parent bda9982
commit bf0c004
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 34 deletions.
diff --git a/Tests/DatabaseAwareTraitTest.php b/Tests/DatabaseAwareTraitTest.php
@@ -1,15 +1,14 @@
 <?php
 /**
- * @copyright  Copyright (C) 2005 - 2022 Open Source Matters, Inc. All rights reserved.
- * @license	GNU General Public License version 2 or later; see LICENSE
+ * @copyright  Copyright (C) 2022 Open Source Matters, Inc. All rights reserved.
+ * @license    GNU General Public License version 2 or later; see LICENSE
  */
 
 namespace Joomla\Database\Tests;
 
-use Joomla\Database\DatabaseInterface;
 use Joomla\Database\DatabaseAwareTrait;
+use Joomla\Database\DatabaseInterface;
 use Joomla\Database\Exception\DatabaseNotFoundException;
-use Joomla\Test\TestHelper;
 use PHPUnit\Framework\TestCase;
 
 /**
@@ -25,10 +24,10 @@ class DatabaseAwareTraitTest extends TestCase
 	/**
 	 * @testdox  Database can be set with setDatabase()
 	 *
-	 * @covers   Joomla\Database\DatabaseAwareTrait
-	 * @uses	 Joomla\Database\Database
+	 * @covers   \Joomla\Database\DatabaseAwareTrait
+	 * @uses     \Joomla\Database\Database
 	 */
-	public function testGetSetDatabase()
+	public function testGetSetDatabase(): void
 	{
 		$db = $this->createMock(DatabaseInterface::class);
 
@@ -41,9 +40,9 @@ public function testGetSetDatabase()
 	/**
 	 * @testdox  getDatabase() throws an DatabaseNotFoundException, if no database is set
 	 *
-	 * @covers   Joomla\Database\DatabaseAwareTrait
+	 * @covers   \Joomla\Database\DatabaseAwareTrait
 	 */
-	public function testGetDatabaseException()
+	public function testGetDatabaseException(): void
 	{
 		$this->expectException(DatabaseNotFoundException::class);
 

diff --git a/src/DatabaseAwareInterface.php b/src/DatabaseAwareInterface.php
@@ -2,7 +2,7 @@
 /**
  * Part of the Joomla Framework Database Package
  *
- * @copyright  Copyright (C) 2005 - 2022 Open Source Matters, Inc. All rights reserved.
+ * @copyright  Copyright (C) 2022 Open Source Matters, Inc. All rights reserved.
  * @license    GNU General Public License version 2 or later; see LICENSE
  */
 
@@ -11,28 +11,18 @@
 /**
  * Defines the interface for a DatabaseInterface aware class.
  *
- * @since  2.0.3
+ * @since  2.1.0
  */
 interface DatabaseAwareInterface
 {
-	/**
-	 * Get the database.
-	 *
-	 * @return  DatabaseInterface
-	 *
-	 * @since   2.0.3
-	 * @throws  DatabaseNotFoundException May be thrown if the database has not been set.
-	 */
-	public function getDatabase(): DatabaseInterface;
-
 	/**
 	 * Set the database.
 	 *
 	 * @param   DatabaseInterface  $db  The database.
 	 *
 	 * @return  void
 	 *
-	 * @since   2.0.3
+	 * @since   2.1.0
 	 */
 	public function setDatabase(DatabaseInterface $db): void;
 }
diff --git a/src/DatabaseAwareTrait.php b/src/DatabaseAwareTrait.php
@@ -2,7 +2,7 @@
 /**
  * Part of the Joomla Framework Database Package
  *
- * @copyright  Copyright (C) 2005 - 2022 Open Source Matters, Inc. All rights reserved.
+ * @copyright  Copyright (C) 2022 Open Source Matters, Inc. All rights reserved.
  * @license	GNU General Public License version 2 or later; see LICENSE
  */
 
@@ -13,30 +13,31 @@
 /**
  * Defines the trait for a Database Aware Class.
  *
- * @since  2.0.3
+ * @since  2.1.0
  */
 trait DatabaseAwareTrait
 {
 	/**
 	 * Database
 	 *
 	 * @var	   DatabaseInterface
-	 * @since  2.0.3
+	 * @since  2.1.0
 	 */
-	private $_db;
+	private $databaseAwareTraitDatabase;
 
 	/**
 	 * Get the database.
 	 *
 	 * @return  DatabaseInterface
 	 *
-	 * @since   2.0.3
+	 * @since   2.1.0
 	 * @throws  DatabaseNotFoundException May be thrown if the database has not been set.
 	 */
-	public function getDatabase()
+	protected function getDatabase(): DatabaseInterface
 	{
-		if ($this->_db) {
-			return $this->_db;
+		if ($this->databaseAwareTraitDatabase)
+		{
+			return $this->databaseAwareTraitDatabase;
 		}
 
 		throw new DatabaseNotFoundException('Database not set in ' . \get_class($this));
@@ -49,10 +50,10 @@ public function getDatabase()
 	 *
 	 * @return  void
 	 *
-	 * @since   2.0.3
+	 * @since   2.1.0
 	 */
 	public function setDatabase(DatabaseInterface $db): void
 	{
-		$this->_db = $db;
+		$this->databaseAwareTraitDatabase = $db;
 	}
 }
diff --git a/src/Exception/DatabaseNotFoundException.php b/src/Exception/DatabaseNotFoundException.php
@@ -2,7 +2,7 @@
 /**
  * Part of the Joomla Framework Database Package
  *
- * @copyright  Copyright (C) 2005 - 2022 Open Source Matters, Inc. All rights reserved.
+ * @copyright  Copyright (C) 2022 Open Source Matters, Inc. All rights reserved.
  * @license    GNU General Public License version 2 or later; see LICENSE
  */
 
@@ -11,7 +11,7 @@
 /**
  * No database is available.
  *
- * @since  2.0.3
+ * @since  2.1.0
  */
 class DatabaseNotFoundException extends \RuntimeException
 {