refactor: mark more classes as readonly

thorsten · Mar 17, 2024 · 4d7024d · 4d7024d
1 parent e46decd
commit 4d7024d
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 17 deletions.
diff --git a/phpmyfaq/src/phpMyFAQ/Administration/AdminLog.php b/phpmyfaq/src/phpMyFAQ/Administration/AdminLog.php
@@ -27,12 +27,12 @@
  *
  * @package phpMyFAQ
  */
-class AdminLog
+readonly class AdminLog
 {
     /**
      * Constructor.
      */
-    public function __construct(private readonly Configuration $configuration)
+    public function __construct(private Configuration $configuration)
     {
     }
 

diff --git a/phpmyfaq/src/phpMyFAQ/Administration/Backup.php b/phpmyfaq/src/phpMyFAQ/Administration/Backup.php
@@ -27,15 +27,13 @@
  *
  * @package phpMyFAQ
  */
-class Backup
+readonly class Backup
 {
     /**
      * Constructor.
      */
-    public function __construct(
-        private readonly Configuration $configuration,
-        private readonly DatabaseHelper $databaseHelper
-    ) {
+    public function __construct(private Configuration $configuration, private DatabaseHelper $databaseHelper)
+    {
     }
 
     /**

diff --git a/phpmyfaq/src/phpMyFAQ/Administration/Changelog.php b/phpmyfaq/src/phpMyFAQ/Administration/Changelog.php
@@ -25,12 +25,12 @@
  *
  * @package phpMyFAQ
  */
-class Changelog
+readonly class Changelog
 {
     /**
      * Changelog constructor.
      */
-    public function __construct(private readonly Configuration $configuration)
+    public function __construct(private Configuration $configuration)
     {
     }
 

diff --git a/phpmyfaq/src/phpMyFAQ/Administration/Revision.php b/phpmyfaq/src/phpMyFAQ/Administration/Revision.php
@@ -19,18 +19,19 @@
 
 use phpMyFAQ\Configuration;
 use phpMyFAQ\Database;
+use phpMyFAQ\Strings;
 
 /**
  * Class Revision
  *
  * @package phpMyFAQ
  */
-class Revision
+readonly class Revision
 {
     /**
      * Revision constructor.
      */
-    public function __construct(private readonly Configuration $configuration)
+    public function __construct(private Configuration $configuration)
     {
     }
 
@@ -55,7 +56,7 @@ public function create(int $faqId, string $faqLanguage): bool
             Database::getTablePrefix(),
             Database::getTablePrefix(),
             $faqId,
-            $faqLanguage
+            $this->configuration->getDb()->escape($faqLanguage)
         );
 
         $this->configuration->getDb()->query($query);
@@ -84,7 +85,7 @@ public function get(int $faqId, string $faqLanguage, string $faqAuthor): array
                 revision_id",
             Database::getTablePrefix(),
             $faqId,
-            $faqLanguage
+            $this->configuration->getDb()->escape($faqLanguage)
         );
 
         $result = $this->configuration->getDb()->query($query);
@@ -104,17 +105,20 @@ public function get(int $faqId, string $faqLanguage, string $faqAuthor): array
 
     /**
      * Deletes all revisions for a given FAQ ID and FAQ language
-     * @return mixed
+     *
+     * @param int    $faqId
+     * @param string $faqLanguage
+     * @return bool
      */
-    public function delete(int $faqId, string $faqLanguage)
+    public function delete(int $faqId, string $faqLanguage): bool
     {
         $query = sprintf(
             "DELETE FROM %sfaqdata_revisions WHERE id = %d AND lang = '%s'",
             Database::getTablePrefix(),
             $faqId,
-            $faqLanguage
+            $this->configuration->getDb()->escape($faqLanguage)
         );
 
-        return $this->configuration->getDb()->query($query);
+        return (bool) $this->configuration->getDb()->query($query);
     }
 }