[4.2] Change the db calls back to the getDbo (#38506)

* Change the db calls back to the getDbo * add test
joomla · Aug 18, 2022 · 1ce74dc · 1ce74dc
1 parent 196c9e5
commit 1ce74dc
Show file tree

Hide file tree

Showing 4 changed files with 58 additions and 15 deletions.
diff --git a/libraries/src/MVC/Model/AdminModel.php b/libraries/src/MVC/Model/AdminModel.php
@@ -415,7 +415,7 @@ protected function batchCopy($value, $pks, $contexts)
         }
 
         $newIds = array();
-        $db     = $this->getDatabase();
+        $db     = $this->getDbo();
 
         // Parent exists so let's proceed
         while (!empty($pks)) {
@@ -840,7 +840,7 @@ public function delete(&$pks)
 
                     // Multilanguage: if associated, delete the item in the _associations table
                     if ($this->associationsContext && Associations::isEnabled()) {
-                        $db = $this->getDatabase();
+                        $db = $this->getDbo();
                         $query = $db->getQuery(true)
                             ->select(
                                 [
@@ -1305,7 +1305,7 @@ public function save($data)
             }
 
             // Get associationskey for edited item
-            $db    = $this->getDatabase();
+            $db    = $this->getDbo();
             $id    = (int) $table->$key;
             $query = $db->getQuery(true)
                 ->select($db->quoteName('key'))

diff --git a/libraries/src/MVC/Model/BaseDatabaseModel.php b/libraries/src/MVC/Model/BaseDatabaseModel.php
@@ -46,7 +46,8 @@ abstract class BaseDatabaseModel extends BaseModel implements
     DatabaseModelInterface,
     DispatcherAwareInterface,
     CurrentUserInterface,
-    CacheControllerFactoryAwareInterface
+    CacheControllerFactoryAwareInterface,
+    DatabaseAwareInterface
 {
     use DatabaseAwareTrait;
     use MVCFactoryAwareTrait;
@@ -151,13 +152,13 @@ public function __construct($config = array(), MVCFactoryInterface $factory = nu
     protected function _getList($query, $limitstart = 0, $limit = 0)
     {
         if (\is_string($query)) {
-            $query = $this->getDatabase()->getQuery(true)->setQuery($query);
+            $query = $this->getDbo()->getQuery(true)->setQuery($query);
         }
 
         $query->setLimit($limit, $limitstart);
-        $this->getDatabase()->setQuery($query);
+        $this->getDbo()->setQuery($query);
 
-        return $this->getDatabase()->loadObjectList();
+        return $this->getDbo()->loadObjectList();
     }
 
     /**
@@ -188,9 +189,9 @@ protected function _getListCount($query)
             $query = clone $query;
             $query->clear('select')->clear('order')->clear('limit')->clear('offset')->select('COUNT(*)');
 
-            $this->getDatabase()->setQuery($query);
+            $this->getDbo()->setQuery($query);
 
-            return (int) $this->getDatabase()->loadResult();
+            return (int) $this->getDbo()->loadResult();
         }
 
         // Otherwise fall back to inefficient way of counting all results.
@@ -201,10 +202,10 @@ protected function _getListCount($query)
             $query->clear('limit')->clear('offset')->clear('order');
         }
 
-        $this->getDatabase()->setQuery($query);
-        $this->getDatabase()->execute();
+        $this->getDbo()->setQuery($query);
+        $this->getDbo()->execute();
 
-        return (int) $this->getDatabase()->getNumRows();
+        return (int) $this->getDbo()->getNumRows();
     }
 
     /**
@@ -223,7 +224,7 @@ protected function _createTable($name, $prefix = 'Table', $config = array())
     {
         // Make sure we are returning a DBO object
         if (!\array_key_exists('dbo', $config)) {
-            $config['dbo'] = $this->getDatabase();
+            $config['dbo'] = $this->getDbo();
         }
 
         return $this->getMVCFactory()->createTable($name, $prefix, $config);
@@ -394,7 +395,7 @@ public function setDbo(DatabaseInterface $db = null)
     public function __get($name)
     {
         if ($name === '_db') {
-            return $this->getDatabase();
+            return $this->getDbo();
         }
 
         // Default the variable

diff --git a/libraries/src/MVC/Model/ListModel.php b/libraries/src/MVC/Model/ListModel.php
@@ -276,7 +276,7 @@ public function getItems()
      */
     protected function getListQuery()
     {
-        return $this->getDatabase()->getQuery(true);
+        return $this->getDbo()->getQuery(true);
     }
 
     /**

diff --git a/tests/Unit/Libraries/Cms/MVC/Model/DatabaseModelTest.php b/tests/Unit/Libraries/Cms/MVC/Model/DatabaseModelTest.php
@@ -316,6 +316,48 @@ public function testCheckedOutWitFieldEmptyUserSet()
         $this->assertTrue($model->isCheckedOut((object)['checked_out' => 1]));
     }
 
+    /**
+     * @testdox  that all function calls go over deprecated getDbo function
+     *
+     * @return  void
+     *
+     * @since   __DEPLOY_VERSION__
+     *
+     * @deprecated  5.0 Must be removed when database calls are changed to getDatabase in libraries models
+     */
+    public function testOverrideOldDboFunction()
+    {
+        $db = $this->createMock(DatabaseInterface::class);
+        $db->expects($this->never())->method('setQuery');
+
+        $query = $this->getQueryStub($db);
+        $newDb = $this->createMock(DatabaseInterface::class);
+        $newDb->expects($this->once())->method('setQuery')->with($this->equalTo($query));
+
+        $model = new class (['dbo' => $db], $this->createStub(MVCFactoryInterface::class), $newDb) extends BaseDatabaseModel
+        {
+            private $newDb;
+
+            public function __construct(array $config, MVCFactoryInterface $factory, DatabaseInterface $newDb)
+            {
+                parent::__construct($config, $factory);
+
+                $this->newDb = $newDb;
+            }
+
+            public function _getList($query, $limitstart = 0, $limit = 0)
+            {
+                return parent::_getList($query, $limitstart, $limit);
+            }
+
+            public function getDbo()
+            {
+                return $this->newDb;
+            }
+        };
+        $model->_getList($query, 0, 1);
+    }
+
     /**
      * @testdox  still can use the old trait
      *