Magento Class Explorer

https://m.academy/magento-explorer/
Admin
Magento Class Explorer is a developer reference tool for browsing and exploring 295+ Magento modules...
Tokens:1,599,134
Snippets:18,239
Trust Score:8.8
Update:7 months ago
Show doc for...
Tokens:
Raw
### Create Custom Product Attribute Data Patch (PHP)

Source: https://m.academy/magento-explorer/module-tax/model-taxclass-repository

This PHP code example demonstrates how to create a data patch to add a custom product attribute in Magento 2. It utilizes the EAV setup factory and module data setup interfaces for attribute creation.

```php
<?php
declare(strict_types=1);

namespace Vendor\Module\Setup\Patch\Data;

use Magento\Framework\Setup\Patch\DataPatchInterface;
use Magento\Eav\Setup\EavSetupFactory;
use Magento\Framework\Setup\ModuleDataSetupInterface;
use Magento\Catalog\Api\Data\ProductAttributeInterface;
use Magento\Eav\Model\Entity\Attribute\ScopedAttributeInterface;
use Magento\Catalog\Api\Data\ProductInterface as Product;

class AddCustomProductAttribute implements DataPatchInterface
{
    public function __construct(
        private EavSetupFactory $eavSetupFactory,
        private ModuleDataSetupInterface $moduleDataSetup
    ) {}

    public function apply(): self
    {
        $eavSetup = $this->eavSetupFactory->create(["setup" => $this->moduleDataSetup]);
        $eavSetup->addAttribute(
            Product::ENTITY,
            "custom_attribute",
            [
                "type" => "varchar",
                "label" => "Custom Attribute",
                "input" => "text",
                "required" => false,
                "visible" => true,
                "sort_order" => 100,
                "global" => ScopedAttributeInterface::SCOPE_STORE,
                "user_defined" => true,
                "searchable" => false,
                "filterable" => false,
                "comparable" => false,
                "visible_on_front" => false,
                "unique" => false,
                "apply_to" => ""
            ]
        );

        return $this;
    }

    public static function getDependencies(): array
    {
        return [];
    }

    public function getAliases(): array
    {
        return [];
    }
}
```

--------------------------------

### Magento DI Configuration Example

Source: https://m.academy/magento-explorer/module-bundle/model-source-option-type

Illustrates Dependency Injection (DI) configuration in Magento, demonstrating how to map interfaces to implementations, inject arguments into classes, and apply plugins to existing repositories. This is crucial for customizing Magento's behavior and integrating custom modules.

```xml
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager:etc/config.xsd">
    <preference for="Vendor\Module\Api\RepositoryInterface"
               type="Vendor\Module\Model\EntityRepository" />
    <type name="Vendor\Module\Model\EntityRepository">
        <arguments>
            <argument name="collectionProcessor" xsi:type="object">
                Magento\Framework\Api\SearchCriteria\CollectionProcessor
            </argument>
        </arguments>
    </type>
    <type name="Magento\Catalog\Api\ProductRepositoryInterface">
        <plugin name="vendor_product_save"
                type="Vendor\Module\Plugin\ProductSavePlugin"
                sortOrder="10" />
    </type>
</config>
```

--------------------------------

### Magento DI Configuration for Preferences and Plugins

Source: https://m.academy/magento-explorer/module-analytics/model-connector-signupcommand

This XML configuration sets up dependency injection (DI) for a Magento module. It defines a preference for a custom API interface, configures arguments for a model, and registers a plugin for the ProductRepositoryInterface. This allows for customization and extension of core Magento functionalities.

```xml
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
    <preference for="Vendor\Module\Api\RepositoryInterface"
               type="Vendor\Module\Model\EntityRepository" />
    <type name="Vendor\Module\Model\EntityRepository">
        <arguments>
            <argument name="collectionProcessor" xsi:type="object">
                Magento\Framework\Api\SearchCriteria\CollectionProcessor
            </argument>
        </arguments>
    </type>
    <type name="Magento\Catalog\Api\ProductRepositoryInterface">
        <plugin name="vendor_product_save" 
                type="Vendor\Module\Plugin\ProductSavePlugin" 
                sortOrder="10" />
    </type>
</config>
```

--------------------------------

### Create Custom Product Attribute with Data Patch in Magento

Source: https://m.academy/magento-explorer/module-asynchronous-operations/magento-asynchronousoperations-model-operation

This PHP code example demonstrates how to create a custom product attribute in Magento using a Data Patch. It utilizes the EAV setup factory to add a new 'varchar' attribute named 'custom_attribute' to the product entity. This patch is applied during Magento's setup process.

```php
<?php
declare(strict_types=1);

namespace Vendor\Module\Setup\Patch\Data;

use Magento\Framework\Setup\Patch\DataPatchInterface;
use Magento\Eav\Setup\EavSetupFactory;
use Magento\Framework\Setup\ModuleDataSetupInterface;
use Magento\Catalog\Model\Product;
use Magento\Eav\Api\Data\AttributeInterface;
use Magento\Eav\Model\Entity\Attribute\ScopedAttributeInterface;

class AddCustomProductAttribute implements DataPatchInterface
{
    public function __construct(
        private EavSetupFactory $eavSetupFactory,
        private ModuleDataSetupInterface $moduleDataSetup
    ) {}

    public function apply(): self
    {
        $eavSetup = $this->eavSetupFactory->create(["setup" => $this->moduleDataSetup]);
        $eavSetup->addAttribute(
            Product::ENTITY,
            "custom_attribute",
            [
                "type" => "varchar",
                "label" => "Custom Attribute",
                "input" => "text",
                "required" => false,
                "visible" => true,
                "sort_order" => 100,
                "global" => ScopedAttributeInterface::SCOPE_STORE,
            ]
        );

        return $this;
    }

    public static function getDependencies(): array
    {
        return [];
    }

    public function getAliases(): array
    {
        return [];
    }
}

```

--------------------------------

### Plugin Example for Magento Product Repository

Source: https://m.academy/magento-explorer/module-admin-adobe-ims/magento-adminadobeims-api-imslogoutinterface

This PHP code demonstrates a plugin for Magento's `ProductRepositoryInterface`. It includes `beforeSave` to validate SKU before saving a product and `afterGetById` to add a flag indicating the product was loaded via the repository. This is useful for intercepting and modifying product repository behavior.

```php
<?php
declare(strict_types=1);

namespace VendorModulePlugin;

use MagentoCatalogApiProductRepositoryInterface;
use MagentoCatalogApiDataProductInterface;

class ProductSavePlugin
{
    public function beforeSave(
        ProductRepositoryInterface $subject,
        ProductInterface $product
    ): array {
        if (!$product->getSku()) {
            throw new \Magento\Framework\Exception\LocalizedException(
                __("SKU is required before saving.")
            );
        }

        return [$product];
    }

    public function afterGetById(
        ProductRepositoryInterface $subject,
        ProductInterface $result
    ): ProductInterface {
        $result->setData("is_loaded_via_repository", true);

        return $result;
    }
}
```
Tokens:
Raw