Unified creating of common blocks

.rector.php

@@ -22,6 +22,7 @@
 use Rector\PHPUnit\CodeQuality\Rector\Class_\PreferPHPUnitThisCallRector;
 use Rector\Privatization\Rector as Privatization;
 use Rector\Renaming\Rector as Renaming;
+use Rector\Renaming\ValueObject\MethodCallRename as RenamingMethodCallRename;
 use Rector\Strict\Rector as Strict;
 use Rector\Transform\Rector as Transform;
 use Rector\TypeDeclaration\Rector as TypeDeclaration;
@@ -40,6 +41,10 @@
             __DIR__,
         ])
         ->withSkipPath(__DIR__ . '/vendor')
+        # Rename method calls
+        #->withConfiguredRule(Renaming\MethodCall\RenameMethodRector::class, [
+        #    new RenamingMethodCallRename('Mage_Core_Model_Layout', 'getBlock', 'getBlockByName'),
+        #])
         ->withRules([
             Php85\ArrayDimFetch\ArrayFirstLastRector::class,
         ])

app/code/core/Mage/Adminhtml/Block/Catalog/Category/Tab/Attributes.php

@@ -41,7 +41,8 @@ protected function _prepareLayout()
     {
         parent::_prepareLayout();
         if (Mage::getSingleton('cms/wysiwyg_config')->isEnabled()) {
-            $this->getLayout()->getBlock('head')->setCanLoadTinyMce(true);
+            $head = $this->getLayout()->getBlockAdminhtmlHead();
+            $head?->setCanLoadTinyMce(true);
         }
 
         return $this;

app/code/core/Mage/Adminhtml/Block/Catalog/Product/Edit/Tab/Attributes.php

@@ -23,7 +23,8 @@ protected function _prepareLayout()
         if ($this->isModuleEnabled('Mage_Cms', 'catalog')
             && Mage::getSingleton('cms/wysiwyg_config')->isEnabled()
         ) {
-            $this->getLayout()->getBlock('head')->setCanLoadTinyMce(true);
+            $head = $this->getLayout()->getBlockAdminhtmlHead();
+            $head?->setCanLoadTinyMce(true);
         }
 
         return $this;

app/code/core/Mage/Adminhtml/Block/Cms/Block/Edit/Form.php

@@ -31,7 +31,8 @@ protected function _prepareLayout()
     {
         parent::_prepareLayout();
         if (Mage::getSingleton('cms/wysiwyg_config')->isEnabled()) {
-            $this->getLayout()->getBlock('head')->setCanLoadTinyMce(true);
+            $head = $this->getLayout()->getBlockAdminhtmlHead();
+            $head?->setCanLoadTinyMce(true);
         }
 
         return $this;

app/code/core/Mage/Adminhtml/Block/Cms/Page/Edit/Tab/Content.php

@@ -21,7 +21,8 @@ protected function _prepareLayout()
     {
         parent::_prepareLayout();
         if (Mage::getSingleton('cms/wysiwyg_config')->isEnabled()) {
-            $this->getLayout()->getBlock('head')->setCanLoadTinyMce(true);
+            $head = $this->getLayout()->getBlockAdminhtmlHead();
+            $head?->setCanLoadTinyMce(true);
         }
 
         return $this;

app/code/core/Mage/Adminhtml/Block/Newsletter/Queue/Edit.php

@@ -73,7 +73,8 @@ protected function _prepareLayout()
     {
         // Load Wysiwyg on demand and Prepare layout
         if (Mage::getSingleton('cms/wysiwyg_config')->isEnabled()) {
-            $this->getLayout()->getBlock('head')->setCanLoadTinyMce(true);
+            $head = $this->getLayout()->getBlockAdminhtmlHead();
+            $head?->setCanLoadTinyMce(true);
         }
 
         $this->setChild(

app/code/core/Mage/Adminhtml/Block/Newsletter/Template/Edit.php

@@ -37,8 +37,9 @@ public function getModel()
     protected function _prepareLayout()
     {
         // Load Wysiwyg on demand and Prepare layout
-        if (Mage::getSingleton('cms/wysiwyg_config')->isEnabled() && ($block = $this->getLayout()->getBlock('head'))) {
-            $block->setCanLoadTinyMce(true);
+        if (Mage::getSingleton('cms/wysiwyg_config')->isEnabled()) {
+            $head = $this->getLayout()->getBlockAdminhtmlHead();
+            $head?->setCanLoadTinyMce(true);
         }
 
         $this->setChild(

app/code/core/Mage/Adminhtml/Block/Page/Head.php

@@ -11,6 +11,10 @@
  * Adminhtml header block
  *
  * @package    Mage_Adminhtml
+ *
+ * @method $this setCanLoadExtJs(bool $value)
+ * @method $this setCanLoadRulesJs(bool $value)
+ * @method $this setContainerCssClass(string $value)
  */
 class Mage_Adminhtml_Block_Page_Head extends Mage_Page_Block_Html_Head
 {

app/code/core/Mage/Adminhtml/Block/Page/Menu.php

@@ -12,6 +12,8 @@
  *
  * @package    Mage_Adminhtml
  *
+ * @method $this setActive(string $menuPath)
+ * @method string getActive()
  * @method $this setAdditionalCacheKeyInfo(array $cacheKeyInfo)
  * @method array getAdditionalCacheKeyInfo()
  */

app/code/core/Mage/Adminhtml/Block/System/Convert/Gui/Edit/Tab/Wizard.php

@@ -43,9 +43,8 @@ public function __construct()
      */
     protected function _prepareLayout()
     {
-        if ($head = $this->getLayout()->getBlock('head')) {
-            $head->setCanLoadCalendarJs(true);
-        }
+        $head = $this->getLayout()->getBlockAdminhtmlHead();
+        $head?->setCanLoadCalendarJs(true);
 
         return $this;
     }

app/code/core/Mage/Adminhtml/Block/System/Email/Template/Edit/Form.php

@@ -22,14 +22,12 @@ class Mage_Adminhtml_Block_System_Email_Template_Edit_Form extends Mage_Adminhtm
      */
     protected function _prepareLayout()
     {
-        /** @var Mage_Page_Block_Html_Head $head */
-        $head = $this->getLayout()->getBlock('head');
-        if ($head) {
-            $head->addItem('js', 'prototype/window.js')
-                ->addItem('js_css', 'prototype/windows/themes/default.css')
-                ->addCss('lib/prototype/windows/themes/magento.css')
-                ->addItem('js', 'mage/adminhtml/variables.js');
-        }
+        $head = $this->getLayout()->getBlockAdminhtmlHead();
+        $head
+            ?->addItem('js', 'prototype/window.js')
+            ->addItem('js_css', 'prototype/windows/themes/default.css')
+            ->addCss('lib/prototype/windows/themes/magento.css')
+            ->addItem('js', 'mage/adminhtml/variables.js');
 
         return parent::_prepareLayout();
     }

app/code/core/Mage/Adminhtml/Block/Widget.php

@@ -54,9 +54,8 @@ public function getCurrentUrl($params = [])
 
     protected function _addBreadcrumb($label, $title = null, $link = null)
     {
-        /** @var Mage_Adminhtml_Block_Widget_Breadcrumbs $block */
-        $block = $this->getLayout()->getBlock('breadcrumbs');
-        $block->addLink($label, $title, $link);
+        $block = $this->getLayout()->getBlockAdminhtmlBreadcrumbs();
+        $block?->addLink($label, $title, $link);
     }
 
     /**

app/code/core/Mage/Adminhtml/Block/Widget/Grid/Column/Filter/Date.php

@@ -22,9 +22,8 @@ class Mage_Adminhtml_Block_Widget_Grid_Column_Filter_Date extends Mage_Adminhtml
      */
     protected function _prepareLayout()
     {
-        if ($head = $this->getLayout()->getBlock('head')) {
-            $head->setCanLoadCalendarJs(true);
-        }
+        $head = $this->getLayout()->getBlockAdminhtmlHead();
+        $head?->setCanLoadCalendarJs(true);
 
         return parent::_prepareLayout();
     }

app/code/core/Mage/Adminhtml/Controller/Action.php

@@ -98,9 +98,11 @@ protected function _getHelper()
      *
      * @return $this
      */
-    protected function _setActiveMenu($menuPath)
+    protected function _setActiveMenu(string $menuPath)
     {
-        $this->getLayout()->getBlock('menu')->setActive($menuPath);
+        $block = $this->getLayout()->getBlockAdminhtmlMenu();
+        $block?->setActive($menuPath);
+
         return $this;
     }
 
@@ -109,9 +111,9 @@ protected function _setActiveMenu($menuPath)
      */
     protected function _addBreadcrumb($label, $title, $link = null)
     {
-        /** @var Mage_Adminhtml_Block_Widget_Breadcrumbs $block */
-        $block = $this->getLayout()->getBlock('breadcrumbs');
-        $block->addLink($label, $title, $link);
+        $block = $this->getLayout()->getBlockAdminhtmlBreadcrumbs();
+        $block?->addLink($label, $title, $link);
+
         return $this;
     }
 

app/code/core/Mage/Adminhtml/controllers/Api/RoleController.php

@@ -83,7 +83,8 @@ public function editRoleAction()
 
         $this->_addBreadcrumb($breadCrumb, $breadCrumbTitle);
 
-        $this->getLayout()->getBlock('head')->setCanLoadExtJs(true);
+        $head = $this->getLayout()->getBlockAdminhtmlHead();
+        $head?->setCanLoadExtJs(true);
 
         $this->_addLeft(
             $this->getLayout()->createBlock('adminhtml/api_editroles'),

app/code/core/Mage/Adminhtml/controllers/Catalog/CategoryController.php

@@ -183,8 +183,12 @@ public function editAction()
 
         $this->loadLayout();
         $this->_setActiveMenu('catalog/categories');
-        $this->getLayout()->getBlock('head')->setCanLoadExtJs(true)
-            ->setContainerCssClass('catalog-categories');
+
+        $head = $this->getLayout()->getBlockAdminhtmlHead();
+        if ($head) {
+            $head->setCanLoadExtJs(true);
+            $head->setContainerCssClass('catalog-categories');
+        }
 
         $this->_addBreadcrumb(
             Mage::helper('catalog')->__('Manage Catalog Categories'),

app/code/core/Mage/Adminhtml/controllers/Catalog/Product/ReviewController.php

@@ -105,7 +105,8 @@ public function newAction()
         $this->loadLayout();
         $this->_setActiveMenu('catalog/reviews_ratings/reviews/all');
 
-        $this->getLayout()->getBlock('head')->setCanLoadExtJs(true);
+        $head = $this->getLayout()->getBlockAdminhtmlHead();
+        $head?->setCanLoadExtJs(true);
 
         $this->_addContent($this->getLayout()->createBlock('adminhtml/review_add'));
         $this->_addContent($this->getLayout()->createBlock('adminhtml/review_product_grid'));

app/code/core/Mage/Adminhtml/controllers/Catalog/Product/SetController.php

@@ -64,7 +64,9 @@ public function editAction()
 
         $this->loadLayout();
         $this->_setActiveMenu('catalog/attributes/sets');
-        $this->getLayout()->getBlock('head')->setCanLoadExtJs(true);
+
+        $head = $this->getLayout()->getBlockAdminhtmlHead();
+        $head?->setCanLoadExtJs(true);
 
         $this->_addBreadcrumb(Mage::helper('catalog')->__('Catalog'), Mage::helper('catalog')->__('Catalog'));
         $this->_addBreadcrumb(

app/code/core/Mage/Adminhtml/controllers/Catalog/ProductController.php

@@ -215,7 +215,8 @@ public function newAction()
             $this->_setActiveMenu('catalog/products');
         }
 
-        $this->getLayout()->getBlock('head')->setCanLoadExtJs(true);
+        $head = $this->getLayout()->getBlockAdminhtmlHead();
+        $head?->setCanLoadExtJs(true);
 
         $block = $this->getLayout()->getBlock('catalog.wysiwyg.js');
         if ($block) {
@@ -268,7 +269,8 @@ public function editAction()
                 );
         }
 
-        $this->getLayout()->getBlock('head')->setCanLoadExtJs(true);
+        $head = $this->getLayout()->getBlockAdminhtmlHead();
+        $head?->setCanLoadExtJs(true);
 
         $block = $this->getLayout()->getBlock('catalog.wysiwyg.js');
         if ($block) {

app/code/core/Mage/Adminhtml/controllers/Catalog/SearchController.php

@@ -70,7 +70,8 @@ public function editAction()
 
         $this->_title($id ? $model->getQueryText() : $this->__('New Search'));
 
-        $this->getLayout()->getBlock('head')->setCanLoadRulesJs(true);
+        $head = $this->getLayout()->getBlockAdminhtmlHead();
+        $head?->setCanLoadRulesJs(true);
 
         $this->getLayout()->getBlock('catalog_search_edit')
             ->setData('action', $this->getUrl('*/catalog_search/save'));

app/code/core/Mage/Adminhtml/controllers/Permissions/RoleController.php

@@ -109,7 +109,8 @@ public function editRoleAction()
 
         $this->_addBreadcrumb($breadCrumb, $breadCrumbTitle);
 
-        $this->getLayout()->getBlock('head')->setCanLoadExtJs(true);
+        $head = $this->getLayout()->getBlockAdminhtmlHead();
+        $head?->setCanLoadExtJs(true);
 
         $this->_addContent(
             $this->getLayout()->createBlock('adminhtml/permissions_buttons')

app/code/core/Mage/Adminhtml/controllers/System/ConfigController.php

@@ -85,9 +85,8 @@ public function editAction()
 
         $this->_setActiveMenu('system/config');
 
-        /** @var Mage_Adminhtml_Block_Page_Menu $block */
-        $block = $this->getLayout()->getBlock('menu');
-        $block->setAdditionalCacheKeyInfo([$current]);
+        $block = $this->getLayout()->getBlockAdminhtmlMenu();
+        $block?->setAdditionalCacheKeyInfo([$current]);
 
         $this->_addBreadcrumb(
             Mage::helper('adminhtml')->__('System'),

app/code/core/Mage/Adminhtml/controllers/System/DesignController.php

@@ -55,10 +55,12 @@ public function editAction()
 
         $this->loadLayout();
         $this->_setActiveMenu('system/design');
-        $this->getLayout()->getBlock('head')->setCanLoadExtJs(true);
 
-        $id  = (int) $this->getRequest()->getParam('id');
-        $design    = Mage::getModel('core/design');
+        $head = $this->getLayout()->getBlockAdminhtmlHead();
+        $head?->setCanLoadExtJs(true);
+
+        $id = (int) $this->getRequest()->getParam('id');
+        $design = Mage::getModel('core/design');
 
         if ($id) {
             $design->load($id);

app/code/core/Mage/Adminhtml/controllers/UrlrewriteController.php

@@ -76,7 +76,10 @@ public function editAction()
         $this->loadLayout();
         $this->_setActiveMenu('catalog/urlrewrite');
         $this->_addContent($this->getLayout()->createBlock('adminhtml/urlrewrite_edit'));
-        $this->getLayout()->getBlock('head')->setCanLoadExtJs(true);
+
+        $head = $this->getLayout()->getBlockAdminhtmlHead();
+        $head?->setCanLoadExtJs(true);
+
         $this->renderLayout();
     }
 

app/code/core/Mage/Catalog/Block/Breadcrumbs.php

@@ -33,10 +33,9 @@ public function getTitleSeparator($store = null)
      */
     protected function _prepareLayout()
     {
-        /** @var Mage_Page_Block_Html_Breadcrumbs $breadcrumbsBlock */
-        $breadcrumbsBlock = $this->getLayout()->getBlock('breadcrumbs');
-        if ($breadcrumbsBlock) {
-            $breadcrumbsBlock->addCrumb('home', [
+        $breadcrumbs = $this->getLayout()->getBlockBreadcrumbs();
+        if ($breadcrumbs) {
+            $breadcrumbs->addCrumb('home', [
                 'label' => Mage::helper('catalog')->__('Home'),
                 'title' => Mage::helper('catalog')->__('Go to Home Page'),
                 'link' => Mage::getBaseUrl(),
@@ -46,13 +45,12 @@ protected function _prepareLayout()
             $path  = Mage::helper('catalog')->getBreadcrumbPath();
 
             foreach ($path as $name => $breadcrumb) {
-                $breadcrumbsBlock->addCrumb($name, $breadcrumb);
+                $breadcrumbs->addCrumb($name, $breadcrumb);
                 $title[] = $breadcrumb['label'];
             }
 
-            if ($headBlock = $this->getLayout()->getBlock('head')) {
-                $headBlock->setTitle(implode($this->getTitleSeparator(), array_reverse($title)));
-            }
+            $head = $this->getLayout()->getBlockHead();
+            $head?->setTitle(implode($this->getTitleSeparator(), array_reverse($title)));
         }
 
         return parent::_prepareLayout();

app/code/core/Mage/Catalog/Block/Category/View.php

@@ -24,34 +24,33 @@ protected function _prepareLayout()
 
         $this->getLayout()->createBlock('catalog/breadcrumbs');
 
-        /** @var Mage_Page_Block_Html_Head $headBlock */
-        $headBlock = $this->getLayout()->getBlock('head');
-        if ($headBlock) {
+        $head = $this->getLayout()->getBlockHead();
+        if ($head) {
             $category = $this->getCurrentCategory();
             if ($title = $category->getMetaTitle()) {
-                $headBlock->setTitle($title);
+                $head->setTitle($title);
             }
 
             if ($description = $category->getMetaDescription()) {
-                $headBlock->setDescription($description);
+                $head->setDescription($description);
             }
 
             if ($keywords = $category->getMetaKeywords()) {
-                $headBlock->setKeywords($keywords);
+                $head->setKeywords($keywords);
             }
 
             /** @var Mage_Catalog_Helper_Category $helper */
             $helper = $this->helper('catalog/category');
             if ($helper->canUseCanonicalTag()) {
-                $headBlock->addLinkRel('canonical', $category->getUrl());
+                $head->addLinkRel('canonical', $category->getUrl());
             }
 
             /*
             want to show rss feed in the url
             */
             if ($this->isRssCatalogEnable() && $this->isTopCategory()) {
                 $title = $this->helper('rss')->__('%s RSS Feed', $this->getCurrentCategory()->getName());
-                $headBlock->addItem('rss', $this->getRssLink(), 'title="' . $title . '"');
+                $head->addItem('rss', $this->getRssLink(), 'title="' . $title . '"');
             }
         }
 

app/code/core/Mage/Catalog/Block/Product/Compare/List.php

@@ -67,10 +67,8 @@ public function getAddToWishlistUrl($product)
      */
     protected function _prepareLayout()
     {
-        $headBlock = $this->getLayout()->getBlock('head');
-        if ($headBlock) {
-            $headBlock->setTitle(Mage::helper('catalog')->__('Products Comparison List') . ' - ' . $headBlock->getDefaultTitle());
-        }
+        $head = $this->getLayout()->getBlockHead();
+        $head?->setTitle(Mage::helper('catalog')->__('Products Comparison List') . ' - ' . $head->getDefaultTitle());
 
         return parent::_prepareLayout();
     }