What are Virtual Types in Magento 2?<\/strong><\/p>\n\n\n\n In Magento 2, Virtual Types allows us to modify existing classes without affecting the other classes and without having to create a new class file(it isn’t necessary.<\/p>\n\n\n\n But if we want then we can create it as well), we can use inject these Virtual Types where we need them.<\/p>\n\n\n\n In Magento 2, Virtual Types are like a sub-class for an existing class.<\/p>\n\n\n\n Moreover, there is no need to seek elsewhere; avail yourself of the chance to commence your projects with an endorsed Magento 2 development company<\/a>.<\/p>\n\n\n\n How to use Virtual Types?<\/strong><\/p>\n\n\n\n In Magento 2, we can mention Virtual Types in the di.xml file inside the <magento-root-dir.>\/app\/code\/Vendor\/Module\/etc\/<\/em> directory OR \/vendor\/VendorName\/src\/module-name\/etc\/ <\/em>directory <\/p>\n\n\n\n OR<\/p>\n\n\n\n <magento-root-dir.>\/app\/code\/Vendor\/Module\/etc\/<frontend Or adminhtml><\/em> directory OR \/vendor\/VendorName\/src\/module-name\/etc\/<frontend Or adminhtml> <\/em>directory.<\/p>\n\n\n\n In the di.xml file, we use the tag to add our custom Virtual Type class. [A] name: <\/strong>In this attribute, we set virtualType’s name as value. For better understanding, here I have created a di.xml file and added a Virtual Type class using the <virtualType\/> tag. In the above di.xml, I have used Virtual Types in two ways:<\/p>\n\n\n\n Here, I have created the Employee.php <\/strong>class file <\/strong>placed inside the <magento-root-dir.>\/app\/code\/Vendor\/Module\/Model\/<\/em> directory. I have created CustomVirtualEmployee<\/strong> virtualType for the Employee<\/strong> class.<\/p>\n\n\n\n Now, I have created the CustomVirtualEmployee.php <\/strong>class file <\/strong>placed inside the <magento-root-dir.>\/app\/code\/Vendor\/Module\/Model\/<\/em> directory.<\/p>\n\n\n\n Now, I have created the EmpRecord.php <\/strong>class file <\/strong>placed inside the <magento-root-dir.>\/app\/code\/Vendor\/Module\/Model\/<\/em> directory. For this class, I have created two virtualTypes FirstEmployee<\/strong> and SecondEmployee<\/strong>.<\/p>\n\n\n\n Now, I have created the AllRecords.php <\/strong>class file <\/strong>placed inside the <magento-root-dir.>\/app\/code\/Vendor\/Module\/Model\/<\/em> directory. In this class, I have used virtualTypes FirstEmployee<\/strong> and SecondEmployee<\/strong>.<\/p>\n\n\n\n After adding the virtualType in your code, please execute the following command to see the result.<\/p>\n\n\n\n See the Result:<\/strong> When you will run the controller on browser, you will see the result as below image:<\/p>\n\n\n\n Virtual types can be used to modify or replace the constructor argument of an existing class.<\/p>\n\n\n\n Download the Full Code.<\/a><\/p>\n\n\n\n For a personalized touch, engage and hire Magento developers<\/a> who are focused on delivering exceptional results for your custom e-commerce projects.
<virtualType\/> accepts two attributes:<\/p>\n\n\n\n
[B] type:<\/strong> This attribute contains the existing class name which we use to create the virtualType.<\/p>\n\n\n\n
The di.xml file is placed inside the <magento-root-directory>\/app\/code\/Webkul\/Module\/etc\/ directory.<\/p>\n\n\n\n<?xml version="1.0"?>\n<!--\n\/**\n * Webkul Software.\n *\n * @category Webkul\n * @package Webkul_Module\n * @author Webkul Software Private Limited\n * @copyright Webkul Software Private Limited (https:\/\/webkul.com)\n * @license https:\/\/store.webkul.com\/license.html\n *\/\n-->\n<config xmlns:xsi="http:\/\/www.w3.org\/2001\/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager\/etc\/config.xsd">\n <!--Employee Class-->\n <type name="Webkul\\Module\\Model\\Employee">\n <arguments>\n <argument name="empattribute" xsi:type="array">\n <item name="name" xsi:type="string">Name<\/item>\n <item name="id" xsi:type="string">Id<\/item>\n <\/argument>\n <\/arguments>\n <\/type>\n\n <!--CustomVirtualEmployee virtualType class for Employee class-->\n <virtualType name="CustomVirtualEmployee" type="Webkul\\Module\\Model\\Employee">\n <\/virtualType>\n\n <!--FirstEmployee virtualType class for EmpRecord class-->\n <virtualType name="FirstEmployee" type="Webkul\\Module\\Model\\EmpRecord">\n <arguments>\n <argument name="record" xsi:type="array">\n <item name="name_1" xsi:type="string">Jack<\/item>\n <item name="id_1" xsi:type="string">101<\/item>\n <\/argument>\n <\/arguments>\n <\/virtualType>\n\n <!--SecondEmployee virtualType class for EmpRecord class-->\n <virtualType name="SecondEmployee" type="Webkul\\Module\\Model\\EmpRecord">\n <arguments>\n <argument name="record" xsi:type="array">\n <item name="name_2" xsi:type="string">Lusi<\/item>\n <item name="id_1" xsi:type="string">140<\/item>\n <\/argument>\n <\/arguments>\n <\/virtualType>\n\n <!--using virtualType classes FirstEmployee and SecondEmployee within di.xml file-->\n <type name="Webkul\\Module\\Model\\AllRecords">\n <arguments>\n <argument name="allRecords" xsi:type="array">\n <item name="firstEmployee" xsi:type="object">FirstEmployee<\/item>\n <item name="secondEmployee" xsi:type="object">SecondEmployee<\/item>\n <\/argument>\n <\/arguments>\n <\/type>\n<\/config><\/pre>\n\n\n\n
\n
If we use this class in code then it will not work. We can use these virtualType classes within the di.xml.<\/li>\n\n\n\n
If we will create the class, then we can do some other stuff like modifying methods or simply using the class inside PHP code.<\/li>\n<\/ol>\n\n\n\n<?php\n\/**\n * Webkul Software.\n *\n * @category Webkul\n * @package Webkul_Module\n * @author Webkul Software Private Limited\n * @copyright Webkul Software Private Limited (https:\/\/webkul.com)\n * @license https:\/\/store.webkul.com\/license.html\n *\/\nnamespace Webkul\\Module\\Model;\n\nclass Employee\n{\n \/**\n * @var array\n *\/\n private $empattribute;\n \n \/**\n * Construct method\n * \n * @param array $empattribute\n * @return void\n *\/\n public function __construct(array $empattribute = [])\n {\n $this->empattribute = $empattribute;\n }\n\n \/**\n * Get Employee Data\n * \n * @return array\n *\/\n public function getEmployeeData()\n {\n return $this->empattribute;\n }\n}<\/pre>\n\n\n\n<?php\n\/**\n * Webkul Software.\n *\n * @category Webkul\n * @package Webkul_Module\n * @author Webkul Software Private Limited\n * @copyright Webkul Software Private Limited (https:\/\/webkul.com)\n * @license https:\/\/store.webkul.com\/license.html\n *\/\nnamespace Webkul\\Module\\Model;\n\nclass CustomVirtualEmployee extends \\Webkul\\Module\\Model\\Employee\n{\n \/**\n * @var array\n *\/\n private $empattribute;\n \n \/**\n * Construct method\n * \n * @param array $empattribute\n * @return void\n *\/\n public function __construct(array $empattribute = [])\n {\n parent::__construct($empattribute);\n $this->empattribute = $this->getEmployeeData();\n $this->empattribute["addedNewOne"] = $this->getNewAttribute();\n }\n\n \/**\n * Get New Attribute Label\n * \n * @return string\n *\/\n public function getNewAttribute()\n {\n return "Salary";\n }\n\n \/**\n * Get All Data\n * \n * @return array\n *\/\n public function getAllData()\n {\n return $this->empattribute;\n }\n}<\/pre>\n\n\n\n<?php\n\/**\n * Webkul Software.\n *\n * @category Webkul\n * @package Webkul_Module\n * @author Webkul Software Private Limited\n * @copyright Webkul Software Private Limited (https:\/\/webkul.com)\n * @license https:\/\/store.webkul.com\/license.html\n *\/\nnamespace Webkul\\Module\\Model;\n\nclass EmpRecord\n{\n \/**\n * @var array\n *\/\n private $record;\n \n \/**\n * Construct method\n * \n * @param array $record\n * @return void\n *\/\n public function __construct(array $record = [])\n {\n $this->record = $record; \n }\n\n \/**\n * Get Record Data\n * \n * @return array\n *\/\n public function getRecord()\n {\n return $this->record;\n }\n}<\/pre>\n\n\n\n<?php\n\/**\n * Webkul Software.\n *\n * @category Webkul\n * @package Webkul_Module\n * @author Webkul Software Private Limited\n * @copyright Webkul Software Private Limited (https:\/\/webkul.com)\n * @license https:\/\/store.webkul.com\/license.html\n *\/\nnamespace Webkul\\Module\\Model;\n\nclass AllRecords\n{\n \/**\n * @var array\n *\/\n private $allRecords;\n\n \/**\n * Construct method\n * \n * @param array $allRecords\n * @return void\n *\/\n public function __construct(array $allRecords = [])\n {\n $this->allRecords = $allRecords;\n }\n\n \/**\n * Get All Records\n * \n * @return array\n *\/\n public function getRecords()\n {\n return $this->allRecords;\n }\n}<\/pre>\n\n\n\nphp bin\/magento setup:di:compile<\/pre>\n\n\n\n
To display the result, I created the Controller file Index.php inside the <magento-root-dir.>app\/code\/Webkul\/Module\/Controller\/Index\/ directory and added the following code:<\/p>\n\n\n\n<?php\n\/**\n * Webkul Software.\n *\n * @category Webkul\n * @package Webkul_Module\n * @author Webkul Software Private Limited\n * @copyright Webkul Software Private Limited (https:\/\/webkul.com)\n * @license https:\/\/store.webkul.com\/license.html\n *\/\n\nnamespace Webkul\\Module\\Controller\\Index;\n\nuse Magento\\Framework\\App\\Action\\Action;\nuse Magento\\Framework\\App\\Action\\Context;\n\nclass Index extends Action\n{\n \/**\n * @var \\Magento\\Framework\\Controller\\Result\\Raw\n *\/\n protected $rawResultFactory;\n\n \/**\n * @var \\Webkul\\Module\\Model\\AllRecords\n *\/\n protected $empAllRecords;\n\n \/**\n * @var \\Webkul\\Module\\Model\\CustomVirtualEmployee\n *\/\n protected $virEmp;\n\n \/**\n * Initialize dependencies\n * \n * @param Context $context\n * @param \\Webkul\\Module\\Model\\AllRecords $empAllRecords\n * @param \\Webkul\\Module\\Model\\CustomVirtualEmployee $virEmp\n * @param \\Magento\\Framework\\Controller\\Result\\Raw $rawResultFactory\n * @return void\n *\/\n public function __construct(\n Context $context,\n \\Webkul\\Module\\Model\\AllRecords $empAllRecords,\n \\Webkul\\Module\\Model\\CustomVirtualEmployee $virEmp,\n \\Magento\\Framework\\Controller\\Result\\Raw $rawResultFactory\n ) {\n $this->virEmp = $virEmp;\n $this->rawResultFactory = $rawResultFactory;\n $this->empAllRecords = $empAllRecords;\n parent::__construct($context);\n }\n\n \/**\n * Execute method to print data\n *\n * @return \\Magento\\Framework\\Controller\\Result\\Raw\n *\/\n public function execute()\n {\n $result = $this->rawResultFactory;\n $result->setHeader('Content-Type', 'text\/html');\n\n $empRecords = $this->empAllRecords->getRecords();\n\n $dataStr = "";\n\n $dataStr .= "<h3>Result for Case 1: Used <virtualType> within di.xml file<\/h3>";\n\n foreach ($empRecords as $index=>$each) {\n $dataStr .= $index."::".json_encode($each->getRecord())."<br>";\n }\n\n $employeeAttrs = $this->virEmp->getAllData();\n \n $dataStr .= "<h3>Result for Case 2: Created <virtualType> for class Webkul\\Module\\Model\\Employee and created CustomVirtualEmployee class<\/h3>";\n\n foreach ($employeeAttrs as $key=>$value) {\n $dataStr .= $key."::".$value."<br>";\n }\n\n $result->setContents( $dataStr);\n\n return $result;\n }\n}<\/pre>\n\n\n\n![\"VirtualTypeResult\"](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/05\/VirtualTypeResult-1200x329.png\")
<\/figure>\n\n\n\n
In <virtualType\/>, in the name<\/strong> attribute, we can pass the ClassName or complete path of the virtual class as the following example in <magento-root-dir.>\/vendor\/magento\/module-catalog\/adminhtml\/etc\/di.xml<\/em> file.<\/p>\n\n\n\n<virtualType name="Magento\\Catalog\\Ui\\DataProvider\\Product\\ProductCollectionFactory" type="Magento\\Catalog\\Model\\ResourceModel\\Product\\CollectionFactory">\n <arguments>\n <argument name="instanceName" xsi:type="string">\\Magento\\Catalog\\Ui\\DataProvider\\Product\\ProductCollection<\/argument>\n <\/arguments>\n<\/virtualType><\/pre>\n\n\n\n
Hope this will be helpful. Thanks \ud83d\ude42<\/p>\n","protected":false},"excerpt":{"rendered":"