[5.4] Replace table _db with DatabaseAwareTrait

[HLeithner]

PR fixes Issue in joomla-framework/database#326

Summary of Changes

Forward compatibility PR to use DatabaseAwareTrait which allows us to set a database driver which implements only the DatabaseInterface and does not need to extend the DatabaseDriver.

This pr introduces setDatabase() and getDatabase() in a b/c way until the _db variable and setDbo() and getDbo() gets removed.

@alexandreelise please test this pr for your use case and mark it as success if it fixes your issue.

Testing Instructions

Use Joomla, use any 3rd party extension which uses the Table class.

Actual result BEFORE applying this Pull Request

Works

Expected result AFTER applying this Pull Request

Works

Link to documentations

Please select:

• Documentation link for docs.joomla.org:

• No documentation changes for docs.joomla.org needed

• Pull Request link for manual.joomla.org: TBD

• No documentation changes for manual.joomla.org needed

[alexandreelise]

@HLeithner might be useful. Unfortunately I use my PR in production already. Cannot afford to wait for Joomla to catch up and wait for Joomla 5.4. Nice work keep on your good work.

[HLeithner]

You don't need to wait, just please test it.

[alexandreelise]

You don't need to wait, just please test it.

Tested successfully

It works even with a driver different than the one of the main database.

In this case I tried mysql driver for the external database which is used for PDO Driver (but PDODriver is an abstract class) and the main joomla database untouched from your pr is using mysqli driver

Here is a screenshot of data fetched from external database using an Table instantiated via anonymous class with injected external DatabaseInterface compatible from DatabaseFactory getDriver method.

[alexandreelise]

Hey @HLeithner #45165 (comment) Tested successfully. Enjoy your weekend Super Joomlers.

[fgsw]

@alexandreelise Can you open https://issues.joomla.org/tracker/joomla-cms/45165 and

Login with your github-account and

1. click button "Test this"
2. mark "Tested successfully"
3. click button "Submit test result".

Now the test count as successfull.

[alexandreelise]

I have tested this item ✅ successfully on 0743884

Please refer to https://issues.joomla.org/tracker/joomla-cms/45165#event-815648

---

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/45165.}

[alexandreelise]

Thanks @fgsw . Done. Enjoy your weekend.

---

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/45165.}

[richard67]

@alexandreelise The PR has received a change. Could you test again? Just a quick check if it still works would be sufficient. Thanks in advance.

[alexandreelise]

@richard67 Tested it and seems to still work as expected if I didn't do a mistake will testing. For me it still works fine just as the previous screenshot I showed.

---

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/45165.}

[joomdonation]

I have tested this item ✅ successfully on d91c66d

---

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/45165.}

[richard67]

@alexandreelise Sorry to bother you again, but the PR has again received changes. But I think now it's ready. Could you test again with the latest version and if ok, submit your test result with the issue tracker? Thanks in advance.

[alexandreelise]

I have tested this item ✅ successfully on 6cdbf1b

@richard67 Still working as expected. Same outcome than before.

---

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/45165.}

[alexandreelise]

I have tested this item ✅ successfully on 6cdbf1b

@richard67 Still working as expected. Same outcome than before.

---

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/45165.}

[alexandreelise]

@richard67 Hey Richard, test done again with new changes. Seems to still work as expected. Same outcome. Tested successfully.

---

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/45165.}

[richard67]

RTC

---

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/45165.}

[laoneo]

When a developer does setup a database in the constructor and assigns it with "$this->_db" then we have a difference here which might lead to unintended divergence. This should be handled somehow, that's why I used magic methods in #37095.

[HLeithner]

When a developer does setup a database in the constructor and assigns it with "$this->_db" then we have a difference here which might lead to unintended divergence. This should be handled somehow, that's why I used magic methods in #37095.

That's the reason I don't use databaseAwareTraitDatabase write only. databaseAwareTraitDatabase also can't be read by any child class. It's only set for documentation purpose.

The reason I didn't use the magic function is, that if someone uses this on it's own, we would have the same issue again. Using the _db until we remove it, seems to be the better way for me.

[richard67]

@laoneo Are you ok with Harald's answer to your comment?

[laoneo]

I guess this is fine here. The hard bc break comes, when $this->_db get removed.

[alexandreelise]

Yooooohooooo!! Merged! Thanks for your hard work Super Joomlers! @richard67 @HLeithner @muhme @joomdonation and others

[richard67]

Thanks

[alexandreelise]

Thanks

My pleasure, Richard. Enjoy your weekend.