DEV Community: Paboda Hettiarachchi

Update unitprice in order view via a custom module

Paboda Hettiarachchi — Wed, 12 Feb 2025 03:04:45 +0000

Vendor/Module/view/frontend/layout/sales_order_item_price.xml

<?xml version="1.0"?>
<page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
    <body>
        <referenceBlock name="item_unit_price">
            <action method="setTemplate">
                <argument name="template" xsi:type="string">Vendor_Module::item/price/unit.phtml</argument>
            </action>
        </referenceBlock>
    </body>
</page>

Vendor/Module/view/frontend/templates/item/price/unit.phtml

<?= "TEST" ?>

Add CSS on a custom module with Hyva

Paboda Hettiarachchi — Mon, 10 Feb 2025 02:44:23 +0000

app/code/Vendor/Module/Observer/RegisterModuleForHyvaConfig

<?php
declare(strict_types=1);

namespace Vendor\Module\Observer;

use Magento\Framework\Component\ComponentRegistrar;
use Magento\Framework\Event\Observer;
use Magento\Framework\Event\ObserverInterface;

class RegisterModuleForHyvaConfig implements ObserverInterface
{
    /**
     * RegisterModuleForHyvaConfig constructor
     *
     * @param ComponentRegistrar $componentRegistrar
     */
    public function __construct(
        private readonly ComponentRegistrar $componentRegistrar
    ) {
    }

    /**
     * @inheritdoc
     */
    public function execute(Observer $event): void
    {
        $config = $event->getData('config');
        $extensions = $config->hasData('extensions') ? $config->getData('extensions') : [];

        $moduleName = implode('_', array_slice(explode('\\', __CLASS__), 0, 2));

        $path = $this->componentRegistrar->getPath(ComponentRegistrar::MODULE, $moduleName);

        $extensions[] = ['src' => substr($path, strlen(BP) + 1)];

        $config->setData('extensions', $extensions);
    }
}

app/code/Vendor/Module/etc/frontend/events.xml

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
    <event name="hyva_config_generate_before">
        <observer name="Vendor_Module" instance="Vendor\Module\Observer\RegisterModuleForHyvaConfig"/>
    </event>
</config>

app/code/Vendor/Module/view/frontend/tailwind/components/category-widgets.css

.category-nav-ul {
    ul.level3 {
        > li {
            @apply border-l-2 border-gray-300 hover:border-blue-700;
            a {
                @apply block py-2.5 pl-4 text-slate-600 hover:text-blue-700;
            }
        }
    }
    > li {
        > a.level3, > a.level4 {
            @apply py-2.5 block text-slate-600 hover:text-blue-700;
        }
        > a.level4 {
            @apply border-l-2 pl-4 border-gray-300 hover:border-blue-700;
        }
    }
}

app/code/Vendor/Module/view/frontend/tailwind/tailwind.config.js

module.exports = {
    content: [
        '../templates/**/*.phtml',
    ]
}

app/code/Vendor/Module/view/frontend/tailwind/tailwind-source.css

@import "components/category-widgets.css";

Adding an order attribute to be viewed in order API

Paboda Hettiarachchi — Mon, 02 Dec 2024 15:27:16 +0000

etc/di.xml

<type name="Magento\Sales\Api\OrderRepositoryInterface">
        <plugin name="order_delivery_date_attribute" type="Vendor\DeliveryDate\Plugin\Model\Order\AddDeliveryDateAttribute" />
    </type>

etc/extension_attributes.xml

<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Api/etc/extension_attributes.xsd">
    <extension_attributes for="Magento\Sales\Api\Data\OrderInterface">
        <attribute code="delivery_date" type="string"/>
    </extension_attributes>
</config>

Vendor/DeliveryDate/Plugin/Model/Order/AddDeliveryDateAttribute.php

<?php
namespace Vendor\DeliveryDate\Plugin\Model\Order;

use Magento\Sales\Api\Data\OrderSearchResultInterface;
use Magento\Sales\Model\OrderFactory;
use Magento\Sales\Api\OrderRepositoryInterface;
use Magento\Sales\Api\Data\OrderExtensionFactory;
use Magento\Sales\Api\Data\OrderInterface;

class AddDeliveryDateAttribute
{
    /**
     * @var OrderFactory
     */
    private $orderFactory;

    /**
     * @var OrderExtensionFactory
     */
    private $orderExtensionFactory;

    /**
     * @param OrderExtensionFactory $extensionFactory
     * @param OrderFactory $orderFactory
     */
    public function __construct(
        OrderExtensionFactory $extensionFactory,
        OrderFactory $orderFactory
    ) {
        $this->orderExtensionFactory = $extensionFactory;
        $this->orderFactory = $orderFactory;
    }

    /**
     * @param OrderRepositoryInterface $subject
     * @param OrderSearchResultInterface $searchResult
     * @return OrderSearchResultInterface
     */
    public function setMyCustomOrderAttributeData(OrderInterface $order)
    {
        if ($order instanceof \Magento\Sales\Model\Order) {
            $myCustomOrderAttribute = $order->getDeliveryDate();
        } else {
            $orderModel = $this->orderFactory->create();
            $orderModel->load($order->getId());
            $myCustomOrderAttribute = $orderModel->getDeliveryDate();
        }

        $extensionAttributes = $order->getExtensionAttributes();
        $orderExtensionAttributes = $extensionAttributes ? $extensionAttributes
            : $this->orderExtensionFactory->create();

        $orderExtensionAttributes->setDeliveryDate($myCustomOrderAttribute);

        $order->setExtensionAttributes($orderExtensionAttributes);
    }

    /**
     * @param OrderRepositoryInterface $subject
     * @param OrderSearchResultInterface $searchResult
     * @return OrderSearchResultInterface
     */
    public function afterGetList(
        OrderRepositoryInterface $subject,
        OrderSearchResultInterface $orderSearchResult
    ) {
        foreach ($orderSearchResult->getItems() as $order) {
            $this->setMyCustomOrderAttributeData($order);
        }
        return $orderSearchResult;
    }

    /**
     * @param OrderRepositoryInterface $subject
     * @param OrderInterface $order
     * @return OrderInterface
     */
    public function afterGet(
        OrderRepositoryInterface $subject,
        OrderInterface $resultOrder
    ) {
        $this->setMyCustomOrderAttributeData($resultOrder);
        return $resultOrder;
    }
}

The order attribute will be shown via the API call <URL>/rest/default/V1/orders/<order_id>

'delivery_date' attribute value will be displayed

Write content to file in Magento2

Paboda Hettiarachchi — Thu, 13 Jun 2024 04:49:33 +0000

$om = \Magento\Framework\App\ObjectManager::getInstance();
$filesystem = $om->get('Magento\Framework\Filesystem');
$directoryList = $om->get('Magento\Framework\App\Filesystem\DirectoryList');
$varDirectory = $filesystem->getDirectoryWrite($directoryList::VAR_DIR);
$varPath = $directoryList->getPath('var');
$fileName = 'demo.txt';
$path = $varPath . '/custom/' . $fileName;
$error = [];
$contents = print_r($error, true);
$varDirectory->writeFile($path, $contents);

ViewModel

Paboda Hettiarachchi — Sat, 24 Jun 2023 13:32:05 +0000

<type name="Magento\Contact\Plugin\UserDataProvider\ViewModel">
        <arguments>
            <argument name="viewModel" xsi:type="object">Magento\Contact\ViewModel\UserDataProvider</argument>
        </arguments>
    </type>
    <type name="Magento\Contact\Block\ContactForm">
        <plugin name="set_view_model" type="Magento\Contact\Plugin\UserDataProvider\ViewModel" />
    </type>

Check if customer is logged in / customer group

Paboda Hettiarachchi — Sat, 24 Jun 2023 13:22:22 +0000

This is in reference to Magento 2.4.6 2.\Magento\Customer\Model\Session does not work on product detail page
Say you have a viewModel where you need to check if the customer is logged in or not.
If vendor/magento/module-customer/Model/Layout/DepersonalizePlugin.php is executed before your viewModel it is most likely that the session details are reset.
Best option is to use

protected $httpContext;

public function __construct(
    \Magento\Framework\View\Element\Template\Context $context,
    \Magento\Framework\App\Http\Context $httpContext,
    array $data = []
) {
    $this->httpContext = $httpContext;
    parent::__construct($context, $data);
}

public function getCustomerIsLoggedIn()
{
    return (bool)$this->httpContext->getValue(\Magento\Customer\Model\Context::CONTEXT_AUTH);
}

Saleable

Paboda Hettiarachchi — Wed, 21 Jun 2023 02:17:15 +0000

bin/magento q:c:s inventory.reservations.updateSalabilityStatus

Plugin- set additonal options

Paboda Hettiarachchi — Mon, 12 Jun 2023 16:35:11 +0000

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
    <type name="Magento\Quote\Model\Quote\Item\ToOrderItem">
        <plugin name="unique_name" type="Vendor\ModuleName\Plugin\ToOrderItem" sortOrder="1" />
    </type>
</config>

<?php
namespace Vendor\ModuleName\Plugin;
use Magento\Quote\Model\Quote\Item\ToOrderItem as QuoteToOrderItem;
class ToOrderItem
{
    /**
     * aroundConvert
     *
     * @param QuoteToOrderItem $subject
     * @param \Closure $proceed
     * @param \Magento\Quote\Model\Quote\Item $item
     * @param array $data
     *
     * @return \Magento\Sales\Model\Order\Item
     */
    public function aroundConvert(
        QuoteToOrderItem $subject,
        \Closure $proceed,
        $item,
        $data = []
    ) {
        // Get Order Item
        $orderItem = $proceed($item, $data);
        // Get Quote Item's additional Options
        $additionalOptions = $item->getOptionByCode('additional_options');
        // Check if there is any additional options in Quote Item
        if ($additionalOptions->getValue()) {
            // Get Order Item's other options
            $options = $orderItem->getProductOptions();
            // Set additional options to Order Item
            $options['additional_options'] = json_decode($additionalOptions->getValue());
            $orderItem->setProductOptions($options);
        }
        return $orderItem;
    }
}

Patch module

Paboda Hettiarachchi — Tue, 09 May 2023 07:52:30 +0000

Add the following in composer.json

"repo": { "type": "composer", "url": "https://repo.magento.com" }

"scripts": { "post-install-cmd": [ "@applyPatches" ], "post-update-cmd": [ "@applyPatches" ], "applyPatches": "@php vendor/bin/ece-patches apply -n --ansi" },

Install the module composer require magento/magento-cloud-patches

Multiple depends in system.xml - Magento 2

Paboda Hettiarachchi — Fri, 11 Nov 2022 18:30:39 +0000

Options being 1 OR 2
<field id="integration" separator=",">1,2</field>

Using setTemplate to change a template file in layout

Paboda Hettiarachchi — Fri, 02 Sep 2022 04:21:07 +0000

If a phtml file includes $block->getChildHtml, sub blocks are being defined in layout files. It will be too risky to redefine a set of blocks using referenceBlock tag.

<referenceBlock name="header-content"> <action method="setTemplate"> <argument name="template" xsi:type="string">Paboda_Sample::html/header.phtml</argument> </action> </referenceBlock>

Adding a static block in checkout

Paboda Hettiarachchi — Sat, 29 Jan 2022 14:13:03 +0000

Create a CMS block with identifier set as "cms_block_identifier_notice"
In Vendor\Checkout\etc\frontend\di.xml

<type name="Magento\Checkout\Model\CompositeConfigProvider">
        <arguments>
            <argument name="configProviders" xsi:type="array">
                <item name="vendor_show_notice" xsi:type="object">Vendor\Checkout\Model\ConfigProvider</item>
            </argument>
        </arguments>
    </type>
<type name="Vendor\Checkout\Model\ConfigProvider">
        <arguments>
            <argument name="blockIdShowNotice" xsi:type="string">cms_block_identifier_notice</argument>
        </arguments>
    </type>

In a Vendor/Checkout/Model/ConfigProvider.php

<?php
namespace Vendor\Checkout\Model;

use Magento\Framework\View\LayoutInterface;

class ConfigProvider implements ConfigProviderInterface
{
    /** @var LayoutInterface  */
    private $layout;

    /**
     * @var string
     */
    private $cmsBlock;

    /**
     * @param LayoutInterface $layout
     * @param $blockIdShowNotice
     */
    public function __construct (
        LayoutInterface $layout,
        $blockIdShowNotice
    ) {
        $this->layout = $layout;
        $this->cmsBlockNotice = $this->constructBlock($blockIdShowNotice);
    }

    /**
     * Get block data
     *
     * @param $blockId
     * @return mixed
     */
    public function constructBlock($blockId)
    {
        return $this->layout->createBlock('Magento\Cms\Block\Block')
            ->setBlockId($blockId)->toHtml();
    }

    /**
     * Pass config values to checkout
     *
     * @return array
     * @throws \Magento\Framework\Exception\LocalizedException
     * @throws \Magento\Framework\Exception\NoSuchEntityException
     */
    public function getConfig()
    {
        $config = [];
        $config['cms_block_notice'] = $this->cmsBlockNotice;
        return $config;
    }
}

In your .html file and the content will be displayed

<div data-bind="html: window.checkoutConfig.cms_block_notice"></div>