DEV Community: Anuradha Fernando

Preventing Category URL from the product page in Magento2

Anuradha Fernando — Thu, 17 Dec 2020 15:17:25 +0000

Magento is providing the best tool for managing the product URLs which is the URL Rewrite mechanism. It enables to convert the product URLs to more readable when visitors access the Target URLs.

eg:
Target URL
/catalog/product/view/id/21

Request URL
/mens/this-is-a-nic-url.html

So using both types of URLs will result the same product page in the frontend. Sometimes you might need to prevent accessing one URL type,

eg: if you need to prevent access to the Target URL but allows the Request URL, we can handle that scenario as follows.

I've created a sample module for this.

Directory Structure

Vendor
-Module Name
--etc
--Observer
--registration.php

First Create the module.xml and registration.php

Inside the etc, create a directory frontend and create a file events.xml

events.xml

<?xml version="1.0"?>
<!--
/**
 * Copyright (c)
 */
-->
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
    <event name="controller_action_predispatch_catalog_product_view">
        <observer name="vendor_predispatch" instance="Vendor\Module\Observer\PreDispatch" />
    </event>
</config>

Create a directory Observer in the module root. Create a file inside the Observer directory PreDispatch.php

PreDispatch.php

<?php
/**
 * Copyright (c)
 */

namespace Vendor\Module\Observer;

use Magento\Framework\App\Request\Http;
use Magento\Framework\App\ResponseInterface;
use Magento\Framework\Event\Observer;
use Magento\Framework\Event\ObserverInterface;
use Magento\Framework\UrlInterface;
use Magento\Framework\View\Context;

class PreDispatch implements ObserverInterface
{
    /**
     * Uri value to be checked with
     */
    const NEEDLE = '/catalog/';

    /**
     * @var ResponseInterface
     */
    private $response;

    /**
     * @var Context
     */
    private $context;

    /**
     * @var Http
     */
    private $http;

    /**
     * @var UrlInterface
     */
    private $url;

    /**
     * CatalogCategoryViewPostDispatch constructor.
     *
     * @param ResponseInterface $response
     * @param Context $context
     * @param Http $http
     * @param UrlInterface $url
     */
    public function __construct(
        ResponseInterface $response,
        Context $context,
        Http $http,
        UrlInterface $url
    ) {
        $this->response = $response;
        $this->context = $context;
        $this->http = $http;
        $this->url = $url;
    }

    /**
     * @param Observer $observer
     */
    public function execute(Observer $observer)
    {
        if (substr($this->http->getRequestUri(), 0, 9) === self::NEEDLE) {
            $customerBeforeAuthUrl = $this->url->getUrl('noroute');
            $this->response->setRedirect($customerBeforeAuthUrl)
            ->sendResponse();
        }
    }
}

Cheers!

Add a new customized column to the grid...

Anuradha Fernando — Tue, 08 Dec 2020 12:53:40 +0000

You might need to add a custom column to the admin sales_order_grid. Please follow the below steps.

I've created a sample module for this. The module will be having the below file structure.

app/code/Vendor/Module/registration.php
app/code/Vendor/Module/etc/module.xml
app/code/Vendor/Module/view/adminhtml/ui_component/sales_order_grid.xml
app/code/Vendor/Module/view/adminhtml/web/js/ui/grid/cells/custom-column.js

In order to customize the 'custom-column' we should add some files to the app/design/adminhtml.

app/design/adminhtml/Vendor/backend/Magento_Sales/layout/sales_order_index.xml
app/design/adminhtml/Vendor/backend/Magento_Sales/ui_component/sales_order_grid.xml
app/design/adminhtml/Vendor/backend/Magento_Sales/web/css/custom-column.css

I'm not explaining the module creation as you all know about that part. Therefore let's take a look at the other main files such as Vendor_Module/view/adminhtml/ui_component/sales_order_grid.xml
Vendor_Module/view/adminhtml/web/js/ui/grid/cells/custom-column.js

sales_order_grid.xml

<?xml version="1.0" encoding="UTF-8"?>
<!--
/**
 * Copyright (c)
 * See COPYING.txt for license details.
 */
-->
<listing 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Ui:etc/ui_configuration.xsd">
    <columns name="sales_order_columns">
        <column name="custom_column">
            <argument name="data" xsi:type="array">
                <item name="config" xsi:type="array">
                    <item name="sortable" xsi:type="boolean">false</item>
                    <item name="has_preview" xsi:type="string">1</item>
                    <item name="label" 
xsi:type="string" translate="true">Custom Column</item>
                </item>
            </argument>
        </column>
    </columns>
</listing>

custom-column.js

/**
 * Copyright (c)
 * See COPYING.txt for license details.
 */

define([
    'underscore',
    'knockout',
    'Magento_Ui/js/grid/columns/select'
], function (_, ko, Select) {
    'use strict';
    return Select.extend({
        getFieldClass: function (row) {
            var computed;
            computed = ko.pureComputed(function () {
                //ADD  YOUR CODE SNIPPET HERE
                }          
            }, this);
            return computed;
        }
    });
});

Now let's take a practical scenario.
eg: Showing two different colors 'Green' and 'Yellow' in 'Custom Column' based on the below scenarios.

If the 'Grand Total' is greater than or equal to $50.00, the 'Custom Column' color should be 'green'. Else color should be 'Yellow'.

How we can implement this?

Edit the file: app/code/Vendor/Module/view/adminhtml/web/js/ui/grid/cells/custom-column.js

/**
 * Copyright (c)
 * See COPYING.txt for license details.
 */

define([
    'underscore',
    'knockout',
    'Magento_Ui/js/grid/columns/select'
], function (_, ko, Select) {
    'use strict';

    return Select.extend({
        getFieldClass: function (row) {
            var computed;
            computed = ko.pureComputed(function () {
                var grandTotal = row['grand_total'].replace(/\$/g,'');
                var customColCss = {
                    'custom-column-green': ko.observable(
grandTotal >= '50.00'?true:false
),
                    'custom-column-yellow': ko.observable(
grandTotal<'50.00'?true:false
)
                }
                return customColCss;

            }, this);
            return computed;
        }
    });
});

app/design/adminhtml/Vendor/backend/Magento_Sales/layout/sales_order_index.xml

<?xml version="1.0"?>
<!--
/**
 * Copyright (c)
 * See COPYING.txt for license details.
 */
-->
<page 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
    <head>
        <css src="Magento_Sales::css/custom-column.css" />
    </head>
</page>

app/design/adminhtml/Vendor/backend/Magento_Sales/ui_component/sales_order_grid.xml

<?xml version="1.0" encoding="UTF-8"?>
<!--
/**
 * Copyright (c)
 * See COPYING.txt for license details.
 */
-->
<listing 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Ui:etc/ui_configuration.xsd">
    <columns name="sales_order_columns">
        <column name="custom_column" component="Vendor_Module/js/ui/grid/cells/custom-column">
            <argument name="data" xsi:type="array">
                <item name="config" xsi:type="array">
                    <item name="visibleByDefault" xsi:type="boolean">true</item>
                    <item name="sortOrder" xsi:type="number">110</item>
                </item>
            </argument>
        </column>
    </columns>
</listing>

app/design/adminhtml/Vendor/backend/Magento_Sales/web/css/custom-column.css

.custom-column-yellow {
    background: #ffff00 !important;
}

.custom-column-green {
    background: #006400 !important;
}

Output as follows:

Get nearest time slot in the past (in Magento2)

Anuradha Fernando — Sun, 22 Nov 2020 03:54:16 +0000

Let's assume that you have a list of Time Slots generated within the 30 minutes intervals. You need to get the closest time slot in the past based on the current server time.

eg:
Start Time: 14:00
End Time: 18:00
Interval: 30 (minutes)

Output:

Current time: 17:26 (you can get the current server time from the Magento DateTimeFactory)

So the output will be 17:00.
Why? because we have 30minutes intervals in our time list. Therefore according to the current time 17:26 the previous closest time slot is 17:00

How to get the current Date/Time from Magento core

use \Magento\Framework\Stdlib\DateTime\DateTimeFactory;

/**
 * @var DateTimeFactory
*/
protected $dateTimeFactory;

public function __construct(
    DateTimeFactory $dateTimeFactory
)
{
    $this->dateTimeFactory = $dateTimeFactory;
}

public function getClosestTimeSlot()
{
    $dateModel = $this->dateTimeFactory->create();
    $currTime = date('H:i', strtotime($dateModel->gmtDate()));

    $openingTime = '14:00';
    $closingTime = '18:00';
    $interval = 30; //in minutes

    $timeSlots = [];
    //set the intervals based on the $timeSlotLength
    $nextInterval = '+' . $interval . 'minutes';

    $strOpeningTime = strtotime($openingTime);
    $strClosingTime = strtotime($closingTime);

    while ($strOpeningTime <= $strClosingTime) {
       array_push($timeSlots, date('H:i', 
       $strOpeningTime));
       $strOpeningTime = strtotime($nextInterval, $strOpeningTime);
    }  

    //sets the array to be returned with the lowest time slot 
      from time slot array
    $timeArray = [
        'lower '=> min(current($timeSlots), $currTime)
    ];

    //store the closest lower time slot to the $timeArray
    foreach ($timeSlots as $ts) {
        if ($currTime > $ts)
            $timeArray['lower'] = $ts;
    }

    return $timeArray['lower']; //output will be 17:00
}

cheers!!

Adding a custom attribute to a category doesn't show store specific value

Anuradha Fernando — Sun, 01 Nov 2020 18:52:36 +0000

When adding a custom attribute to a category in the admin, Store Scope will not show even though we set the Store View in the setup script.
Vendor/Module/Setup/Patch/Data/AddViewModeCategoryAttribute.php

$eavSetup->addAttribute(
            \Magento\Catalog\Model\Category::ENTITY,
            'attribute_code',
            [
                'type' => 'text',
                'label' => 'ATTRIBUTE LABLE',
                'input' => 'select',
                'sort_order' => 333,
                'source' => 'Vendor\Module\Model\Category\Attribute\Source\NAME',
                'global' => \Magento\Eav\Model\Entity\Attribute\ScopedAttributeInterface::SCOPE_STORE,
                'visible' => true,
                'required' => false,
                'user_defined' => false,
                'default' => 'grid',
                'group' => 'General Information',
                'backend' => ''
            ]
        );

Expected result

Should see [Store View] label under the attribute label.
Should be able to see different values per scope level (global, website, store)

Actual result

Can't see the [Store View] label under the attribute label.
Can't see different values per scope level (global, website, store)
Can see different values in the database

This is a Magento2 bug and not yet fixed in 2.3

As a fix, please use the below code.

Add below code into your module's di.xml

<preference for="Magento\Catalog\Model\Category\DataProvider" type="Vendor\Module\Model\Category\DataProvider" />

In order to add the 'Use Default Value' checkbox for custom attributes, we need to override DataProvider.php. There is a function called 'getFieldsMap'. So after modifying the 'getFieldsMap' function 'DataProvider' class will be as follows.

Vendor/Module/Model/Category/DataProvider.php

namespace Vendor\Module\Model\Category;

use Magento\Catalog\Model\Category\DataProvider as CategoryDataProvider;

class DataProvider extends CategoryDataProvider
{
    protected function getFieldsMap() {
        $parentFieldMap = parent::getFieldsMap();       

        array_push($parentFieldMap['general'], 'attribute_code');
        return $parentFieldMap;
    }
}

replace the 'attribute_code' with the actual attribute code
'general' => section in admin panel form, where attribute is displayed

Run the setup upgrade command and clear the cache. You will be able to set store specific values for custom attributes.

cheers!!

How to pass a parameter from one controller to another in Magento2 Admin form

Anuradha Fernando — Sun, 25 Oct 2020 14:29:28 +0000

Do you want to pass a parameter when clicking the save button in the admin form? It's not just like a hidden value to append to the form URL.

http://www.m235p2.com/admin/module/module/new/order_id/1/key/db2ee099a204cb0d706bf711e49830ef693cb0c763baf306

We are in the edit form and we have "order_id" with us, we are going to pass this order_id to "save controller" when clicking the Save button.

Add GenericButton.php (if not exists).
Vendor/Module/Block/Adminhtml/Module/Edit/GenericButton.php

<?php
/**
 * Copyright © Nose All rights reserved.
 * See LICENSE.txt for license details.
 */
namespace Vendor\Module\Block\Adminhtml\Module\Edit;

use Magento\Backend\Block\Widget\Context;
use Magento\Cms\Api\BlockRepositoryInterface;
use Magento\Framework\Exception\NoSuchEntityException;
use Vendor\Module\Api\Data\ModuleInterface;

abstract class GenericButton
{
    /**
     * @var Context
     */
    protected $context;

    /**
     * @var BlockRepositoryInterface
     */
    protected $blockRepository;

    /**
     * GenericButton constructor.
     * @param Context $context
     */
    public function __construct(
        Context $context,
        BlockRepositoryInterface $blockRepository
    ) {
        $this->context = $context;
        $this->blockRepository = $blockRepository;
    }    

    /**
     * Generate url by route and parameters
     *
     * @param   string $route
     * @param   array $params
     * @return  string
     */
    public function getUrl($route = '', $params = [])
    {
        return $this->context->getUrlBuilder()->getUrl($route, $params);
    }

    /**
     * Get order id from the URL
     *
     * @return mixed
     */
    public function getOrderId()
    {
        try {
            return $this->context->getRequest()->getParam('order_id');
        } catch (NoSuchEntityException $e) {
        }
    }
}

Add SaveButton.php (if not exists)
Vendor/Module/Block/Adminhtml/Module/Edit/SaveButton.php

<?php
/**
 * Copyright © Nose All rights reserved.
 * See LICENSE.txt for license details.
 */
namespace Vendor/Module/Block/Adminhtml/Module/Edit;

use Magento\Backend\Block\Widget\Context;
use Magento\Cms\Api\BlockRepositoryInterface;
use Magento\Framework\View\Element\UiComponent\Control\ButtonProviderInterface;

class SaveButton extends GenericButton implements ButtonProviderInterface
{
    /**
     * Url Builder
     *
     * @var \Magento\Framework\UrlInterface
     */
    protected $urlBuilder;

    /**
     * CustomButton constructor.
     *
     * @param \Magento\Backend\Block\Widget\Context $context
     */
    public function __construct(Context $context, BlockRepositoryInterface $blockRepository)
    {
        $this->urlBuilder = $context->getUrlBuilder();
        parent::__construct($context, $blockRepository);
    }

    /**
     * Set order_id to save button as a parameter
     *  
     * @return array
     */
    public function getButtonData()
    {
        $data = [
            'label' => __('Save'),
            'class' => 'save',
            'on_click' => '',
            'sort_order' => 20,
            'data_attribute' => [
                'mage-init' => [
                    'Magento_Ui/js/form/button-adapter' => [
                        'actions' => [
                            [
                                'targetName' => 'vendor_module_module_form.vendor_module_module_form',
                                'actionName' => 'save',
                                'params' => [
                                    true,
                                    ['order_id' => $this->getOrderId()],
                                ]
                            ]
                        ]
                    ]
                ],

            ]
        ];

        return $data;
    }
}

In Save.php
Vendor/Module/Controller/Adminhtml/Module/Save.php

/**
* Save action
*
* @return \Magento\Framework\Controller\ResultInterface
*/
public function execute()
{
    /** @var \Magento\Backend\Model\View\Result\Redirect $resultRedirect */
    $resultRedirect = $this->resultRedirectFactory->create();
    $data = $this->getRequest()->getParams();
    $orderId = $this->getRequest()->getParam('order_id');

    //continue with the rest of the code

cheers!!