Improve UpgradeConfiguration naming

PrestaShop · Oct 24, 2024 · bf36808 · bf36808
1 parent 8fd5972
commit bf36808
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 15 deletions.
diff --git a/classes/Parameters/UpgradeConfiguration.php b/classes/Parameters/UpgradeConfiguration.php
@@ -62,7 +62,7 @@ class UpgradeConfiguration extends ArrayCollection
     ];
 
     const DEFAULT_CHANNEL = Upgrader::CHANNEL_ONLINE;
-    const DEFAULT_FILENAME = 'prestashop.zip';
+    const ONLINE_CHANNEL_ZIP = 'prestashop.zip';
 
     /**
      * Performance settings, if your server has a low memory size, lower these values.
@@ -82,20 +82,29 @@ class UpgradeConfiguration extends ArrayCollection
     /**
      * Get the name of the new release archive.
      */
-    public function getArchiveZip(): ?string
+    public function getLocalChannelZip(): ?string
     {
         return $this->get('archive_zip');
     }
 
-    public function getArchiveXml(): ?string
+    public function getChannelZip(): ?string
+    {
+        if ($this->getChannel() === Upgrader::CHANNEL_LOCAL) {
+            $this->getLocalChannelZip();
+        }
+
+        return self::ONLINE_CHANNEL_ZIP;
+    }
+
+    public function getLocalChannelXml(): ?string
     {
         return $this->get('archive_xml');
     }
 
     /**
      * Get the version included in the new release.
      */
-    public function getArchiveVersion(): ?string
+    public function getLocalChannelVersion(): ?string
     {
         return $this->get('archive_version_num');
     }

diff --git a/classes/Twig/Block/UpgradeButtonBlock.php b/classes/Twig/Block/UpgradeButtonBlock.php
@@ -141,9 +141,9 @@ public function getTemplateVars(): array
             ],
             'archiveFiles' => $dir,
             'xmlFiles' => $xml,
-            'archiveFileName' => $this->config->getArchiveZip(),
-            'xmlFileName' => $this->config->getArchiveXml(),
-            'archiveVersionNumber' => $this->config->getArchiveVersion(),
+            'archiveFileName' => $this->config->getLocalChannelZip(),
+            'xmlFileName' => $this->config->getLocalChannelXml(),
+            'archiveVersionNumber' => $this->config->getLocalChannelVersion(),
             'downloadPath' => $this->downloadPath . DIRECTORY_SEPARATOR,
             'directoryVersionNumber' => $this->config->get('directory.version_num'),
             'phpVersion' => PHP_VERSION,

diff --git a/classes/UpgradeContainer.php b/classes/UpgradeContainer.php
@@ -265,7 +265,7 @@ public function getProperty(string $property): ?string
             case self::LOGS_PATH:
                 return $this->autoupgradeWorkDir . DIRECTORY_SEPARATOR . 'logs';
             case self::ARCHIVE_FILENAME:
-                return $this->getUpgradeConfiguration()->getArchiveZip() ? $this->getUpgradeConfiguration()->getArchiveZip() : UpgradeConfiguration::DEFAULT_FILENAME;
+                return $this->getUpgradeConfiguration()->getChannelZip();
             case self::ARCHIVE_FILEPATH:
                 return $this->getProperty(self::DOWNLOAD_PATH) . DIRECTORY_SEPARATOR . $this->getProperty(self::ARCHIVE_FILENAME);
             case self::PS_VERSION:
@@ -439,7 +439,7 @@ public function getUpgrader(): Upgrader
         $this->getState()->setOriginVersion($this->getProperty(self::PS_VERSION));
 
         if ($upgrader->getChannel() === Upgrader::CHANNEL_LOCAL) {
-            $archiveXml = $this->getUpgradeConfiguration()->getArchiveXml();
+            $archiveXml = $this->getUpgradeConfiguration()->getLocalChannelXml();
             $this->fileLoader->addXmlMd5File($upgrader->getDestinationVersion(), $this->getProperty(self::DOWNLOAD_PATH) . DIRECTORY_SEPARATOR . $archiveXml);
         }
 

diff --git a/classes/Upgrader.php b/classes/Upgrader.php
@@ -77,7 +77,7 @@ public function __construct(
      *
      * @TODO ftp if copy is not possible (safe_mode for example)
      */
-    public function downloadLast(string $dest, string $filename = UpgradeConfiguration::DEFAULT_FILENAME): bool
+    public function downloadLast(string $dest, string $filename): bool
     {
         if ($this->onlineDestinationRelease === null) {
             $this->getOnlineDestinationRelease();
@@ -146,7 +146,7 @@ public function getOnlineDestinationRelease(): ?PrestashopRelease
     public function getDestinationVersion(): ?string
     {
         if ($this->channel === self::CHANNEL_LOCAL) {
-            return $this->upgradeConfiguration->getArchiveVersion();
+            return $this->upgradeConfiguration->getLocalChannelVersion();
         } else {
             return $this->getOnlineDestinationRelease() ? $this->getOnlineDestinationRelease()->getVersion() : null;
         }

diff --git a/controllers/admin/self-managed/UpdatePageVersionChoiceController.php b/controllers/admin/self-managed/UpdatePageVersionChoiceController.php
@@ -137,17 +137,17 @@ protected function getParams(): array
                 'form_options' => self::FORM_OPTIONS,
                 'current_values' => [
                     self::FORM_FIELDS['channel'] => $currentChannel,
-                    self::FORM_FIELDS['archive_zip'] => $upgradeConfiguration->getArchiveZip(),
-                    self::FORM_FIELDS['archive_xml'] => $upgradeConfiguration->getArchiveXml(),
+                    self::FORM_FIELDS['archive_zip'] => $upgradeConfiguration->getLocalChannelZip(),
+                    self::FORM_FIELDS['archive_xml'] => $upgradeConfiguration->getLocalChannelXml(),
                 ],
             ]
         );
 
         if ($currentChannel === self::FORM_OPTIONS['online_value'] ||
             (
                 $currentChannel === self::FORM_OPTIONS['local_value']
-                && in_array($upgradeConfiguration->getArchiveZip(), $archiveRepository->getZipLocalArchive())
-                && in_array($upgradeConfiguration->getArchiveXml(), $archiveRepository->getXmlLocalArchive())
+                && in_array($upgradeConfiguration->getLocalChannelZip(), $archiveRepository->getZipLocalArchive())
+                && in_array($upgradeConfiguration->getLocalChannelXml(), $archiveRepository->getXmlLocalArchive())
             )
         ) {
             $params[$currentChannel . '_requirements'] = $this->getRequirements();