Skip to content

[7.0] Remove deprecated getDbo()/setDbo() from Table class #47440

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Hackwar wants to merge 8 commits into
base: 7.0-dev
Choose a base branch
from
Open

[7.0] Remove deprecated getDbo()/setDbo() from Table class #47440

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
f6b6ee5
Remove deprecated getDbo()/setDbo() from Table class
Hackwar Mar 20, 2026
649ab87
Revert removal of getDbo()
Hackwar Mar 20, 2026
9998ab5
Revert removal of getDbo() from interface
Hackwar Mar 20, 2026
c706ecf
codestyle
Hackwar Mar 20, 2026
f0086e1
Update TagsHelper.php
Hackwar Mar 21, 2026
f097052
phpstan baseline update
Hackwar Apr 3, 2026
1f79caf
phpstan baseline update
Hackwar Apr 3, 2026
8473938
Merge branch '7.0-dev' into 7.0-table-databaseawaretrait
Hackwar Apr 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion libraries/src/Helper/TagsHelper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@
*/
public function addTagMapping($ucmId, TableInterface $table, $tags = [])
{
$db = $table->getDbo();
$db = Factory::getDbo();

Check failure on line 101 in libraries/src/Helper/TagsHelper.php

View workflow job for this annotation

GitHub Actions / Run PHPstan 

Ignored error pattern #^Call to deprecated method getDbo\(\) of class Joomla\\CMS\\Factory\:
4\.3 will be removed in 7\.0
             Use the database service in the DI container
             Example\:
             Factory\:\:getContainer\(\)\-\>get\(DatabaseInterface\:\:class\);$# (staticMethod.deprecated) in path /__w/joomla-cms/joomla-cms/libraries/src/Helper/TagsHelper.php is expected to occur 13 times, but occurred 14 times.
Copy link
Copy Markdown
Member

@laoneo laoneo May 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Load at least the database from the container

Copy link
Copy Markdown
Member Author

@Hackwar Hackwar May 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The whole code actually needs to be refactored.

$key = $table->getKeyName();
$item = $table->$key;
$query = $db->createQuery()
Expand Down Expand Up @@ -1202,7 +1202,7 @@
if (\is_array($tagIds) && \count($tagIds) > 0) {
$tagIds = ArrayHelper::toInteger($tagIds);

$db = Factory::getDbo();

Check failure on line 1205 in libraries/src/Helper/TagsHelper.php

View workflow job for this annotation

GitHub Actions / Run PHPstan 

Call to deprecated method getDbo() of class Joomla\CMS\Factory:
4.3 will be removed in 7.0
             Use the database service in the DI container
             Example:
             Factory::getContainer()->get(DatabaseInterface::class);
$query = $db->createQuery()
->select([$db->quoteName('id'), $db->quoteName('title')])
->from($db->quoteName('#__tags'))
Expand Down
2 changes: 1 addition & 1 deletion libraries/src/Table/ContentType.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ public function getContentTable()
throw new \RuntimeException('Class must be an instance of Joomla\\CMS\\Table\\TableInterface');
}

$result = new $class($this->getDbo());
$result = new $class($this->getDatabase());
}
}

Expand Down
2 changes: 1 addition & 1 deletion libraries/src/Table/MenuType.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,7 +313,7 @@ protected function _getAssetTitle()
protected function _getAssetParentId(?Table $table = null, $id = null)
{
$assetId = null;
$asset = new Asset($this->getDbo());
$asset = new Asset($this->getDatabase());

if ($asset->loadByName('com_menus')) {
$assetId = $asset->id;
Expand Down
75 changes: 5 additions & 70 deletions libraries/src/Table/Table.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,7 @@
use Joomla\Database\DatabaseAwareInterface;
use Joomla\Database\DatabaseAwareTrait;
use Joomla\Database\DatabaseInterface;
use Joomla\Database\DatabaseQuery;
use Joomla\Database\Exception\DatabaseNotFoundException;
use Joomla\Database\QueryInterface;
use Joomla\Event\DispatcherAwareInterface;
use Joomla\Event\DispatcherAwareTrait;
use Joomla\Event\DispatcherInterface;
Expand Down Expand Up @@ -86,18 +85,6 @@ abstract class Table extends \stdClass implements TableInterface, DispatcherAwar
*/
protected $_tbl_keys = [];

/**
* DatabaseInterface object.
*
* @var DatabaseInterface
* @since 1.7.0
*
* @deprecated 5.4.0 will be removed in 7.0
* Use setDatabase() and getDatabase() instead
* Example: $this->setDatabase($db);
*/
protected $_db;
Copy link
Copy Markdown
Member

@laoneo laoneo May 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we not make a magic getter for another major?

Copy link
Copy Markdown
Member Author

@Hackwar Hackwar May 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We've kept this around for a very long time, so I don't think extending the deprecation period further would be of any help.

Copy link
Copy Markdown
Member

@laoneo laoneo May 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have something like https://github.com/joomla/joomla-cms/pull/45862/changes#r3274650060 in mind


/**
* Should rows be tracked as ACL assets?
*
Expand Down Expand Up @@ -456,8 +443,8 @@ protected function _getAssetParentId(?Table $table = null, $id = null)
/**
* Method to append the primary keys for this table to a query.
*
* @param DatabaseQuery $query A query object to append.
* @param mixed $pk Optional primary key parameter.
* @param QueryInterface $query A query object to append.
* @param mixed $pk Optional primary key parameter.
*
* @return void
*
Expand Down Expand Up @@ -542,65 +529,13 @@ public function getId()
*
* @since 1.7.0
*
* @deprecated 5.4.0 will be removed in 7.0
* @deprecated 5.4.0 will be removed in 8.0
* Use getDatabase() instead
* Example: $this->getDatabase();
*/
public function getDbo()
{
return $this->_db;
}

/**
* Method to set the DatabaseInterface object.
*
* @param DatabaseInterface $db A DatabaseInterface object to be used by the table object.
*
* @return boolean True on success.
*
* @since 1.7.0
*
* @deprecated 5.4.0 will be removed in 7.0
* Use setDatabase() instead
* Example: $this->setDatabase($db);
*/
public function setDbo(DatabaseInterface $db)
{
$this->_db = $db;

return true;
}

/**
* Get the database.
*
* @return DatabaseInterface
*
* @since 5.4.0
* @throws DatabaseNotFoundException May be thrown if the database has not been set.
*
* @note This method will be removed in 7.0 and DatabaseAwareTrait will be used instead.
*/
protected function getDatabase(): DatabaseInterface
{
return $this->getDbo();
}

/**
* Set the database.
*
* @param DatabaseInterface $db The database.
*
* @return void
*
* @since 5.4.0
*
* @note This method will be removed in 7.0 and DatabaseAwareTrait will be used instead.
*/
public function setDatabase(DatabaseInterface $db): void
{
$this->_db = $db;
$this->databaseAwareTraitDatabase = $db;
return $this->getDatabase();
}

/**
Expand Down
Loading