[5.3] Remove useless sprintf function call (joomla#45036)

joomdonation · web-flow · commit 1bc1e8fd05ac · 2025-02-28T15:53:58.000+01:00
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -97,6 +97,8 @@
             'combine_consecutive_issets'                       => true,
             // Calling unset on multiple items should be done in one call
             'combine_consecutive_unsets'                       => true,
+            // There must be no sprintf calls with only the first argument
+            'no_useless_sprintf'                               => true,
         ]
     )
     ->setFinder($finder);
diff --git a/administrator/components/com_actionlogs/src/Model/ActionlogModel.php b/administrator/components/com_actionlogs/src/Model/ActionlogModel.php
@@ -58,7 +58,7 @@ public function addLog($messages, $messageLanguageKey, $context, $userId = 0)
         try {
             $user = $userId ? $this->getUserFactory()->loadUserById($userId) : $this->getCurrentUser();
         } catch (\UnexpectedValueException $e) {
-            @trigger_error(\sprintf('UserFactory must be set, this will not be caught anymore in 7.0.'), E_USER_DEPRECATED);
+            @trigger_error('UserFactory must be set, this will not be caught anymore in 7.0.', E_USER_DEPRECATED);
             $user = Factory::getUser($userId);
         }
 
diff --git a/administrator/components/com_fields/src/Model/FieldModel.php b/administrator/components/com_fields/src/Model/FieldModel.php
@@ -330,7 +330,7 @@ private function checkDefaultValue($data)
             try {
                 $rule->setDatabase($this->getDatabase());
             } catch (DatabaseNotFoundException) {
-                @trigger_error(\sprintf('Database must be set, this will not be caught anymore in 5.0.'), E_USER_DEPRECATED);
+                @trigger_error('Database must be set, this will not be caught anymore in 5.0.', E_USER_DEPRECATED);
                 $rule->setDatabase(Factory::getContainer()->get(DatabaseInterface::class));
             }
         }
diff --git a/administrator/components/com_finder/src/Indexer/Indexer.php b/administrator/components/com_finder/src/Indexer/Indexer.php
@@ -122,7 +122,7 @@ class Indexer
     public function __construct(?DatabaseInterface $db = null)
     {
         if ($db === null) {
-            @trigger_error(\sprintf('Database will be mandatory in 5.0.'), E_USER_DEPRECATED);
+            @trigger_error('Database will be mandatory in 5.0.', E_USER_DEPRECATED);
             $db = Factory::getContainer()->get(DatabaseInterface::class);
         }
 
diff --git a/administrator/components/com_finder/src/Indexer/Query.php b/administrator/components/com_finder/src/Indexer/Query.php
@@ -208,7 +208,7 @@ class Query
     public function __construct($options, ?DatabaseInterface $db = null)
     {
         if ($db === null) {
-            @trigger_error(\sprintf('Database will be mandatory in 5.0.'), E_USER_DEPRECATED);
+            @trigger_error('Database will be mandatory in 5.0.', E_USER_DEPRECATED);
             $db = Factory::getContainer()->get(DatabaseInterface::class);
         }
 
diff --git a/libraries/src/Categories/Categories.php b/libraries/src/Categories/Categories.php
@@ -237,7 +237,7 @@ protected function _load($id)
         try {
             $db = $this->getDatabase();
         } catch (DatabaseNotFoundException) {
-            @trigger_error(\sprintf('Database must be set, this will not be caught anymore in 5.0.'), E_USER_DEPRECATED);
+            @trigger_error('Database must be set, this will not be caught anymore in 5.0.', E_USER_DEPRECATED);
             $db = Factory::getContainer()->get(DatabaseInterface::class);
         }
 
diff --git a/libraries/src/Form/Form.php b/libraries/src/Form/Form.php
@@ -1466,7 +1466,7 @@ protected function loadField($element, $group = null, $value = null)
             try {
                 $field->setDatabase($this->getDatabase());
             } catch (DatabaseNotFoundException) {
-                @trigger_error(\sprintf('Database must be set, this will not be caught anymore in 5.0.'), E_USER_DEPRECATED);
+                @trigger_error('Database must be set, this will not be caught anymore in 5.0.', E_USER_DEPRECATED);
                 $field->setDatabase(Factory::getContainer()->get(DatabaseInterface::class));
             }
         }
diff --git a/libraries/src/Form/FormField.php b/libraries/src/Form/FormField.php
@@ -1218,7 +1218,7 @@ public function validate($value, $group = null, ?Registry $input = null)
                 try {
                     $rule->setDatabase($this->getDatabase());
                 } catch (DatabaseNotFoundException) {
-                    @trigger_error(\sprintf('Database must be set, this will not be caught anymore in 5.0.'), E_USER_DEPRECATED);
+                    @trigger_error('Database must be set, this will not be caught anymore in 5.0.', E_USER_DEPRECATED);
                     $rule->setDatabase(Factory::getContainer()->get(DatabaseInterface::class));
                 }
             }
@@ -1243,7 +1243,7 @@ public function validate($value, $group = null, ?Registry $input = null)
                 try {
                     $rule->setDatabase($this->getDatabase());
                 } catch (DatabaseNotFoundException) {
-                    @trigger_error(\sprintf('Database must be set, this will not be caught anymore in 5.0.'), E_USER_DEPRECATED);
+                    @trigger_error('Database must be set, this will not be caught anymore in 5.0.', E_USER_DEPRECATED);
                     $rule->setDatabase(Factory::getContainer()->get(DatabaseInterface::class));
                 }
             }
diff --git a/libraries/src/MVC/Factory/MVCFactory.php b/libraries/src/MVC/Factory/MVCFactory.php
@@ -171,7 +171,7 @@ public function createModel($name, $prefix = '', array $config = [])
             try {
                 $model->setDatabase($this->getDatabase());
             } catch (DatabaseNotFoundException) {
-                @trigger_error(\sprintf('Database must be set, this will not be caught anymore in 5.0.'), E_USER_DEPRECATED);
+                @trigger_error('Database must be set, this will not be caught anymore in 5.0.', E_USER_DEPRECATED);
                 $model->setDatabase(Factory::getContainer()->get(DatabaseInterface::class));
             }
         }
@@ -267,7 +267,7 @@ public function createTable($name, $prefix = '', array $config = [])
         try {
             $db = \array_key_exists('dbo', $config) ? $config['dbo'] : $this->getDatabase();
         } catch (DatabaseNotFoundException) {
-            @trigger_error(\sprintf('Database must be set, this will not be caught anymore in 5.0.'), E_USER_DEPRECATED);
+            @trigger_error('Database must be set, this will not be caught anymore in 5.0.', E_USER_DEPRECATED);
             $db = Factory::getContainer()->get(DatabaseInterface::class);
         }
 
diff --git a/libraries/src/MVC/Model/BaseDatabaseModel.php b/libraries/src/MVC/Model/BaseDatabaseModel.php
@@ -105,7 +105,7 @@ public function __construct($config = [], ?MVCFactoryInterface $factory = null)
         $db = \array_key_exists('dbo', $config) ? $config['dbo'] : Factory::getDbo();
 
         if ($db) {
-            @trigger_error(\sprintf('Database is not available in constructor in 6.0.'), E_USER_DEPRECATED);
+            @trigger_error('Database is not available in constructor in 6.0.', E_USER_DEPRECATED);
             $this->setDatabase($db);
 
             // Is needed, when models use the deprecated MVC DatabaseAwareTrait, as the trait is overriding the local functions
diff --git a/libraries/src/Menu/SiteMenu.php b/libraries/src/Menu/SiteMenu.php
@@ -72,7 +72,7 @@ public function __construct($options = [])
         $this->language = isset($options['language']) && $options['language'] instanceof Language ? $options['language'] : Factory::getLanguage();
 
         if (!isset($options['db']) || !($options['db'] instanceof DatabaseDriver)) {
-            @trigger_error(\sprintf('Database will be mandatory in 5.0.'), E_USER_DEPRECATED);
+            @trigger_error('Database will be mandatory in 5.0.', E_USER_DEPRECATED);
             $options['db'] = Factory::getContainer()->get(DatabaseDriver::class);
         }
 
diff --git a/libraries/src/Table/ContentType.php b/libraries/src/Table/ContentType.php
@@ -57,13 +57,13 @@ public function check()
 
         // Check for valid name.
         if (trim($this->type_title) === '') {
-            throw new \UnexpectedValueException(\sprintf('The title is empty'));
+            throw new \UnexpectedValueException('The title is empty');
         }
 
         $this->type_title = ucfirst($this->type_title);
 
         if (empty($this->type_alias)) {
-            throw new \UnexpectedValueException(\sprintf('The type_alias is empty'));
+            throw new \UnexpectedValueException('The type_alias is empty');
         }
 
         return true;

Original file line number	Diff line number	Diff line change
`@@ -97,6 +97,8 @@`
`97`	`97`	`'combine_consecutive_issets' => true,`
`98`	`98`	`// Calling unset on multiple items should be done in one call`
`99`	`99`	`'combine_consecutive_unsets' => true,`
	`100`	`+ // There must be no sprintf calls with only the first argument`
	`101`	`+ 'no_useless_sprintf' => true,`
`100`	`102`	`]`
`101`	`103`	`)`
`102`	`104`	`->setFinder($finder);`
Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@ public function addLog($messages, $messageLanguageKey, $context, $userId = 0)`
`58`	`58`	`try {`
`59`	`59`	`$user = $userId ? $this->getUserFactory()->loadUserById($userId) : $this->getCurrentUser();`
`60`	`60`	`} catch (\UnexpectedValueException $e) {`
`61`		`- @trigger_error(\sprintf('UserFactory must be set, this will not be caught anymore in 7.0.'), E_USER_DEPRECATED);`
	`61`	`+ @trigger_error('UserFactory must be set, this will not be caught anymore in 7.0.', E_USER_DEPRECATED);`
`62`	`62`	`$user = Factory::getUser($userId);`
`63`	`63`	`}`
`64`	`64`
Original file line number	Diff line number	Diff line change
`@@ -330,7 +330,7 @@ private function checkDefaultValue($data)`
`330`	`330`	`try {`
`331`	`331`	`$rule->setDatabase($this->getDatabase());`
`332`	`332`	`} catch (DatabaseNotFoundException) {`
`333`		`- @trigger_error(\sprintf('Database must be set, this will not be caught anymore in 5.0.'), E_USER_DEPRECATED);`
	`333`	`+ @trigger_error('Database must be set, this will not be caught anymore in 5.0.', E_USER_DEPRECATED);`
`334`	`334`	`$rule->setDatabase(Factory::getContainer()->get(DatabaseInterface::class));`
`335`	`335`	`}`
`336`	`336`	`}`
Original file line number	Diff line number	Diff line change
`@@ -122,7 +122,7 @@ class Indexer`
`122`	`122`	`public function __construct(?DatabaseInterface $db = null)`
`123`	`123`	`{`
`124`	`124`	`if ($db === null) {`
`125`		`- @trigger_error(\sprintf('Database will be mandatory in 5.0.'), E_USER_DEPRECATED);`
	`125`	`+ @trigger_error('Database will be mandatory in 5.0.', E_USER_DEPRECATED);`
`126`	`126`	`$db = Factory::getContainer()->get(DatabaseInterface::class);`
`127`	`127`	`}`
`128`	`128`
Original file line number	Diff line number	Diff line change
`@@ -208,7 +208,7 @@ class Query`
`208`	`208`	`public function __construct($options, ?DatabaseInterface $db = null)`
`209`	`209`	`{`
`210`	`210`	`if ($db === null) {`
`211`		`- @trigger_error(\sprintf('Database will be mandatory in 5.0.'), E_USER_DEPRECATED);`
	`211`	`+ @trigger_error('Database will be mandatory in 5.0.', E_USER_DEPRECATED);`
`212`	`212`	`$db = Factory::getContainer()->get(DatabaseInterface::class);`
`213`	`213`	`}`
`214`	`214`
Original file line number	Diff line number	Diff line change
`@@ -237,7 +237,7 @@ protected function _load($id)`
`237`	`237`	`try {`
`238`	`238`	`$db = $this->getDatabase();`
`239`	`239`	`} catch (DatabaseNotFoundException) {`
`240`		`- @trigger_error(\sprintf('Database must be set, this will not be caught anymore in 5.0.'), E_USER_DEPRECATED);`
	`240`	`+ @trigger_error('Database must be set, this will not be caught anymore in 5.0.', E_USER_DEPRECATED);`
`241`	`241`	`$db = Factory::getContainer()->get(DatabaseInterface::class);`
`242`	`242`	`}`
`243`	`243`
Original file line number	Diff line number	Diff line change
`@@ -1466,7 +1466,7 @@ protected function loadField($element, $group = null, $value = null)`
`1466`	`1466`	`try {`
`1467`	`1467`	`$field->setDatabase($this->getDatabase());`
`1468`	`1468`	`} catch (DatabaseNotFoundException) {`
`1469`		`- @trigger_error(\sprintf('Database must be set, this will not be caught anymore in 5.0.'), E_USER_DEPRECATED);`
	`1469`	`+ @trigger_error('Database must be set, this will not be caught anymore in 5.0.', E_USER_DEPRECATED);`
`1470`	`1470`	`$field->setDatabase(Factory::getContainer()->get(DatabaseInterface::class));`
`1471`	`1471`	`}`
`1472`	`1472`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1218,7 +1218,7 @@ public function validate($value, $group = null, ?Registry $input = null)`
`1218`	`1218`	`try {`
`1219`	`1219`	`$rule->setDatabase($this->getDatabase());`
`1220`	`1220`	`} catch (DatabaseNotFoundException) {`
`1221`		`- @trigger_error(\sprintf('Database must be set, this will not be caught anymore in 5.0.'), E_USER_DEPRECATED);`
	`1221`	`+ @trigger_error('Database must be set, this will not be caught anymore in 5.0.', E_USER_DEPRECATED);`
`1222`	`1222`	`$rule->setDatabase(Factory::getContainer()->get(DatabaseInterface::class));`
`1223`	`1223`	`}`
`1224`	`1224`	`}`
`@@ -1243,7 +1243,7 @@ public function validate($value, $group = null, ?Registry $input = null)`
`1243`	`1243`	`try {`
`1244`	`1244`	`$rule->setDatabase($this->getDatabase());`
`1245`	`1245`	`} catch (DatabaseNotFoundException) {`
`1246`		`- @trigger_error(\sprintf('Database must be set, this will not be caught anymore in 5.0.'), E_USER_DEPRECATED);`
	`1246`	`+ @trigger_error('Database must be set, this will not be caught anymore in 5.0.', E_USER_DEPRECATED);`
`1247`	`1247`	`$rule->setDatabase(Factory::getContainer()->get(DatabaseInterface::class));`
`1248`	`1248`	`}`
`1249`	`1249`	`}`
Original file line number	Diff line number	Diff line change
`@@ -171,7 +171,7 @@ public function createModel($name, $prefix = '', array $config = [])`
`171`	`171`	`try {`
`172`	`172`	`$model->setDatabase($this->getDatabase());`
`173`	`173`	`} catch (DatabaseNotFoundException) {`
`174`		`- @trigger_error(\sprintf('Database must be set, this will not be caught anymore in 5.0.'), E_USER_DEPRECATED);`
	`174`	`+ @trigger_error('Database must be set, this will not be caught anymore in 5.0.', E_USER_DEPRECATED);`
`175`	`175`	`$model->setDatabase(Factory::getContainer()->get(DatabaseInterface::class));`
`176`	`176`	`}`
`177`	`177`	`}`
`@@ -267,7 +267,7 @@ public function createTable($name, $prefix = '', array $config = [])`
`267`	`267`	`try {`
`268`	`268`	`$db = \array_key_exists('dbo', $config) ? $config['dbo'] : $this->getDatabase();`
`269`	`269`	`} catch (DatabaseNotFoundException) {`
`270`		`- @trigger_error(\sprintf('Database must be set, this will not be caught anymore in 5.0.'), E_USER_DEPRECATED);`
	`270`	`+ @trigger_error('Database must be set, this will not be caught anymore in 5.0.', E_USER_DEPRECATED);`
`271`	`271`	`$db = Factory::getContainer()->get(DatabaseInterface::class);`
`272`	`272`	`}`
`273`	`273`