Merge pull request #17 from lizardmedia/major-refactor

Major refactor

Api/ProgressHandler/ProgressDataInterface.php

@@ -14,9 +14,20 @@
  */
 interface ProgressDataInterface
 {
-    const FIELD_CURRENT = 'current';
-    const FIELD_TOTAL = 'total';
-    const FIELD_PROCESS_TYPE = 'process_type';
+    /**
+     * @var string
+     */
+    public const FIELD_CURRENT = 'current';
+
+    /**
+     * @var string
+     */
+    public const FIELD_TOTAL = 'total';
+
+    /**
+     * @var string
+     */
+    public const FIELD_PROCESS_TYPE = 'process_type';
 
     /**
      * @return int|null

Api/VarnishPurgerInterface.php → Api/VarnishActionManagerInterface.php

@@ -2,7 +2,7 @@
 declare(strict_types=1);
 
 /**
- * File:VarnishPurgerInterface.php
+ * File:VarnishActionManagerInterface.php
  *
  * @author Maciej Sławik <[email protected]>
  * @copyright Copyright (C) 2019 Lizard Media (http://lizardmedia.pl)
@@ -13,10 +13,10 @@
 use Magento\Catalog\Api\Data\ProductInterface;
 
 /**
- * Interface VarnishPurgerInterface
+ * Interface VarnishActionManagerInterface
  * @package LizardMedia\VarnishWarmer\Api
  */
-interface VarnishPurgerInterface
+interface VarnishActionManagerInterface
 {
     /**
      * Purge *

Block/Adminhtml/PurgeMultiple/Form.php

@@ -1,4 +1,7 @@
 <?php
+
+declare(strict_types=1);
+
 /**
  * File: Form.php
  *
@@ -14,13 +17,15 @@
 /**
  * Class Form
  * @package LizardMedia\VarnishWarmer\Block\PurgeMultiple\Form
+ * @codeCoverageIgnore
  */
 class Form extends Container
 {
     /**
-     * @return null
+     * @return void
+     * @SuppressWarnings(PHPMD.CamelCaseMethodName)
      */
-    protected function _construct()
+    protected function _construct(): void
     {
         $this->_blockGroup = 'LizardMedia_VarnishWarmer';
         $this->_controller = 'adminhtml_purgeMultiple_form';
@@ -34,15 +39,15 @@ protected function _construct()
     /**
      * @return Phrase
      */
-    public function getHeaderText()
+    public function getHeaderText(): Phrase
     {
         return __('Varnish: purge a group of URLs');
     }
 
     /**
-     * @return null
+     * @return void
      */
-    private function updateSaveButton()
+    private function updateSaveButton(): void
     {
         $this->buttonList->update(
             'save',
@@ -52,9 +57,9 @@ private function updateSaveButton()
     }
 
     /**
-     * @return null
+     * @return void
      */
-    private function removeButtons()
+    private function removeButtons(): void
     {
         $this->buttonList->remove('delete');
         $this->buttonList->remove('back');

Block/Adminhtml/PurgeMultiple/Form/Edit/Form.php

@@ -1,4 +1,7 @@
 <?php
+
+declare(strict_types=1);
+
 /**
  * File: Form.php
  *
@@ -20,18 +23,20 @@
 /**
  * Class Form
  * @package LizardMedia\VarnishWarmer\Block\Adminhtml\Form\PurgeMultiple
+ * @SuppressWarnings(PHPMD.LongVariable)
+ * @codeCoverageIgnore
  */
 class Form extends Generic
 {
     /**
      * @var string
      */
-    const PROCESS_URL_FORM_PARAM = 'process_url';
+    public const PROCESS_URL_FORM_PARAM = 'process_url';
 
     /**
      * @var string
      */
-    const STORE_VIEW_FORM_PARAM = 'store_id';
+    public const STORE_VIEW_FORM_PARAM = 'store_id';
 
     /**
      * @var Store
@@ -67,26 +72,28 @@ public function __construct(
 
     /**
      * @return void
+     * @SuppressWarnings(PHPMD.CamelCaseMethodName)
      */
-    protected function _construct()
+    protected function _construct(): void
     {
         parent::_construct();
         $this->setId('purgemultiple_form');
         $this->setTitle(__('Varnish: purge a group of URLs'));
     }
 
     /**
-     * @return WidgetForm
+     * @return Form
      * @throws LocalizedException
+     * @SuppressWarnings(PHPMD.CamelCaseMethodName)
      */
-    protected function _prepareForm()
+    protected function _prepareForm(): self
     {
         /** @var \Magento\Framework\Data\Form $form */
         $form = $this->_formFactory->create(
             [
                 'data' => [
                     'id' => 'edit_form',
-                    'action' => $this->getFormTargerUrl(),
+                    'action' => $this->getFormTargetUrl(),
                     'method' => 'post'
                 ]
             ]
@@ -135,7 +142,7 @@ protected function _prepareForm()
     /**
      * @return string
      */
-    private function getFormTargerUrl()
+    private function getFormTargetUrl(): string
     {
         return $this->_urlBuilder->getUrl('lizardmediavarnish/purgemultiple/run');
     }

Block/Adminhtml/PurgeSingle/Form.php

@@ -1,4 +1,7 @@
 <?php
+
+declare(strict_types=1);
+
 /**
  * File: Form.php
  *
@@ -14,13 +17,15 @@
 /**
  * Class Form
  * @package LizardMedia\VarnishWarmer\Block\Adminhtml\Form
+ * @codeCoverageIgnore
  */
 class Form extends Container
 {
     /**
-     * @return null
+     * @return void
+     * @SuppressWarnings(PHPMD.CamelCaseMethodName)
      */
-    protected function _construct()
+    protected function _construct(): void
     {
         $this->_blockGroup = 'LizardMedia_VarnishWarmer';
         $this->_controller = 'adminhtml_purgeSingle_form';
@@ -34,15 +39,15 @@ protected function _construct()
     /**
      * @return Phrase
      */
-    public function getHeaderText()
+    public function getHeaderText(): Phrase
     {
         return __('Varnish: purge single URL');
     }
 
     /**
-     * @return null
+     * @return void
      */
-    private function updateSaveButton()
+    private function updateSaveButton(): void
     {
         $this->buttonList->update(
             'save',
@@ -52,9 +57,9 @@ private function updateSaveButton()
     }
 
     /**
-     * @return null
+     * @return void
      */
-    private function removeButtons()
+    private function removeButtons(): void
     {
         $this->buttonList->remove('delete');
         $this->buttonList->remove('back');

Block/Adminhtml/PurgeSingle/Form/Edit/Form.php

@@ -1,4 +1,7 @@
 <?php
+
+declare(strict_types=1);
+
 /**
  * File: Form.php
  *
@@ -9,7 +12,6 @@
 namespace LizardMedia\VarnishWarmer\Block\Adminhtml\PurgeSingle\Form\Edit;
 
 use Magento\Backend\Block\Template\Context;
-use Magento\Backend\Block\Widget\Form as WidgetForm;
 use Magento\Backend\Block\Widget\Form\Generic;
 use Magento\Framework\Data\FormFactory;
 use Magento\Framework\Exception\LocalizedException;
@@ -19,23 +21,24 @@
 /**
  * Class Form
  * @package LizardMedia\VarnishWarmer\Block\Adminhtml\PurgeSingle\Form\Edit
+ * @codeCoverageIgnore
  */
 class Form extends Generic
 {
     /**
      * @var string
      */
-    const URL_FORM_PARAM = 'url';
+    public const URL_FORM_PARAM = 'url';
 
     /**
      * @var string
      */
-    const STORE_VIEW_FORM_PARAM = 'store_id';
+    public const STORE_VIEW_FORM_PARAM = 'store_id';
 
     /**
      * @var string
      */
-    const FORCE_PURGE_FORM_PARAM = 'force_purge';
+    public const FORCE_PURGE_FORM_PARAM = 'force_purge';
 
     /**
      * @var Store
@@ -63,26 +66,28 @@ public function __construct(
 
     /**
      * @return void
+     * @SuppressWarnings(PHPMD.CamelCaseMethodName)
      */
-    protected function _construct()
+    protected function _construct(): void
     {
         parent::_construct();
         $this->setId('purgesingle_form');
         $this->setTitle(__('Varnish: purge single URL'));
     }
 
     /**
-     * @return WidgetForm
+     * @return Form
      * @throws LocalizedException
+     * @SuppressWarnings(PHPMD.CamelCaseMethodName)
      */
-    protected function _prepareForm()
+    protected function _prepareForm(): self
     {
         /** @var \Magento\Framework\Data\Form $form */
         $form = $this->_formFactory->create(
             [
                 'data' => [
                     'id' => 'edit_form',
-                    'action' => $this->getFormTargerUrl(),
+                    'action' => $this->getFormTargetUrl(),
                     'method' => 'post'
                 ]
             ]
@@ -142,7 +147,7 @@ protected function _prepareForm()
     /**
      * @return string
      */
-    private function getFormTargerUrl()
+    private function getFormTargetUrl(): string
     {
         return $this->_urlBuilder->getUrl('lizardmediavarnish/purgesingle/run');
     }

CHANGELOG.md

@@ -1,4 +1,10 @@
 ### 2.1. ###
 * fix for incorrect method for purging process
 * adding logging for error request
-* minor refactor
+* minor refactor
+
+### 2.2 ###
+* major refactor
+* adding missing return types/types hints
+* support PHP 7.3
+* fix for case when urls uses store codes inside after domain

Console/Command/AbstractPurgeCommand.php

@@ -11,9 +11,9 @@
 
 namespace LizardMedia\VarnishWarmer\Console\Command;
 
-use LizardMedia\VarnishWarmer\Api\VarnishPurgerInterface;
+use LizardMedia\VarnishWarmer\Api\VarnishActionManagerInterface;
 use Symfony\Component\Console\Command\Command;
-use Magento\Framework\App\State;
+use Symfony\Component\Console\Input\InputInterface;
 
 /**
  * Class AbstractPurgeCommand
@@ -27,20 +27,33 @@ class AbstractPurgeCommand extends Command
     protected const STORE_VIEW_ID = 'store';
 
     /**
-     * @var VarnishPurgerInterface
+     * @var VarnishActionManagerInterface
      */
-    protected $varnishPurger;
+    protected $varnishActionManager;
 
     /**
      * AbstractPurgeCommand constructor.
-     * @param VarnishPurgerInterface $varnishPurger
+     * @param VarnishActionManagerInterface $varnishActionManager
      * @param null $name
      */
     public function __construct(
-        VarnishPurgerInterface $varnishPurger,
+        VarnishActionManagerInterface $varnishActionManager,
         $name = null
     ) {
         parent::__construct($name);
-        $this->varnishPurger = $varnishPurger;
+        $this->varnishActionManager = $varnishActionManager;
+    }
+
+    /**
+     * @param InputInterface $input
+     * @return void
+     */
+    protected function passStoreViewIfSet(InputInterface $input): void
+    {
+        $storeViewId = $input->getOption(self::STORE_VIEW_ID);
+
+        if (!empty($storeViewId)) {
+            $this->varnishActionManager->setStoreViewId((int) $storeViewId);
+        }
     }
 }