How to debug cli command in magento 2

Steps:

1) Export the key (if you are using docker, do it in container)

export XDEBUG_CONFIG='PHPSTORM'
export PHP_IDE_CONFIG="serverName=vasan.dev.local.com"

2) Start the phpstorm Bug Debug

3) Execute the cli command

XDEBUG_SESSION_START=PHPSTORM php bin/magento vasan:product:import

This can be fixed by excuting folloing configuration.

./bin/magento config:set system/security/max_session_size_admin 512000
./bin/magento config:set system/security/max_session_size_storefront 512000

How to add di.xml configuration for simplet grid.

<!-- City listing definitions -->

    <virtualType name="Kemana\Directory\Model\ResourceModel\City\Grid\Collection" type="Magento\Framework\View\Element\UiComponent\DataProvider\SearchResult">
        <arguments>
            <argument name="mainTable" xsi:type="string">kemana_directory_city</argument>
            <argument name="resourceModel" xsi:type="string">Kemana\Directory\Model\ResourceModel\City</argument>
        </arguments>
    </virtualType>

    <type name="Magento\Framewor...

Virtual Classes

The Virtual classes are not created physically with all features but it will be created by dependency injection file in magento 2.

Developers define these classes in di.xml when they want to use the existing classes with argument replacement to create additonal functionality without chaning the original class.

<virtualType name="MilestoneRepositoryExtended" type="Vasan\Training\Model\MilestoneRepository">
        <arguments>
            <argument name="milestoneManagement" xsi:type="object">Vasan\Training\Model\M...

Step 1:

Create system.xml file with configuration field.

<group id="cron" translate="label" type="text" sortOrder="20" showInDefault="1" showInWebsite="1"
                   showInStore="1">
                <label>MSD Cron</label>
                <field id="schedule" translate="Schedule" type="text" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
                    <label>Schedule</label>
                </field>
            </group>

Step 2 :

Create crontab.xml content

<group id="...

use Magento\Framework\Intl\DateTimeFactory;
=====================================
$endDate = $this->dateTimeFactory
            ->create($milestone->getData('end_date'), new \DateTimeZone('UTC'))->format('d/m/Y');
  ========================================          
            
 $collection = $this->collectionFactory->create();
        $gracePeriod = (int)$this->scopeConfig
            ->getValue(self::XML_PATH_GRACE_PERIOD, ScopeInterface::SCOPE_STORE, null);
        $interval = 'P' . $gracePeriod . 'D';
        $date = $this->dateTim...

The API funcational testing can be implemented using following steps

First Step : Develop your API

Second Step : Write the API Test class

Eg:

<?php
/**
 * OrganisationRepositoryTest
 *
 * @copyright Copyright © 2023 Vasan. All rights reserved.
 * @author    psureshvasan@yahoo.com
 */

namespace Vasan\Organisation\Test\Api;


use Magento\TestFramework\TestCase\WebapiAbstract;
use Vasan\Organisation\Model\ResourceModel\OrganisationRepository;
use Magento\Customer\Model\ResourceModel\CustomerRepository;
use Magento\TestFramework\Helper\...

How to create order programmatically other than the basic currency?

Step 1) After create your Quote object set the currency code that you want in the order

$quote = $this->quoteFactory->create();
$store = $order->getStore();
$store->setCurrentCurrencyCode($order->getOrderCurrencyCode()); // Eg: AUD|GRB
$quote->setStore($store);

Step 2) Set again before add the product to Quote

$store-...

Custom Sqls

To insert records to tracking table, fetch the data from custom table as array

$tableName = $this->connection->getTableName(self::SHIPMENT_TABLE);
        $jointTableName = $this->connection->getTableName(self::TABLE);

        $sql = $this->connection->select()->from(
                ['ss' => $tableName],
                [
                    'parent_id' => 'ss.entity_id',
                    'order_id' => 'ss.order_id'
                ]
            )->joinLeft(
                ['kst' => $jointTableName],
            '...

How to show a field dependent on another field multiple values

<depends>
                        <field id="vasan/general/enable">1</field>
                        <field id="vasan/email_dispatch/receiver" separator=",">2,3</field>
                    </depends>

How to install a excel lib to generate formatted excel file

Step 1) Go to the magento 2 root folder then execute following command

sudo -uwww-data composer require phpoffice/phpspreadsheet

How to create a Mutation with single input and output

The class file

class CreateSplitOrders implements ResolverInterface {


    /**
     * @param Field $field
     * @param $context
     * @param ResolveInfo $info
     * @param array|null $value
     * @param array|null $args
     * @return \Magento\Framework\GraphQl\Query\Resolver\Value|mixed
     * @throws GraphQlAuthorizationException
     * @throws GraphQlInputException
     */
    public function resolve (Field $field, $context, ResolveInfo $info, array $value = null, ar...

How to create a query with single input and output

Following graphql is defined schema.graphqls with Integer input and String output

type Query {
      testing(id: Int!): String @resolver(class: "Vasan\\TesterGraphQl\\Model\\Resolver\\Testing")
}

The Testing Resolver Class

class Testing implements ResolverInterface {


    /**
     * @param Field $field
     * @param \Magento\Framework\GraphQl\Query\Resolver\ContextInterface $context
     * @param ResolveInfo $info
     * @param array|null $value
     * @param array|nul...

How to set a custom value to the field and make it disable

This requirement can be achieved using DataProvider class of the UI form component

/**
     * @inheritdoc
     */
    public function getMeta()
    {
        $meta = parent::getMeta();
        $meta['general']['children']['version']['arguments']['data']['config']['disabled'] = true;

        /** @var \Vasan\Bidding\Model\ResourceModel\Term\Collection $termCollection */
        $termCollection = $this->collectionFactory->create();
        $termCollection->addOrder('id', 'DE...

Adding searchable drop-down

Simply following steps to add searchable drop-down ui component in a form

1. Add element in form xml

<field name="rateselection" component="Vasan_Bidding/js/form/components/rate-select" formElement="select">
                    <argument name="data" xsi:type="array">
                        <item name="config" xsi:type="array">
                            <item name="filterOptions" xsi:type="boolean">true</item>
                            <item name="multiple" xsi:type="boolean">false</item>
 ...

Searchable drop-down component with Jquery Plugin

Following example shows the steps to use Select2 Jquery Plugin in Magento 2 admin form.

Stesps :

1. Download the required files from Repository

https://github.com/select2/select2/tree/4.1.0-rc.0

2. Add the required files in magento 2 module

In view/adminhtml/web/js folder

Add the downloaded select2.js in above folder

In view/adminhtml/web/css folder

Add the select2.css file under above folder

In required-config.js

var config = {
    ...

Custom time component

Magento2 time component does not pass the selected time when post the form to controller.
Following custom time component is used to capture the time.

In form xml

<field name="start_time" formElement="input">
            <argument name="data" xsi:type="array">
                <item name="config" xsi:type="array">
                    <item name="source" xsi:type="string">milestone</item>
                </item>
            </argument>
            <settings>
                <elementTmpl>Vasan_Bidding/form/el...

Date columns with date formatting

Following example shows how to use date component in listing

In xml

<column name="due_date" class="Magento\Ui\Component\Listing\Columns\Date">
            <argument name="data" xsi:type="array">
                <item name="config" xsi:type="array">
                    <item name="label" xsi:type="string" translate="true">Due Date</item>
                    <item name="timezone" xsi:type="string">false</item>
                    <item name="dataType" xsi:type="string">date</item>
                 ...

Text box component with suffix

Magento use ui component with suffix in product form for weight.
Following example shows how to use the suffix for a text ui component.

In xml

<field name="duration" formElement="input" component="Vasan_Bidding/js/form/components/duration">
            <argument name="data" xsi:type="array">
                <item name="config" xsi:type="array">
                    <item name="source" xsi:type="string">milestone</item>
                </item>
            </argument>
            <settings>
           ...

Text box component with currency symbol as prefix

In Product Form, Magento uses the text ui component with currency symbol as a prefix for price.
Following example shows how to get the prefix in text component

In form xml

<field name="final_total_text" formElement="input" sortOrder="120" component="Vasan_Bidding/js/form/components/price">
            <settings>
                <elementTmpl>Vasan_Bidding/form/element/currency_text</elementTmpl>
                <label translate="true">Total</label>
                <dataScope>amoun...

Adding dataprovider for listing component with filtering and sorting

Listing component default data provider get all the data from collection.
Sometime we need to do filer and sorting.
Following example shows how to do the filer and sorting of a listing component

class DataProvider extends \Magento\Framework\View\Element\UiComponent\DataProvider\DataProvider
{

    /**
     * @inheritdoc
     */
    public function getData()
    {
        $this->addFilter(
            $this->filterBuilder->setField('proposal_id')->setValue($thi...

Formatting amount column with currency symbol

The prices column can be be formatted to two decimal and currency symbol

Following example shows how to add formatting for a amount column.

/**
     * Prepare Data Source
     *
     * @param array $dataSource
     * @return array
     */
    public function prepareDataSource(array $dataSource)
    {
        if (isset($dataSource['data']['items'])) {
            foreach ($dataSource['data']['items'] as & $item) {
                $currencyCode = null;
                if (!$currencyCode...

Adding Button in listing component as a column

Magento2 provides action columns as selection but sometime we need a button to execute action as per design.
Following example shows how to trigger the existing button event in column button.

/**
     * @param array $dataSource
     *
     * @return array
     */
    public function prepareDataSource(array $dataSource)
    {
        if (isset($dataSource['data']['items'])) {
            foreach ($dataSource['data']['items'] as & $item) {
                $name = $this->getData('name')...

This section contains the edit UI components and layout xml files

Stesps :

1. Form ui components

create a file kpsaddress_index_lising.xml for grid under ui_component

<?xml version="1.0" encoding="UTF-8"?>
<listing xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Ui:etc/ui_configuration.xsd">
    <argument name="data" xsi:type="array">
        <item name="js_config" xsi:type="array">
            <item name="provider" xsi:type="string">kpsaddressindex_lis...