magento-engcom/magento2ce#2639: Minor coding practices improvements

Author: ishakhsuvarov

app/code/Magento/Backup/Model/Db.php

@@ -7,7 +7,7 @@
 
 use Magento\Backup\Helper\Data as Helper;
 use Magento\Backup\Model\ResourceModel\Table\GetListTables;
-use Magento\Backup\Model\ResourceModel\View\GetViewsBackup;
+use Magento\Backup\Model\ResourceModel\View\CreateViewsBackup;
 use Magento\Framework\App\ObjectManager;
 use Magento\Framework\Exception\RuntimeException;
 
@@ -51,29 +51,30 @@ class Db implements \Magento\Framework\Backup\Db\BackupDbInterface
     private $getListTables;
 
     /**
-     * @var GetViewsBackup
+     * @var CreateViewsBackup
      */
     private $getViewsBackup;
 
     /**
-     * @param \Magento\Backup\Model\ResourceModel\Db $resourceDb
+     * Db constructor.
+     * @param ResourceModel\Db $resourceDb
      * @param \Magento\Framework\App\ResourceConnection $resource
-     * @param GetListTables|null $getListTables
-     * @param GetViewsBackup|null $getViewsBackup
      * @param Helper|null $helper
+     * @param GetListTables|null $getListTables
+     * @param CreateViewsBackup|null $getViewsBackup
      */
     public function __construct(
-        \Magento\Backup\Model\ResourceModel\Db $resourceDb,
+        ResourceModel\Db $resourceDb,
         \Magento\Framework\App\ResourceConnection $resource,
         ?Helper $helper = null,
-        GetListTables $getListTables = null,
-        GetViewsBackup $getViewsBackup = null
+        ?GetListTables $getListTables = null,
+        ?CreateViewsBackup $getViewsBackup = null
     ) {
         $this->_resourceDb = $resourceDb;
         $this->_resource = $resource;
         $this->helper = $helper ?? ObjectManager::getInstance()->get(Helper::class);
-        $this->getListTables = $getListTables ?: ObjectManager::getInstance()->get(GetListTables::class);
-        $this->getViewsBackup = $getViewsBackup ?: ObjectManager::getInstance()->get(GetViewsBackup::class);
+        $this->getListTables = $getListTables ?? ObjectManager::getInstance()->get(GetListTables::class);
+        $this->getViewsBackup = $getViewsBackup ?? ObjectManager::getInstance()->get(CreateViewsBackup::class);
     }
 
     /**

app/code/Magento/Backup/Model/ResourceModel/Table/GetListTables.php

@@ -10,7 +10,7 @@
 use Magento\Framework\App\ResourceConnection;
 
 /**
- * Class GetListTables
+ * Provides full list of tables in the database. This list excludes views, to allow different backup process.
  */
 class GetListTables
 {
@@ -30,12 +30,14 @@ public function __construct(ResourceConnection $resource)
     }
 
     /**
+     * Get list of database tables excluding views.
+     *
      * @return array
      */
-    public function execute()
+    public function execute(): array
     {
         return $this->resource->getConnection('backup')->fetchCol(
-"SHOW FULL TABLES WHERE `Table_type` = ?",
+            "SHOW FULL TABLES WHERE `Table_type` = ?",
             self::TABLE_TYPE
         );
     }

app/code/Magento/Backup/Model/ResourceModel/View/GetViewsBackup.php renamed to app/code/Magento/Backup/Model/ResourceModel/View/CreateViewsBackup.php

@@ -12,9 +12,9 @@
 use Magento\Framework\DB\Adapter\AdapterInterface;
 
 /**
- * Class GetViewsBackup
+ * Creates backup of Views in the database.
  */
-class GetViewsBackup
+class CreateViewsBackup
 {
     /**
      * @var GetListViews
@@ -44,23 +44,27 @@ public function __construct(
     }
 
     /**
+     * Write backup data to backup file.
+     *
      * @param BackupInterface $backup
      */
-    public function execute(BackupInterface $backup)
+    public function execute(BackupInterface $backup): void
     {
         $views = $this->getListViews->execute();
 
         foreach ($views as $view) {
             $backup->write($this->getViewHeader($view));
             $backup->write($this->getDropViewSql($view));
-            $backup->write($this->getShowCreateView($view));
+            $backup->write($this->getCreateView($view));
         }
     }
 
     /**
+     * Retrieve Database connection for Backup.
+     *
      * @return AdapterInterface
      */
-    private function getConnection()
+    private function getConnection(): AdapterInterface
     {
         if (!$this->connection) {
             $this->connection = $this->resourceConnection->getConnection('backup');
@@ -70,10 +74,12 @@ private function getConnection()
     }
 
     /**
+     * Get CREATE VIEW query for the specific view.
+     *
      * @param string $viewName
      * @return string
      */
-    private function getShowCreateView($viewName)
+    private function getCreateView(string $viewName): string
     {
         $quotedViewName = $this->getConnection()->quoteIdentifier($viewName);
         $query = 'SHOW CREATE VIEW ' . $quotedViewName;
@@ -85,22 +91,26 @@ private function getShowCreateView($viewName)
     }
 
     /**
+     * Prepare a header for View being dumped.
+     *
      * @param string $viewName
      * @return string
      */
-    public function getViewHeader($viewName)
+    public function getViewHeader(string $viewName): string
     {
         $quotedViewName = $this->getConnection()->quoteIdentifier($viewName);
         return "\n--\n" . "-- Structure for view {$quotedViewName}\n" . "--\n\n";
     }
 
     /**
+     * Make sure that View being created is deleted if already exists.
+     *
      * @param string $viewName
      * @return string
      */
-    public function getDropViewSql($viewName)
+    public function getDropViewSql(string $viewName): string
     {
         $quotedViewName = $this->getConnection()->quoteIdentifier($viewName);
-        return sprintf('DROP VIEW IF EXISTS %s;' . "\n", $quotedViewName);
+        return sprintf('DROP VIEW IF EXISTS %s;\n', $quotedViewName);
     }
 }

app/code/Magento/Backup/Model/ResourceModel/View/GetListViews.php

@@ -10,11 +10,12 @@
 use Magento\Framework\App\ResourceConnection;
 
 /**
- * Class GetListViews
+ * Get list of database views.
  */
 class GetListViews
 {
     private const TABLE_TYPE = 'VIEW';
+
     /**
      * @var ResourceConnection
      */
@@ -29,9 +30,11 @@ public function __construct(ResourceConnection $resource)
     }
 
     /**
+     * Get list of database views.
+     *
      * @return array
      */
-    public function execute()
+    public function execute(): array
     {
         return $this->resource->getConnection('backup')->fetchCol(
             "SHOW FULL TABLES WHERE `Table_type` = ?",