Hello Magento Friends,
In this blog article, we will learn about What is Proxies in Magento 2, why it is needed, and how to use Proxy in Magento 2.
What is Proxies in Magento 2?
Proxies are used to solve a specific problem in Magento 2. Proxies work as a substitute. In programming, proxies are classes that can be used in place of any other classes. In Magento 2 Proxies are used on behalf of resource hungry classes.
Why Proxies are used in Magento 2?
Magento 2 uses various types of dependencies of which constructor injection and method injection are the best. But there is trouble using the constructor injection.
If you wish to use another class object in your class you are unable to instantiate the class in Magento 2. Instead, you need to inject the object in the constructor and afterward, it can be used in the class. Doing so will instantiate all the dependencies injected in your class constructor when your class is instantiated. This slows down the process. To overcome this, a proxy design pattern is used.
How to use Proxy in Magento 2?
Let’s take an example to know how Proxy is used in Magento 2.
Step 1: Add a type configuration in the di.xml
<?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\Catalog\Model\Product">
<arguments>
<argument name="catalogProductStatus" xsi:type="object">Magento\Catalog\Model\Product\Attribute\Source\Status\Proxy</argument>
<argument name="productLink" xsi:type="object">Magento\Catalog\Model\Product\Link\Proxy</argument>
</arguments>
</type>
</config>
Step 2: After that open terminal and execute the below command in the Magento root path
php bin/magento setup:di:compile
Then the following classes will be generated automatically at the given path :
magento_root_path\generated\code\Magento\Catalog\Model\Product\Attribute\Source\Status\Proxy.php
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);
namespace Magento\Catalog\Model\Indexer\Product\Price;
use Magento\Framework\Indexer\Dimension;
use Magento\Framework\Indexer\ScopeResolver\IndexScopeResolver;
use Magento\Framework\Search\Request\IndexScopeResolverInterface;
/**
* Class return price table name based on dimension
* use only on the frontend area
*/
class PriceTableResolver implements IndexScopeResolverInterface
{
/**
* @var IndexScopeResolver
*/
private $indexScopeResolver;
/**
* @var DimensionModeConfiguration
*/
private $dimensionModeConfiguration;
/**
* @param IndexScopeResolver $indexScopeResolver
* @param DimensionModeConfiguration $dimensionModeConfiguration
*/
public function __construct(
IndexScopeResolver $indexScopeResolver,
DimensionModeConfiguration $dimensionModeConfiguration
) {
$this->indexScopeResolver = $indexScopeResolver;
$this->dimensionModeConfiguration = $dimensionModeConfiguration;
}
/**
* Return price table name based on dimension
* @param string $index
* @param array $dimensions
* @return string
*/
public function resolve($index, array $dimensions)
{
if ($index === 'catalog_product_index_price') {
$dimensions = $this->filterDimensions($dimensions);
}
return $this->indexScopeResolver->resolve($index, $dimensions);
}
/**
* @param Dimension[] $dimensions
* @return array
* @throws \Exception
*/
private function filterDimensions($dimensions): array
{
$existDimensions = [];
$currentDimensions = $this->dimensionModeConfiguration->getDimensionConfiguration();
foreach ($dimensions as $dimension) {
if ((string)$dimension->getValue() === '') {
throw new \InvalidArgumentException(
sprintf('Dimension value of "%s" can not be empty', $dimension->getName())
);
}
if (in_array($dimension->getName(), $currentDimensions, true)) {
$existDimensions[] = $dimension;
}
}
return $existDimensions;
}
}
magento_root_path\generated\Magento\Catalog\Model\Product\Link\Proxy.php
<?php
namespace Magento\Catalog\Model\Product\Link;
/**
* Proxy class for @see \Magento\Catalog\Model\Product\Link
*/
class Proxy extends \Magento\Catalog\Model\Product\Link implements \Magento\Framework\ObjectManager\NoninterceptableInterface
{
/**
* Object Manager instance
*
* @var \Magento\Framework\ObjectManagerInterface
*/
protected $_objectManager = null;
/**
* Proxied instance name
*
* @var string
*/
protected $_instanceName = null;
/**
* Proxied instance
*
* @var \Magento\Catalog\Model\Product\Link
*/
protected $_subject = null;
/**
* Instance shareability flag
*
* @var bool
*/
protected $_isShared = null;
/**
* Proxy constructor
*
* @param \Magento\Framework\ObjectManagerInterface $objectManager
* @param string $instanceName
* @param bool $shared
*/
public function __construct(\Magento\Framework\ObjectManagerInterface $objectManager, $instanceName = '\\Magento\\Catalog\\Model\\Product\\Link', $shared = true)
{
$this->_objectManager = $objectManager;
$this->_instanceName = $instanceName;
$this->_isShared = $shared;
}
/**
* @return array
*/
public function __sleep()
{
return ['_subject', '_isShared', '_instanceName'];
}
/**
* Retrieve ObjectManager from global scope
*/
public function __wakeup()
{
$this->_objectManager = \Magento\Framework\App\ObjectManager::getInstance();
}
/**
* Clone proxied instance
*/
public function __clone()
{
$this->_subject = clone $this->_getSubject();
}
/**
* Get proxied instance
*
* @return \Magento\Catalog\Model\Product\Link
*/
protected function _getSubject()
{
if (!$this->_subject) {
$this->_subject = true === $this->_isShared
? $this->_objectManager->get($this->_instanceName)
: $this->_objectManager->create($this->_instanceName);
}
return $this->_subject;
}
/**
* {@inheritdoc}
*/
public function useRelatedLinks()
{
return $this->_getSubject()->useRelatedLinks();
}
/**
* {@inheritdoc}
*/
public function useUpSellLinks()
{
return $this->_getSubject()->useUpSellLinks();
}
/**
* {@inheritdoc}
*/
public function useCrossSellLinks()
{
return $this->_getSubject()->useCrossSellLinks();
}
/**
* {@inheritdoc}
*/
public function getAttributeTypeTable($type)
{
return $this->_getSubject()->getAttributeTypeTable($type);
}
/**
* {@inheritdoc}
*/
public function getProductCollection()
{
return $this->_getSubject()->getProductCollection();
}
/**
* {@inheritdoc}
*/
public function getLinkCollection()
{
return $this->_getSubject()->getLinkCollection();
}
/**
* {@inheritdoc}
*/
public function getAttributes($type = null)
{
return $this->_getSubject()->getAttributes($type);
}
/**
* {@inheritdoc}
*/
public function saveProductRelations($product)
{
return $this->_getSubject()->saveProductRelations($product);
}
/**
* {@inheritdoc}
*/
public function setIdFieldName($name)
{
return $this->_getSubject()->setIdFieldName($name);
}
/**
* {@inheritdoc}
*/
public function getIdFieldName()
{
return $this->_getSubject()->getIdFieldName();
}
/**
* {@inheritdoc}
*/
public function getId()
{
return $this->_getSubject()->getId();
}
/**
* {@inheritdoc}
*/
public function setId($value)
{
return $this->_getSubject()->setId($value);
}
/**
* {@inheritdoc}
*/
public function isDeleted($isDeleted = null)
{
return $this->_getSubject()->isDeleted($isDeleted);
}
/**
* {@inheritdoc}
*/
public function hasDataChanges()
{
return $this->_getSubject()->hasDataChanges();
}
/**
* {@inheritdoc}
*/
public function setData($key, $value = null)
{
return $this->_getSubject()->setData($key, $value);
}
/**
* {@inheritdoc}
*/
public function unsetData($key = null)
{
return $this->_getSubject()->unsetData($key);
}
/**
* {@inheritdoc}
*/
public function setDataChanges($value)
{
return $this->_getSubject()->setDataChanges($value);
}
/**
* {@inheritdoc}
*/
public function getOrigData($key = null)
{
return $this->_getSubject()->getOrigData($key);
}
/**
* {@inheritdoc}
*/
public function setOrigData($key = null, $data = null)
{
return $this->_getSubject()->setOrigData($key, $data);
}
/**
* {@inheritdoc}
*/
public function dataHasChangedFor($field)
{
return $this->_getSubject()->dataHasChangedFor($field);
}
/**
* {@inheritdoc}
*/
public function getResourceName()
{
return $this->_getSubject()->getResourceName();
}
/**
* {@inheritdoc}
*/
public function getResourceCollection()
{
return $this->_getSubject()->getResourceCollection();
}
/**
* {@inheritdoc}
*/
public function getCollection()
{
return $this->_getSubject()->getCollection();
}
/**
* {@inheritdoc}
*/
public function load($modelId, $field = null)
{
return $this->_getSubject()->load($modelId, $field);
}
/**
* {@inheritdoc}
*/
public function beforeLoad($identifier, $field = null)
{
return $this->_getSubject()->beforeLoad($identifier, $field);
}
/**
* {@inheritdoc}
*/
public function afterLoad()
{
return $this->_getSubject()->afterLoad();
}
/**
* {@inheritdoc}
*/
public function isSaveAllowed()
{
return $this->_getSubject()->isSaveAllowed();
}
/**
* {@inheritdoc}
*/
public function setHasDataChanges($flag)
{
return $this->_getSubject()->setHasDataChanges($flag);
}
/**
* {@inheritdoc}
*/
public function save()
{
return $this->_getSubject()->save();
}
/**
* {@inheritdoc}
*/
public function afterCommitCallback()
{
return $this->_getSubject()->afterCommitCallback();
}
/**
* {@inheritdoc}
*/
public function isObjectNew($flag = null)
{
return $this->_getSubject()->isObjectNew($flag);
}
/**
* {@inheritdoc}
*/
public function beforeSave()
{
return $this->_getSubject()->beforeSave();
}
/**
* {@inheritdoc}
*/
public function validateBeforeSave()
{
return $this->_getSubject()->validateBeforeSave();
}
/**
* {@inheritdoc}
*/
public function getCacheTags()
{
return $this->_getSubject()->getCacheTags();
}
/**
* {@inheritdoc}
*/
public function cleanModelCache()
{
return $this->_getSubject()->cleanModelCache();
}
/**
* {@inheritdoc}
*/
public function afterSave()
{
return $this->_getSubject()->afterSave();
}
/**
* {@inheritdoc}
*/
public function delete()
{
return $this->_getSubject()->delete();
}
/**
* {@inheritdoc}
*/
public function beforeDelete()
{
return $this->_getSubject()->beforeDelete();
}
/**
* {@inheritdoc}
*/
public function afterDelete()
{
return $this->_getSubject()->afterDelete();
}
/**
* {@inheritdoc}
*/
public function afterDeleteCommit()
{
return $this->_getSubject()->afterDeleteCommit();
}
/**
* {@inheritdoc}
*/
public function getResource()
{
return $this->_getSubject()->getResource();
}
/**
* {@inheritdoc}
*/
public function getEntityId()
{
return $this->_getSubject()->getEntityId();
}
/**
* {@inheritdoc}
*/
public function setEntityId($entityId)
{
return $this->_getSubject()->setEntityId($entityId);
}
/**
* {@inheritdoc}
*/
public function clearInstance()
{
return $this->_getSubject()->clearInstance();
}
/**
* {@inheritdoc}
*/
public function getStoredData()
{
return $this->_getSubject()->getStoredData();
}
/**
* {@inheritdoc}
*/
public function getEventPrefix()
{
return $this->_getSubject()->getEventPrefix();
}
/**
* {@inheritdoc}
*/
public function addData(array $arr)
{
return $this->_getSubject()->addData($arr);
}
/**
* {@inheritdoc}
*/
public function getData($key = '', $index = null)
{
return $this->_getSubject()->getData($key, $index);
}
/**
* {@inheritdoc}
*/
public function getDataByPath($path)
{
return $this->_getSubject()->getDataByPath($path);
}
/**
* {@inheritdoc}
*/
public function getDataByKey($key)
{
return $this->_getSubject()->getDataByKey($key);
}
/**
* {@inheritdoc}
*/
public function setDataUsingMethod($key, $args = [])
{
return $this->_getSubject()->setDataUsingMethod($key, $args);
}
/**
* {@inheritdoc}
*/
public function getDataUsingMethod($key, $args = null)
{
return $this->_getSubject()->getDataUsingMethod($key, $args);
}
/**
* {@inheritdoc}
*/
public function hasData($key = '')
{
return $this->_getSubject()->hasData($key);
}
/**
* {@inheritdoc}
*/
public function toArray(array $keys = [])
{
return $this->_getSubject()->toArray($keys);
}
/**
* {@inheritdoc}
*/
public function convertToArray(array $keys = [])
{
return $this->_getSubject()->convertToArray($keys);
}
/**
* {@inheritdoc}
*/
public function toXml(array $keys = [], $rootName = 'item', $addOpenTag = false, $addCdata = true)
{
return $this->_getSubject()->toXml($keys, $rootName, $addOpenTag, $addCdata);
}
/**
* {@inheritdoc}
*/
public function convertToXml(array $arrAttributes = [], $rootName = 'item', $addOpenTag = false, $addCdata = true)
{
return $this->_getSubject()->convertToXml($arrAttributes, $rootName, $addOpenTag, $addCdata);
}
/**
* {@inheritdoc}
*/
public function toJson(array $keys = [])
{
return $this->_getSubject()->toJson($keys);
}
/**
* {@inheritdoc}
*/
public function convertToJson(array $keys = [])
{
return $this->_getSubject()->convertToJson($keys);
}
/**
* {@inheritdoc}
*/
public function toString($format = '')
{
return $this->_getSubject()->toString($format);
}
/**
* {@inheritdoc}
*/
public function __call($method, $args)
{
return $this->_getSubject()->__call($method, $args);
}
/**
* {@inheritdoc}
*/
public function isEmpty()
{
return $this->_getSubject()->isEmpty();
}
/**
* {@inheritdoc}
*/
public function serialize($keys = [], $valueSeparator = '=', $fieldSeparator = ' ', $quote = '"')
{
return $this->_getSubject()->serialize($keys, $valueSeparator, $fieldSeparator, $quote);
}
/**
* {@inheritdoc}
*/
public function debug($data = null, &$objects = [])
{
return $this->_getSubject()->debug($data, $objects);
}
/**
* {@inheritdoc}
*/
public function offsetSet($offset, $value)
{
return $this->_getSubject()->offsetSet($offset, $value);
}
/**
* {@inheritdoc}
*/
public function offsetExists($offset)
{
return $this->_getSubject()->offsetExists($offset);
}
/**
* {@inheritdoc}
*/
public function offsetUnset($offset)
{
return $this->_getSubject()->offsetUnset($offset);
}
/**
* {@inheritdoc}
*/
public function offsetGet($offset)
{
return $this->_getSubject()->offsetGet($offset);
}
}
Final Words:
Hence, this was all about Proxy in Magento 2. Share your doubts in the comment section. Hire a Magento Developer that can make your work easy. Stay in touch with us for further blogs.
Happy Reading!
