Make Mage_GiftMessage optional in templates (#4266)

* Make Mage_GiftMessage optional in templates

* ~ add return parameters

* ~ ractor

* ~ fix getProductAdditionalInformationBlock return type, block might not exist

* ~ add missing return type

* ~ fix return type for overwrite

* ~ fix missing return

* ~ isModuleEnabled -> isModuleOutputEnabled

* Update Grid.php

* Update .phpstan.dist.baseline.neon

* Update additional.phtml

* Update .phpstan.dist.baseline.neon

* Update default.phtml

* Update Details.php

* Update Items.php

* Update .phpstan.dist.baseline.neon

Author: Hanmac

.phpstan.dist.baseline.neon

@@ -7680,11 +7680,6 @@ parameters:
 			count: 2
 			path: app/design/adminhtml/default/default/template/sales/order/address/form.phtml
 
-		-
-			message: "#^If condition is always true\\.$#"
-			count: 1
-			path: app/design/adminhtml/default/default/template/sales/order/create/giftmessage.phtml
-
 		-
 			message: "#^Method Mage_Adminhtml_Block_Sales_Order_Create_Abstract\\:\\:formatPrice\\(\\) invoked with 3 parameters, 1 required\\.$#"
 			count: 18
@@ -8150,51 +8145,6 @@ parameters:
 			count: 4
 			path: app/design/frontend/base/default/template/bundle/catalog/product/view/type/bundle/options.phtml
 
-		-
-			message: "#^Variable \\$_item might not be defined\\.$#"
-			count: 1
-			path: app/design/frontend/base/default/template/bundle/email/order/items/creditmemo/default.phtml
-
-		-
-			message: "#^Variable \\$_showlastRow might not be defined\\.$#"
-			count: 1
-			path: app/design/frontend/base/default/template/bundle/email/order/items/creditmemo/default.phtml
-
-		-
-			message: "#^Variable \\$this might not be defined\\.$#"
-			count: 22
-			path: app/design/frontend/base/default/template/bundle/email/order/items/creditmemo/default.phtml
-
-		-
-			message: "#^Variable \\$_inc might not be defined\\.$#"
-			count: 1
-			path: app/design/frontend/base/default/template/bundle/email/order/items/invoice/default.phtml
-
-		-
-			message: "#^Variable \\$_item might not be defined\\.$#"
-			count: 1
-			path: app/design/frontend/base/default/template/bundle/email/order/items/invoice/default.phtml
-
-		-
-			message: "#^Variable \\$_showlastRow might not be defined\\.$#"
-			count: 1
-			path: app/design/frontend/base/default/template/bundle/email/order/items/invoice/default.phtml
-
-		-
-			message: "#^Variable \\$this might not be defined\\.$#"
-			count: 22
-			path: app/design/frontend/base/default/template/bundle/email/order/items/invoice/default.phtml
-
-		-
-			message: "#^Variable \\$this might not be defined\\.$#"
-			count: 27
-			path: app/design/frontend/base/default/template/bundle/email/order/items/order/default.phtml
-
-		-
-			message: "#^Variable \\$this might not be defined\\.$#"
-			count: 15
-			path: app/design/frontend/base/default/template/bundle/email/order/items/shipment/default.phtml
-
 		-
 			message: "#^Variable \\$_weeeTaxAttributes might not be defined\\.$#"
 			count: 8
@@ -8230,16 +8180,6 @@ parameters:
 			count: 173
 			path: app/design/frontend/base/default/template/bundle/sales/order/invoice/items/renderer.phtml
 
-		-
-			message: "#^Variable \\$this might not be defined\\.$#"
-			count: 181
-			path: app/design/frontend/base/default/template/bundle/sales/order/items/renderer.phtml
-
-		-
-			message: "#^Variable \\$this might not be defined\\.$#"
-			count: 20
-			path: app/design/frontend/base/default/template/bundle/sales/order/shipment/items/renderer.phtml
-
 		-
 			message: "#^Variable \\$this might not be defined\\.$#"
 			count: 17
@@ -8755,11 +8695,6 @@ parameters:
 			count: 9
 			path: app/design/frontend/base/default/template/checkout/onepage/shipping_method.phtml
 
-		-
-			message: "#^Variable \\$this might not be defined\\.$#"
-			count: 4
-			path: app/design/frontend/base/default/template/checkout/onepage/shipping_method/additional.phtml
-
 		-
 			message: "#^Variable \\$this might not be defined\\.$#"
 			count: 15
@@ -9040,26 +8975,6 @@ parameters:
 			count: 18
 			path: app/design/frontend/base/default/template/downloadable/email/order/items/invoice/downloadable.phtml
 
-		-
-			message: "#^Variable \\$this might not be defined\\.$#"
-			count: 28
-			path: app/design/frontend/base/default/template/downloadable/email/order/items/order/downloadable.phtml
-
-		-
-			message: "#^Variable \\$this might not be defined\\.$#"
-			count: 170
-			path: app/design/frontend/base/default/template/downloadable/sales/order/creditmemo/items/renderer/downloadable.phtml
-
-		-
-			message: "#^Variable \\$this might not be defined\\.$#"
-			count: 170
-			path: app/design/frontend/base/default/template/downloadable/sales/order/invoice/items/renderer/downloadable.phtml
-
-		-
-			message: "#^Variable \\$this might not be defined\\.$#"
-			count: 190
-			path: app/design/frontend/base/default/template/downloadable/sales/order/items/renderer/downloadable.phtml
-
 		-
 			message: "#^Variable \\$this might not be defined\\.$#"
 			count: 8
@@ -9070,11 +8985,6 @@ parameters:
 			count: 8
 			path: app/design/frontend/base/default/template/email/order/invoice/items.phtml
 
-		-
-			message: "#^Variable \\$this might not be defined\\.$#"
-			count: 16
-			path: app/design/frontend/base/default/template/email/order/items.phtml
-
 		-
 			message: "#^Variable \\$this might not be defined\\.$#"
 			count: 16
@@ -9085,11 +8995,6 @@ parameters:
 			count: 16
 			path: app/design/frontend/base/default/template/email/order/items/invoice/default.phtml
 
-		-
-			message: "#^Variable \\$this might not be defined\\.$#"
-			count: 24
-			path: app/design/frontend/base/default/template/email/order/items/order/default.phtml
-
 		-
 			message: "#^Variable \\$this might not be defined\\.$#"
 			count: 8
@@ -9385,31 +9290,16 @@ parameters:
 			count: 8
 			path: app/design/frontend/base/default/template/rss/list.phtml
 
-		-
-			message: "#^Variable \\$this might not be defined\\.$#"
-			count: 27
-			path: app/design/frontend/base/default/template/rss/order/details.phtml
-
 		-
 			message: "#^Variable \\$this might not be defined\\.$#"
 			count: 1
 			path: app/design/frontend/base/default/template/sales/guest/form.phtml
 
-		-
-			message: "#^Variable \\$this might not be defined\\.$#"
-			count: 5
-			path: app/design/frontend/base/default/template/sales/order/creditmemo.phtml
-
 		-
 			message: "#^Variable \\$this might not be defined\\.$#"
 			count: 17
 			path: app/design/frontend/base/default/template/sales/order/creditmemo/items.phtml
 
-		-
-			message: "#^Variable \\$this might not be defined\\.$#"
-			count: 167
-			path: app/design/frontend/base/default/template/sales/order/creditmemo/items/renderer/default.phtml
-
 		-
 			message: "#^Variable \\$this might not be defined\\.$#"
 			count: 21
@@ -9425,31 +9315,11 @@ parameters:
 			count: 10
 			path: app/design/frontend/base/default/template/sales/order/info/buttons.phtml
 
-		-
-			message: "#^Variable \\$this might not be defined\\.$#"
-			count: 5
-			path: app/design/frontend/base/default/template/sales/order/invoice.phtml
-
 		-
 			message: "#^Variable \\$this might not be defined\\.$#"
 			count: 15
 			path: app/design/frontend/base/default/template/sales/order/invoice/items.phtml
 
-		-
-			message: "#^Variable \\$this might not be defined\\.$#"
-			count: 167
-			path: app/design/frontend/base/default/template/sales/order/invoice/items/renderer/default.phtml
-
-		-
-			message: "#^Variable \\$this might not be defined\\.$#"
-			count: 18
-			path: app/design/frontend/base/default/template/sales/order/items.phtml
-
-		-
-			message: "#^Variable \\$this might not be defined\\.$#"
-			count: 187
-			path: app/design/frontend/base/default/template/sales/order/items/renderer/default.phtml
-
 		-
 			message: "#^Variable \\$this might not be defined\\.$#"
 			count: 18
@@ -9470,31 +9340,16 @@ parameters:
 			count: 17
 			path: app/design/frontend/base/default/template/sales/order/recent.phtml
 
-		-
-			message: "#^Variable \\$this might not be defined\\.$#"
-			count: 5
-			path: app/design/frontend/base/default/template/sales/order/shipment.phtml
-
 		-
 			message: "#^Variable \\$this might not be defined\\.$#"
 			count: 22
 			path: app/design/frontend/base/default/template/sales/order/shipment/items.phtml
 
-		-
-			message: "#^Variable \\$this might not be defined\\.$#"
-			count: 15
-			path: app/design/frontend/base/default/template/sales/order/shipment/items/renderer/default.phtml
-
 		-
 			message: "#^Variable \\$this might not be defined\\.$#"
 			count: 23
 			path: app/design/frontend/base/default/template/sales/order/trackinginfo.phtml
 
-		-
-			message: "#^Variable \\$this might not be defined\\.$#"
-			count: 22
-			path: app/design/frontend/base/default/template/sales/order/view.phtml
-
 		-
 			message: "#^Call to method __\\(\\) on an unknown class Mage_Sale_Block_Reorder_Sidebar\\.$#"
 			count: 6
@@ -9625,56 +9480,6 @@ parameters:
 			count: 1
 			path: app/design/frontend/rwd/default/template/bundle/catalog/product/view/type/bundle/option/select.phtml
 
-		-
-			message: "#^Variable \\$_item might not be defined\\.$#"
-			count: 1
-			path: app/design/frontend/rwd/default/template/bundle/email/order/items/creditmemo/default.phtml
-
-		-
-			message: "#^Variable \\$_showlastRow might not be defined\\.$#"
-			count: 1
-			path: app/design/frontend/rwd/default/template/bundle/email/order/items/creditmemo/default.phtml
-
-		-
-			message: "#^Variable \\$this might not be defined\\.$#"
-			count: 25
-			path: app/design/frontend/rwd/default/template/bundle/email/order/items/creditmemo/default.phtml
-
-		-
-			message: "#^Variable \\$_inc might not be defined\\.$#"
-			count: 1
-			path: app/design/frontend/rwd/default/template/bundle/email/order/items/invoice/default.phtml
-
-		-
-			message: "#^Variable \\$_item might not be defined\\.$#"
-			count: 1
-			path: app/design/frontend/rwd/default/template/bundle/email/order/items/invoice/default.phtml
-
-		-
-			message: "#^Variable \\$_showlastRow might not be defined\\.$#"
-			count: 1
-			path: app/design/frontend/rwd/default/template/bundle/email/order/items/invoice/default.phtml
-
-		-
-			message: "#^Variable \\$this might not be defined\\.$#"
-			count: 25
-			path: app/design/frontend/rwd/default/template/bundle/email/order/items/invoice/default.phtml
-
-		-
-			message: "#^Variable \\$this might not be defined\\.$#"
-			count: 29
-			path: app/design/frontend/rwd/default/template/bundle/email/order/items/order/default.phtml
-
-		-
-			message: "#^Variable \\$this might not be defined\\.$#"
-			count: 16
-			path: app/design/frontend/rwd/default/template/bundle/email/order/items/shipment/default.phtml
-
-		-
-			message: "#^Variable \\$this might not be defined\\.$#"
-			count: 181
-			path: app/design/frontend/rwd/default/template/bundle/sales/order/items/renderer.phtml
-
 		-
 			message: "#^Call to method escapeUrl\\(\\) on an unknown class Mage_Catalog_Block_Layer_Filter\\.$#"
 			count: 1
@@ -10100,16 +9905,6 @@ parameters:
 			count: 19
 			path: app/design/frontend/rwd/default/template/downloadable/email/order/items/invoice/downloadable.phtml
 
-		-
-			message: "#^Variable \\$this might not be defined\\.$#"
-			count: 29
-			path: app/design/frontend/rwd/default/template/downloadable/email/order/items/order/downloadable.phtml
-
-		-
-			message: "#^Variable \\$this might not be defined\\.$#"
-			count: 198
-			path: app/design/frontend/rwd/default/template/downloadable/sales/order/items/renderer/downloadable.phtml
-
 		-
 			message: "#^Variable \\$this might not be defined\\.$#"
 			count: 10
@@ -10125,11 +9920,6 @@ parameters:
 			count: 8
 			path: app/design/frontend/rwd/default/template/email/order/invoice/items.phtml
 
-		-
-			message: "#^Variable \\$this might not be defined\\.$#"
-			count: 16
-			path: app/design/frontend/rwd/default/template/email/order/items.phtml
-
 		-
 			message: "#^Variable \\$this might not be defined\\.$#"
 			count: 17
@@ -10140,11 +9930,6 @@ parameters:
 			count: 17
 			path: app/design/frontend/rwd/default/template/email/order/items/invoice/default.phtml
 
-		-
-			message: "#^Variable \\$this might not be defined\\.$#"
-			count: 25
-			path: app/design/frontend/rwd/default/template/email/order/items/order/default.phtml
-
 		-
 			message: "#^Variable \\$this might not be defined\\.$#"
 			count: 8
@@ -10270,11 +10055,6 @@ parameters:
 			count: 22
 			path: app/design/frontend/rwd/default/template/sales/order/creditmemo/items.phtml
 
-		-
-			message: "#^Variable \\$this might not be defined\\.$#"
-			count: 173
-			path: app/design/frontend/rwd/default/template/sales/order/creditmemo/items/renderer/default.phtml
-
 		-
 			message: "#^Variable \\$this might not be defined\\.$#"
 			count: 19
@@ -10285,21 +10065,6 @@ parameters:
 			count: 18
 			path: app/design/frontend/rwd/default/template/sales/order/invoice/items.phtml
 
-		-
-			message: "#^Variable \\$this might not be defined\\.$#"
-			count: 172
-			path: app/design/frontend/rwd/default/template/sales/order/invoice/items/renderer/default.phtml
-
-		-
-			message: "#^Variable \\$this might not be defined\\.$#"
-			count: 18
-			path: app/design/frontend/rwd/default/template/sales/order/items.phtml
-
-		-
-			message: "#^Variable \\$this might not be defined\\.$#"
-			count: 191
-			path: app/design/frontend/rwd/default/template/sales/order/items/renderer/default.phtml
-
 		-
 			message: "#^Variable \\$this might not be defined\\.$#"
 			count: 17

app/code/core/Mage/Adminhtml/Block/Sales/Order/Create/Giftmessage.php

@@ -74,4 +74,14 @@ protected function _getGiftmessageSaveModel()
     {
         return Mage::getSingleton('adminhtml/giftmessage_save');
     }
+
+    public function canDisplayGiftmessage(): bool
+    {
+        if (!Mage::helper('core')->isModuleOutputEnabled('Mage_GiftMessage')) {
+            return false;
+        }
+        /** @var Mage_GiftMessage_Helper_Message $helper */
+        $helper = $this->helper('giftmessage/message');
+        return $helper->getIsMessagesAvailable('order', $this->getEntity(), $this->getEntity()->getStoreId());
+    }
 }