How to Setup and Upgrade Database in Magento 2

How to Setup and Upgrade Database in Magento 2

by | Feb 2, 2021 | Magento2


Deprecated: pathinfo(): Passing null to parameter #1 ($path) of type string is deprecated in /var/www/html/wp-content/plugins/urvanov-syntax-highlighter/class-urvanov-syntax-highlighter-langs.php on line 86

how to install and upgrade sql script for module in Magento 2. When you install or upgrade a module, you may need to change the database structure or add some new data for current table. To do this, Magento 2 provide you some classes which you can do all of them. Table of content Magento 2 provides some classes in the directory app/code/[Namespace]/[ModuleName]/Setup to create or upgrade database.

  • InstallSchema – setup database structure
  • InstallData – initial the data for database table.
  • UpgradeSchema – upgraded database structure
  • UpgradeData – upgraded (add/remove) data from table.

Functions of these classes will be run when we install or upgrade module by this command line:

1
2
3
 
php bin/magento setup:upgrade
 

Elaborating each step,

  1. Install Schema
    Create file: app/code/Cozmot/HelloWorld/Setup/InstallSchema.php

1
2
3
 
<?php namespace MagestoreDataExampleSetup; use MagentoFrameworkSetupSchemaSetupInterface; use MagentoFrameworkSetupModuleContextInterface; use MagentoFrameworkSetupInstallSchemaInterface; class InstallSchema implements InstallSchemaInterface { public function install(SchemaSetupInterface $setup,ModuleContextInterface $context) { $installer = $setup; $installer->startSetup(); $table = $installer->getConnection()->newTable($installer->getTable('data_example')) ->addColumn('example_id',MagentoFrameworkDbDdlTable::TYPE_INTEGER,null, ['identity' => true, 'nullable' => false, 'primary' => true, 'unsigned' => true], 'Example Id') ->addColumn('title',MagentoFrameworkDbDdlTable::TYPE_TEXT,255, ['nullable' => false], 'Example Title') ->addColumn('content',MagentoFrameworkDbDdlTable::TYPE_TEXT,'2M', [], 'Example Content') ->addColumn('created_at',MagentoFrameworkDbDdlTable::TYPE_TIMESTAMP,null, ['nullable'=>false,'default'=>MagentoFrameworkDbDdlTable::TIMESTAMP_INIT], 'Created At'); $installer->getConnection()->createTable($table); $installer->endSetup(); } }
 

In this file, we created a table with name “data_example” with four columns: example_id, title, content, created_at with data types are integer, varchar, text, timestamp
You can review all data types in this file: MagentoFrameworkDbDdlTable.php

2. Install Data
File: app/code/Cozmot/HelloWorld/Setup/InstallData.php

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
 
<?php
namespace MeetanshiHelloWorldSetup;
use MagentoFrameworkSetupInstallDataInterface;
use MagentoFrameworkSetupModuleContextInterface;
use MagentoFrameworkSetupModuleDataSetupInterface;
class InstallData implements InstallDataInterface
{
    protected $_exampleFactory;
    public function __construct(CozmotHelloWorldModelExampleFactory $exampleFactory)
    {
        $this->_exampleFactory = $exampleFactory;
    }
    public function install(ModuleDataSetupInterface $setup, ModuleContextInterface $context)
    {
        $data = ['title' => "First example title",'content' => "First Example content"];
        $example = $this->_exampleFactory->create();
        $example->addData($data)->save();
    }
}
 

Here,  we insert a row with value for “title” and “content” columns to data_example table.

3. Upgrade Schema
File: app/code/ Cozmot/HelloWorld/Setup/UpgradeSchema.php

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
 
<?php
namespace CozmotHelloWorldSetup;
use MagentoFrameworkSetupUpgradeSchemaInterface;
use MagentoFrameworkSetupSchemaSetupInterface;
use MagentoFrameworkSetupModuleContextInterface;
class UpgradeSchema implements UpgradeSchemaInterface
{
    public function upgrade(SchemaSetupInterface $setup, ModuleContextInterface $context)
    {
        $installer = $setup;
        $installer->startSetup();
        if (version_compare($context->getVersion(), '1.0.1', '<'))
        {
            $installer->getConnection()->dropColumn($installer->getTable('data_example'), 'created_at');
        }
        $installer->endSetup();
    }
}
 

Here, note that we have to check module version in upgrade function. In this example, we upgraded module from version 1.0.0 to 1.0.1. Drop created_at column from the data_example table.

4. Upgrade Data
File: app/code/ Cozmot/HelloWorld/Setup/UpgradeData.php

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
 
<?php
namespace CozmotHelloWorldSetup;
use MagentoFrameworkSetupUpgradeDataInterface;
use MagentoFrameworkSetupModuleDataSetupInterface;
use MagentoFrameworkSetupModuleContextInterface;
class UpgradeData implements UpgradeDataInterface
{
    protected $_exampleFactory;
    public function __construct(CozmotHelloWorldModelExampleFactory $exampleFactory)
    {
        $this->_exampleFactory = $exampleFactory;
    }
    public function upgrade(ModuleDataSetupInterface $setup, ModuleContextInterface $context)
    {
        if (version_compare($context->getVersion(), '1.0.1', '<'))
        {
            $data = ['title' => "The second example title", 'content' => "The second example content"];
            $example = $this->_exampleFactory->create();
            $example > addData($dalogta)->save();
        }
    }
}
 

]]>

How to Setup and Upgrade Database in Magento 2

Add Custom Category Attribute Magento2 Extension Free

by | Jan 13, 2021 | Extensions, Magento2, MagentoB2B

USER GUIDE

  1. How to Register Module in Magento 2
  2. Tell Magento Which Extesions to Be Included
  3. Register Attribute in our Core
  4. Add Code for showing Attribute to set value from Admin Dashboard  

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
 
<?php
/*
* Company Name: Cozmot Inc
* Website: https://cozmot.com
* Writer Name: Zaheer Ahmed
* Number: +92-301-1000201
* Copyright: MIT Licence(Open to edit)
*/
?>
<?php
\Magento\Framework\Component\ComponentRegistrar::register(
    \Magento\Framework\Component\ComponentRegistrar::MODULE,
    'Cozmot_CategoryAttribute',
    __DIR__
);
 

After Registering Tell Magento to Load Our Extension

1
2
3
4
5
6
7
 
<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
    <module name="Cozmot_CategoryAttribute" setup_version="1.0.0">
    </module>
</config>
 

Not it’s time to Implement Logic, Here are we Registering our Attribute for Category which will be Boolean Formed.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
<?php
/*
* Company Name: Cozmot Inc
* Website: https://cozmot.com
* Writer Name: Zaheer Ahmed
* Number: +92-301-1000201
* Copyright: MIT Licence(Open to edit)
*/
?>
<?php
namespace Cozmot\CategoryAttribute\Setup;
use Magento\Framework\Setup\{
    ModuleContextInterface,
    ModuleDataSetupInterface,
    InstallDataInterface
};
 
use Magento\Eav\Setup\EavSetup;
use Magento\Eav\Setup\EavSetupFactory;
 
class InstallData implements InstallDataInterface
{
    private $eavSetupFactory;
 
    public function __construct(EavSetupFactory $eavSetupFactory) {
        $this->eavSetupFactory = $eavSetupFactory;
    }
 
    public function install(ModuleDataSetupInterface $setup, ModuleContextInterface $context)
    {
        $eavSetup = $this->eavSetupFactory->create(['setup' => $setup]);
        $eavSetup->addAttribute(\Magento\Catalog\Model\Category::ENTITY, 'cozmotmobilemenu', [
            'type'     => 'int',
            'label'    => 'Cozmot Category Attribute',
            'input'    => 'boolean',
            'source'   => 'Magento\Eav\Model\Entity\Attribute\Source\Boolean',
            'visible'  => true,
            'default'  => '0',
            'required' => false,
            'global'   => \Magento\Eav\Model\Entity\Attribute\ScopedAttributeInterface::SCOPE_STORE,
            'group'    => 'Display Settings',
        ]);
    }
}
 

Now we have to add Admin side option in Category options to set value of our Attribute.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
<!--
* Company Name: Cozmot Inc
* Website: https://cozmot.com
* Writer Name: Zaheer Ahmed
* Contact: zaheercena@gmail.com
* Number: +92-301-1000201
* Copyright: MIT Licence(Open to edit)
-->
<?xml version="1.0"?>
<form xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Ui:etc/ui_configuration.xsd">
    <fieldset name="display_settings">
        <field name="cozmotmobilemenu">
            <argument name="data" xsi:type="array">
                <item name="config" xsi:type="array">
                    <item name="dataType" xsi:type="string">boolean</item>
                    <item name="formElement" xsi:type="string">checkbox</item>
                    <item name="label" xsi:type="string" translate="true">Cozmot Category Attribute</item>
                    <item name="prefer" xsi:type="string">toggle</item>
                    <item name="valueMap" xsi:type="array">
                        <item name="true" xsi:type="string">1</item>
                        <item name="false" xsi:type="string">0</item>
                    </item>
                    <item name="default" xsi:type="number">0</item>
                </item>
            </argument>
        </field>
    </fieldset>
</form>
 

Hurrayyyy… That’s all needed Now run Following commands according to your Installation.

1
2
3
4
 
php bin/magento setup:upgrade
php bin/magento c:c
 

]]>

How to Setup and Upgrade Database in Magento 2

How to Create Barcode in Magento 2 Invoice PDF

by | Dec 17, 2020 | Extensions, Magento2

Magento 2 facilitates the merchants to provide multiple things in invoice PDFs like order id, customer name, shipping address, product name, product quantity, product price, total amount, and so on.

However, depending on the business requirements, customization in invoice PDF can be done.

One such customization solution is offered in this post to create barcode and add it in Magento 2 invoice PDF.

Barcode in invoice PDF helps the customer to scan and get the order id using which it is easy to get order details.

Steps to Create Barcode and Add it in Magento 2 PDF Invoice

1. Create di.xml file at Vendor\Extension\etc

Create di.xml file at Vendor\Extension\etc
1
2
3
4
5
6
7
8
 
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
    <type name="Magento\Sales\Model\Order\Pdf\Invoice">
        <plugin name="barcodes" type="Vendor\Extension\Plugin\Invoice" sortOrder="10"/>
    </type>
</config>
 

 

2. Create Invoice.php file in Vendor\Extension\Plugin\Invoice.php

Create Invoice.php file in Vendor\Extension\Plugin\Invoice.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
namespace Vendor\Extension\Plugin;
 
use Magento\Framework\App\Config\ScopeConfigInterface;
use \Zend\Barcode\Barcode;
 
class Invoice
{
    const XML_PATH_BARCODES_ENABLED = 'barcodes/general/eb_barcodes_active';
    private $scopeConfig;
 
    public function __construct(ScopeConfigInterface $scopeConfig)
    {
        $this->scopeConfig = $scopeConfig;
    }
 
    public function beforeInsertDocumentNumber($subject, $page, $text)
    {
        $config = new \Zend_Config([
            'barcode' => 'code128',
            'barcodeParams' => [
                'text' => $this->getInvoiceNumber($text),
                'drawText' => true
            ],
            'renderer' => 'image',
            'rendererParams' => ['imageType' => 'png']
        ]);
 
        $barcodeResource = Barcode::factory($config)->draw();
        ob_start();
        imagepng($barcodeResource);
        $barcodeImage = ob_get_clean();
        $image = new \Zend_Pdf_Resource_Image_Png('data:image/png;base64,' . base64_encode($barcodeImage));
        if ($image) {
            $docHeader = $subject->getDocHeaderCoordinates();
            $page->drawImage($image, $docHeader[2] - 130, $docHeader[1] + 2, $docHeader[2] + 8, $docHeader[1] + 35);
        }
    }
 
    protected function getInvoiceNumber($text)
    {
        $array_of_words = explode("#", $text);
        return $array_of_words[1];
    }
}
 

Done! That’s what you need to do.

 

For Details Visit Cozmot.com 

Follow us on Facebook and visit Our Blog]]>

How to get Product Grid by Category ID Magento2

How to get Product Grid by Category ID Magento2

by | Nov 26, 2020 | Magento2

Another solution if you only wanna fetch Products 

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
 
$objectManager =  \Magento\Framework\App\ObjectManager::getInstance();
$categoryFactory = $objectManager->get('\Magento\Catalog\Model\CategoryFactory');
$categoryId = 4; // could be any of yours
$category = $categoryFactory->create()->load($categoryId);
 
$categoryProducts = $category->getProductCollection()
    ->addAttributeToSelect('*');
 
foreach ($categoryProducts as $product) {
    // geting Product object
    print_r($product->getData());
 
    echo $product->getName();
    echo $product->getProductUrl();
}
 

Object Manager Usage Good and Bad: ]]>

Category Products Widget Extension Free with Custom Filters Magento2

by | Nov 26, 2020 | Extensions, Magento2

USER GUIDE

  1. How to Register Module in Magento 2
  2. Tell Magento Which Extesions to Be Included
  3. Create Over Meta Title Remove Class  

registration.php
PHP
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
 
<?php
/*
* Company Name: Cozmot Inc
* Website: https://cozmot.com
* Writer Name: Zaheer Ahmed
* Number: +92-301-1000201
* Copyright: MIT Licence(Open to edit)
*/
?>
<?php
\Magento\Framework\Component\ComponentRegistrar::register(
    \Magento\Framework\Component\ComponentRegistrar::MODULE,
    'Cozmot_CategoryWidget',
    __DIR__
);
 

After Registering Tell Magento Which Extesions to Be Included

module.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
 
<?xml version="1.0" ?>
        <!--/*
        * Company Name: Cozmot Inc
        * Website: https://cozmot.com
        * Writer Name: Zaheer Ahmed
        * Contact: [email protected]
        * Number: +92-301-1000201
        * Copyright: MIT Licence(Open to edit)
        */-->
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
    <module name="Cozmot_CategoryWidget"/>
</config>
 

Now Module Registered so Try adding Widget XML Structure

widget.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
<?xml version="1.0" encoding="UTF-8"?>
<!--/*
* Company Name: Cozmot Inc
* Website: https://cozmot.com
* Writer Name: Zaheer Ahmed
* Number: +92-301-1000201
* Copyright: MIT Licence(Open to edit)
*/-->
<widgets xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Widget:etc/widget.xsd">
    <widget id="catalog_category_list"
            class="Cozmot\CategoryWidget\Block\Category\Widget\CategoryList">
        <label translate="true">New Cozmot Category Listing Widget</label>
        <description translate="true">Category Grid</description>
        <parameters>
            <parameter name="title" sort_order="10" visible="true" xsi:type="text">
                <label>Section Heading</label>
            </parameter>
            <parameter name="filter-selection" xsi:type="select" visible="true">
                <label translate="true">Select Filter(optional)</label>
                <options>
                    <option name="most" value="0" selected="true">
                        <label translate="true">New Arrivals</label>
                    </option>
                    <option name="sale" value="1">
                        <label translate="true">Sale</label>
                    </option>
                    <option name="featured" value="2">
                        <label translate="true">Featured</label>
                    </option>
                </options>
            </parameter>
            <parameter name="page_size" xsi:type="text" required="true" visible="true">
                <label translate="true">Number of Category to display</label>
                <value>5</value>
            </parameter>
            <parameter name="condition" xsi:type="conditions" visible="true" required="true" sort_order="10"
                       class="Magento\CatalogWidget\Block\Product\Widget\Conditions">
                <label translate="true">Conditions</label>
            </parameter>
            <parameter name="template" xsi:type="select" required="true" visible="true">
                <label>Template</label>
                <options>
                    <option name="grid" value="category/widget/grid.phtml" selected="true">
                        <label translate="true">Category Grid Template</label>
                    </option>
                    <option name="sidebar" value="category/widget/sidebar.phtml">
                        <label translate="true">Category Sidebar Template</label>
                    </option>
                </options>
            </parameter>
 
 
 
            <parameter name="chart_layout" xsi:type="select" visible="true">
                <label translate="true">Show in Slider</label>
                <options>
                    <option name="yes" value="1" selected="true">
                        <label translate="true">Yes</label>
                    </option>
                    <option name="no" value="0">
                        <label translate="true">No</label>
                    </option>
                </options>
            </parameter>
 
 
        </parameters>
        <containers>
            <container name="sidebar.main">
                <template name="default" value="sidebar" />
            </container>
            <container name="content">
                <template name="grid" value="grid" />
                <template name="list" value="list" />
            </container>
            <container name="sidebar.additional">
                <template name="default" value="sidebar" />
            </container>
        </containers>
    </widget>
</widgets>
 

Since we added all essential files so you better download and install Our Module to run featue out of Box Here is link to Widget Page [button link="https://cozmot.com/category-products-widget-with-custom-filters-magento-2/" type="big"] Link text[/button]  ]]>