Removing the BaseAdminTemplate block (algolia#822)

ctidigital · Oct 16, 2019 · 8b0e3ef · 8b0e3ef
1 parent a431475
commit 8b0e3ef
Show file tree

Hide file tree

Showing 26 changed files with 66 additions and 140 deletions.
diff --git a/Block/Adminhtml/BaseAdminTemplate.php b/Block/Adminhtml/BaseAdminTemplate.php
diff --git a/Controller/Adminhtml/Analytics/Update.php b/Controller/Adminhtml/Analytics/Update.php
@@ -2,8 +2,8 @@
 
 namespace Algolia\AlgoliaSearch\Controller\Adminhtml\Analytics;
 
-use Algolia\AlgoliaSearch\Block\Adminhtml\BaseAdminTemplate;
 use Algolia\AlgoliaSearch\ViewModel\Adminhtml\Analytics\Overview;
+use Magento\Backend\Block\Template;
 use Magento\Framework\DataObject;
 
 class Update extends AbstractAction
@@ -18,7 +18,7 @@ public function execute()
         $layout = $this->layoutFactory->create();
 
         $block = $layout
-            ->createBlock(BaseAdminTemplate::class)
+            ->createBlock(Template::class)
             ->setData('view_model', $this->_objectManager->create(Overview::class))
             ->setTemplate('Algolia_AlgoliaSearch::analytics/overview.phtml')
             ->toHtml();

diff --git a/Factory/ViewModelFactory.php b/Factory/ViewModelFactory.php
diff --git a/ViewModel/Adminhtml/Analytics/Form.php b/ViewModel/Adminhtml/Analytics/Form.php
@@ -2,7 +2,7 @@
 
 namespace Algolia\AlgoliaSearch\ViewModel\Adminhtml\Analytics;
 
-class Form extends Overview
+class Form extends Overview implements \Magento\Framework\View\Element\Block\ArgumentInterface
 {
     /**
      * @return string

diff --git a/ViewModel/Adminhtml/Analytics/Overview.php b/ViewModel/Adminhtml/Analytics/Overview.php
@@ -9,7 +9,7 @@
 use Magento\Framework\Exception\NoSuchEntityException;
 use Magento\Store\Api\Data\StoreInterface;
 
-class Overview
+class Overview implements \Magento\Framework\View\Element\Block\ArgumentInterface
 {
     const LIMIT_RESULTS = 5;
 

diff --git a/ViewModel/Adminhtml/Common.php b/ViewModel/Adminhtml/Common.php
@@ -6,7 +6,7 @@
 use Algolia\AlgoliaSearch\Helper\ProxyHelper;
 use Algolia\AlgoliaSearch\Model\ExtensionNotification;
 
-class Common
+class Common implements \Magento\Framework\View\Element\Block\ArgumentInterface
 {
     /** @var ProxyHelper */
     private $proxyHelper;

diff --git a/ViewModel/Adminhtml/Landingpage/Suggestions.php b/ViewModel/Adminhtml/Landingpage/Suggestions.php
@@ -4,7 +4,7 @@
 
 use Algolia\AlgoliaSearch\Model\ResourceModel\LandingPage\CollectionFactory as LandingPageCollectionFactory;
 
-class Suggestions
+class Suggestions implements \Magento\Framework\View\Element\Block\ArgumentInterface
 {
     /** @var LandingPageCollectionFactory */
     private $landingPageCollectionFactory;

diff --git a/ViewModel/Adminhtml/Merchandising/Page.php b/ViewModel/Adminhtml/Merchandising/Page.php
@@ -4,7 +4,7 @@
 
 use Algolia\AlgoliaSearch\Helper\ProxyHelper;
 
-class Page
+class Page implements \Magento\Framework\View\Element\Block\ArgumentInterface
 {
     /** @var ProxyHelper */
     private $proxyHelper;

diff --git a/ViewModel/Adminhtml/Query/Suggestions.php b/ViewModel/Adminhtml/Query/Suggestions.php
@@ -4,7 +4,7 @@
 
 use Algolia\AlgoliaSearch\Model\ResourceModel\Query\CollectionFactory as QueryCollectionFactory;
 
-class Suggestions
+class Suggestions implements \Magento\Framework\View\Element\Block\ArgumentInterface
 {
     /** @var QueryCollectionFactory */
     private $queryCollectionFactory;

diff --git a/ViewModel/Adminhtml/Support/Contact.php b/ViewModel/Adminhtml/Support/Contact.php
@@ -8,7 +8,7 @@
 use Magento\Framework\Module\ModuleListInterface;
 use Magento\User\Model\User;
 
-class Contact
+class Contact implements \Magento\Framework\View\Element\Block\ArgumentInterface
 {
     /** @var BackendView */
     private $backendView;

diff --git a/ViewModel/Adminhtml/Support/Overview.php b/ViewModel/Adminhtml/Support/Overview.php
@@ -2,12 +2,11 @@
 
 namespace Algolia\AlgoliaSearch\ViewModel\Adminhtml\Support;
 
-use Algolia\AlgoliaSearch\Block\Adminhtml\BaseAdminTemplate;
 use Algolia\AlgoliaSearch\Helper\SupportHelper;
 use Algolia\AlgoliaSearch\ViewModel\Adminhtml\BackendView;
 use Magento\Backend\Block\Template;
 
-class Overview
+class Overview implements \Magento\Framework\View\Element\Block\ArgumentInterface
 {
     /** @var BackendView */
     private $backendView;
@@ -50,13 +49,4 @@ public function getLegacyVersionHtml()
 
         return $block->toHtml();
     }
-
-    public function getContactHtml()
-    {
-        /** @var BaseAdminTemplate $block */
-        $block = $this->backendView->getLayout()->createBlock(BaseAdminTemplate::class);
-        $block->setTemplate('Algolia_AlgoliaSearch::support/contact.phtml');
-
-        return $block->toHtml();
-    }
 }
diff --git a/view/adminhtml/layout/algolia_algoliasearch_analytics_index.xml b/view/adminhtml/layout/algolia_algoliasearch_analytics_index.xml
@@ -14,10 +14,18 @@
                     <argument name="default_selection_name" xsi:type="string" translate="true">Default Store View</argument>
                 </arguments>
             </block>
-            <block class="Algolia\AlgoliaSearch\Block\Adminhtml\BaseAdminTemplate" name="analytics.overview.form" template="Algolia_AlgoliaSearch::analytics/form.phtml" />
+            <block class="Magento\Backend\Block\Template" name="analytics.overview.form" template="Algolia_AlgoliaSearch::analytics/form.phtml">
+                <arguments>
+                    <argument name="view_model" xsi:type="object">Algolia\AlgoliaSearch\ViewModel\Adminhtml\Analytics\Form</argument>
+                </arguments>
+            </block>
         </referenceContainer>
         <referenceContainer name="content">
-            <block class="Algolia\AlgoliaSearch\Block\Adminhtml\BaseAdminTemplate" name="analytics_overview" template="Algolia_AlgoliaSearch::analytics/overview.phtml" />
+            <block class="Magento\Backend\Block\Template" name="analytics_overview" template="Algolia_AlgoliaSearch::analytics/overview.phtml">
+                <arguments>
+                    <argument name="view_model" xsi:type="object">Algolia\AlgoliaSearch\ViewModel\Adminhtml\Analytics\Overview</argument>
+                </arguments>
+            </block>
         </referenceContainer>
     </body>
 </page>
diff --git a/view/adminhtml/layout/algolia_algoliasearch_landingpage_index.xml b/view/adminhtml/layout/algolia_algoliasearch_landingpage_index.xml
@@ -6,11 +6,11 @@
     </head>
     <body>
         <referenceContainer name="content">
-            <block
-                class="Algolia\AlgoliaSearch\Block\Adminhtml\BaseAdminTemplate"
-                name="landingpage_suggestions"
-                template="Algolia_AlgoliaSearch::landingpage/suggestions.phtml"
-            />
+            <block class="Magento\Backend\Block\Template" name="landingpage_suggestions" template="Algolia_AlgoliaSearch::landingpage/suggestions.phtml" >
+                <arguments>
+                    <argument name="view_model" xsi:type="object">Algolia\AlgoliaSearch\ViewModel\Adminhtml\Landingpage\Suggestions</argument>
+                 </arguments>
+            </block>
             <uiComponent name="algolia_algoliasearch_landingpage_listing"/>
         </referenceContainer>
     </body>

diff --git a/view/adminhtml/layout/algolia_algoliasearch_merchandising_index.xml b/view/adminhtml/layout/algolia_algoliasearch_merchandising_index.xml
@@ -7,9 +7,14 @@
     </head>
     <body>
         <referenceContainer name="content">
-            <block class="Algolia\AlgoliaSearch\Block\Adminhtml\BaseAdminTemplate" name="merchandising_page" template="Algolia_AlgoliaSearch::merchandising/page.phtml">
-                <block class="Algolia\AlgoliaSearch\Block\Adminhtml\BaseAdminTemplate" name="upsell" template="ui/upsell-plan.phtml" />
+
+            <block class="Magento\Backend\Block\Template" name="merchandising_page" template="Algolia_AlgoliaSearch::merchandising/page.phtml" >
+                <arguments>
+                    <argument name="view_model" xsi:type="object">Algolia\AlgoliaSearch\ViewModel\Adminhtml\Merchandising\Page</argument>
+                </arguments>
+                <block class="Magento\Backend\Block\Template" name="upsell" template="Algolia_AlgoliaSearch::ui/upsell-plan.phtml" ></block>
             </block>
+
         </referenceContainer>
     </body>
 </page>
diff --git a/view/adminhtml/layout/algolia_algoliasearch_query_index.xml b/view/adminhtml/layout/algolia_algoliasearch_query_index.xml
@@ -6,11 +6,11 @@
     </head>
     <body>
         <referenceContainer name="content">
-            <block
-                class="Algolia\AlgoliaSearch\Block\Adminhtml\BaseAdminTemplate"
-                name="query_suggestions"
-                template="Algolia_AlgoliaSearch::query/suggestions.phtml"
-            />
+            <block class="Magento\Backend\Block\Template" name="query_suggestions" template="Algolia_AlgoliaSearch::query/suggestions.phtml" >
+                <arguments>
+                    <argument name="view_model" xsi:type="object">Algolia\AlgoliaSearch\ViewModel\Adminhtml\Query\Suggestions</argument>
+                </arguments>
+            </block>
             <uiComponent name="algolia_algoliasearch_query_listing"/>
         </referenceContainer>
     </body>

diff --git a/view/adminhtml/layout/algolia_algoliasearch_support_contact.xml b/view/adminhtml/layout/algolia_algoliasearch_support_contact.xml
@@ -7,7 +7,11 @@
     </head>
     <body>
         <referenceContainer name="content">
-            <block class="Algolia\AlgoliaSearch\Block\Adminhtml\BaseAdminTemplate" name="support_contact" template="Algolia_AlgoliaSearch::support/contact.phtml" />
+            <block class="Magento\Backend\Block\Template" name="support_contact" template="Algolia_AlgoliaSearch::support/contact.phtml" >
+                <arguments>
+                    <argument name="view_model" xsi:type="object">Algolia\AlgoliaSearch\ViewModel\Adminhtml\Support\Contact</argument>
+                </arguments>
+            </block>
         </referenceContainer>
     </body>
 </page>
diff --git a/view/adminhtml/layout/algolia_algoliasearch_support_index.xml b/view/adminhtml/layout/algolia_algoliasearch_support_index.xml
@@ -8,7 +8,16 @@
     <body>
 
         <referenceContainer name="content">
-            <block class="Algolia\AlgoliaSearch\Block\Adminhtml\BaseAdminTemplate" name="support_overview" template="Algolia_AlgoliaSearch::support/overview.phtml" />
+            <block class="Magento\Backend\Block\Template" name="support_overview" template="Algolia_AlgoliaSearch::support/overview.phtml">
+                <arguments>
+                    <argument name="view_model" xsi:type="object">Algolia\AlgoliaSearch\ViewModel\Adminhtml\Support\Overview</argument>
+                </arguments>
+                <block class="Magento\Backend\Block\Template" name="support_contact" template="Algolia_AlgoliaSearch::support/contact.phtml">
+                    <arguments>
+                        <argument name="view_model" xsi:type="object">Algolia\AlgoliaSearch\ViewModel\Adminhtml\Support\Contact</argument>
+                    </arguments>
+                </block>
+            </block>
         </referenceContainer>
     </body>
 </page>
diff --git a/view/adminhtml/layout/default.xml b/view/adminhtml/layout/default.xml
@@ -5,6 +5,10 @@
     </head>
 
     <referenceBlock name="before.body.end">
-        <block class="Algolia\AlgoliaSearch\Block\Adminhtml\BaseAdminTemplate" name="algolia_common" template="Algolia_AlgoliaSearch::common.phtml" />
+        <block class="Magento\Backend\Block\Template" name="algolia_common" template="Algolia_AlgoliaSearch::common.phtml" >
+            <arguments>
+                <argument name="view_model" xsi:type="object">Algolia\AlgoliaSearch\ViewModel\Adminhtml\Common</argument>
+            </arguments>
+        </block>
     </referenceBlock>
 </page>
diff --git a/view/adminhtml/templates/analytics/form.phtml b/view/adminhtml/templates/analytics/form.phtml
@@ -1,6 +1,6 @@
 <?php
 
-/** @var $this \Algolia\AlgoliaSearch\Block\Adminhtml\BaseAdminTemplate */
+/** @var $this \Magento\Backend\Block\Template */
 
 /** @var Algolia\AlgoliaSearch\ViewModel\Adminhtml\Analytics\Form $form */
 $form = $this->getViewModel();

diff --git a/view/adminhtml/templates/analytics/overview.phtml b/view/adminhtml/templates/analytics/overview.phtml
@@ -1,6 +1,6 @@
 <?php
 
-/** @var $this \Algolia\AlgoliaSearch\Block\Adminhtml\BaseAdminTemplate */
+/** @var $this \Magento\Backend\Block\Template */
 
 /** @var Algolia\AlgoliaSearch\ViewModel\Adminhtml\Analytics\Overview $view */
 $view = $this->getViewModel();

diff --git a/view/adminhtml/templates/common.phtml b/view/adminhtml/templates/common.phtml
@@ -1,6 +1,6 @@
 <?php
 
-/** @var $this \Algolia\AlgoliaSearch\Block\Adminhtml\BaseAdminTemplate */
+/** @var $this \Magento\Backend\Block\Template */
 
 /** @var \Algolia\AlgoliaSearch\ViewModel\Adminhtml\Common $viewModel */
 $viewModel = $this->getViewModel();

diff --git a/view/adminhtml/templates/landingpage/suggestions.phtml b/view/adminhtml/templates/landingpage/suggestions.phtml
@@ -1,6 +1,6 @@
 <?php
 
-/** @var $this \Algolia\AlgoliaSearch\Block\Adminhtml\BaseAdminTemplate */
+/** @var $this \Magento\Backend\Block\Template */
 
 /** @var \Algolia\AlgoliaSearch\ViewModel\Adminhtml\Landingpage\Suggestions $view */
 $view = $this->getViewModel();

diff --git a/view/adminhtml/templates/merchandising/page.phtml b/view/adminhtml/templates/merchandising/page.phtml
@@ -1,4 +1,4 @@
-<?php /** @var \Algolia\AlgoliaSearch\Block\Adminhtml\BaseAdminTemplate $block */ ?>
+<?php /** @var \Magento\Backend\Block\Template $block */ ?>
 <?php /** @var \Algolia\AlgoliaSearch\ViewModel\Adminhtml\Merchandising\Page $viewModel */ ?>
 <?php $viewModel = $block->getViewModel() ?>
 <div class="algolia-admin-content">

diff --git a/view/adminhtml/templates/query/suggestions.phtml b/view/adminhtml/templates/query/suggestions.phtml
@@ -1,6 +1,6 @@
 <?php
 
-/** @var $this \Algolia\AlgoliaSearch\Block\Adminhtml\BaseAdminTemplate */
+/** @var $this \Magento\Backend\Block\Template */
 
 /** @var \Algolia\AlgoliaSearch\ViewModel\Adminhtml\Query\Suggestions $view */
 $view = $this->getViewModel();

diff --git a/view/adminhtml/templates/support/contact.phtml b/view/adminhtml/templates/support/contact.phtml
@@ -1,6 +1,6 @@
 <?php
 
-/** @var $this \Algolia\AlgoliaSearch\Block\Adminhtml\BaseAdminTemplate */
+/** @var $this \Magento\Backend\Block\Template */
 
 /** @var \Algolia\AlgoliaSearch\ViewModel\Adminhtml\Support\Contact $view */
 $view = $this->getViewModel();

diff --git a/view/adminhtml/templates/support/overview.phtml b/view/adminhtml/templates/support/overview.phtml
@@ -1,6 +1,6 @@
 <?php
 
-/** @var $this \Algolia\AlgoliaSearch\Block\Adminhtml\BaseAdminTemplate */
+/** @var $this \Magento\Backend\Block\Template */
 
 /** @var \Algolia\AlgoliaSearch\ViewModel\Adminhtml\Support\Overview $view */
 $view = $this->getViewModel();
@@ -252,7 +252,7 @@ $videoFeatures = $this->getViewFileUrl('Algolia_AlgoliaSearch::images/video-feat
     </div>
 
     <div class="algolia_support_panel" id="algolia-contact-panel">
-        <?php echo $view->getContactHtml(); ?>
+        <?php echo $block->getChildHtml('support_contact') ?>
     </div>
 
 </div>