EAV and Attributes

<?php

declare(strict_types=1);

namespace PocketCoffee\Eav\Setup\Patch\Data;

use Magento\Catalog\Model\Product;
use Magento\Eav\Model\Entity\Attribute\ScopedAttributeInterface;
use Magento\Eav\Setup\EavSetup;
use Magento\Eav\Setup\EavSetupFactory;
use Magento\Framework\Setup\ModuleDataSetupInterface;
use Magento\Framework\Setup\Patch\DataPatchInterface;
use Magento\Framework\Setup\Patch\PatchRevertableInterface;

/**
 * Adds the origin, roast level and roast date product attributes of Pocket Coffee.
 */
class AddProductAttributes implements DataPatchInterface, PatchRevertableInterface
{
    public const ORIGIN = 'pc_origin';
    public const ROAST_LEVEL = 'pc_roast_level';
    public const ROAST_DATE = 'pc_roast_date';

    public function __construct(
        private readonly ModuleDataSetupInterface $moduleDataSetup,
        private readonly EavSetupFactory $eavSetupFactory
    ) {
    }

    public function apply(): self
    {
        $this->moduleDataSetup->getConnection()->startSetup();
        /** @var EavSetup $eavSetup */
        $eavSetup = $this->eavSetupFactory->create(['setup' => $this->moduleDataSetup]);

        // Drop-down with admin-managed options: stored as an int in catalog_product_entity_int.
        $eavSetup->addAttribute(Product::ENTITY, self::ORIGIN, [
            'type' => 'int',
            'label' => 'Origin',
            'input' => 'select',
            'source' => \Magento\Eav\Model\Entity\Attribute\Source\Table::class,
            'required' => false,
            'global' => ScopedAttributeInterface::SCOPE_GLOBAL,
            'user_defined' => true,
            'visible' => true,
            'visible_on_front' => true,
            'used_in_product_listing' => true,
            'searchable' => true,
            'filterable' => 1,
            'filterable_in_search' => true,
            'comparable' => true,
            'is_used_in_grid' => true,
            'is_visible_in_grid' => true,
            'is_filterable_in_grid' => true,
            'group' => 'General',
            'sort_order' => 60,
            'option' => ['values' => ['Ethiopia Yirgacheffe', 'Colombia Huila', 'Brazil Cerrado']],
        ]);

        // A second drop-down; per-website scope, not used in layered navigation.
        $eavSetup->addAttribute(Product::ENTITY, self::ROAST_LEVEL, [
            'type' => 'int',
            'label' => 'Roast level',
            'input' => 'select',
            'source' => \Magento\Eav\Model\Entity\Attribute\Source\Table::class,
            'required' => false,
            'global' => ScopedAttributeInterface::SCOPE_WEBSITE,
            'user_defined' => true,
            'visible' => true,
            'visible_on_front' => true,
            'group' => 'General',
            'sort_order' => 70,
            'option' => ['values' => ['Light', 'Medium', 'Dark']],
        ]);

        // A date: stored as a datetime in catalog_product_entity_datetime, editable per store view.
        $eavSetup->addAttribute(Product::ENTITY, self::ROAST_DATE, [
            'type' => 'datetime',
            'label' => 'Roast date',
            'input' => 'date',
            'backend' => \Magento\Eav\Model\Entity\Attribute\Backend\Datetime::class,
            'required' => false,
            'global' => ScopedAttributeInterface::SCOPE_STORE,
            'user_defined' => true,
            'visible' => true,
            'visible_on_front' => true,
            'used_in_product_listing' => true,
            'group' => 'General',
            'sort_order' => 80,
        ]);

        $this->moduleDataSetup->getConnection()->endSetup();

        return $this;
    }

    public function revert(): void
    {
        $this->moduleDataSetup->getConnection()->startSetup();
        /** @var EavSetup $eavSetup */
        $eavSetup = $this->eavSetupFactory->create(['setup' => $this->moduleDataSetup]);
        foreach ([self::ORIGIN, self::ROAST_LEVEL, self::ROAST_DATE] as $code) {
            $eavSetup->removeAttribute(Product::ENTITY, $code);
        }
        $this->moduleDataSetup->getConnection()->endSetup();
    }

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

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

<?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="PocketCoffee_Eav">
        <sequence>
            <module name="Magento_Eav"/>
            <module name="Magento_Catalog"/>
            <module name="Magento_Customer"/>
        </sequence>
    </module>
</config>

bin/magento module:enable PocketCoffee_Eav
bin/magento setup:upgrade
bin/magento cache:flush

attribute_id  entity_type_id  attribute_code  backend_type  frontend_input  source_model
147           4               pc_origin       int           select          Magento\Eav\Model\Entity\Attribute\Source\Table
148           4               pc_roast_level  int           select          Magento\Eav\Model\Entity\Attribute\Source\Table
149           4               pc_roast_date   datetime      date            NULL

<?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\Framework\Console\CommandListInterface">
        <arguments>
            <argument name="commands" xsi:type="array">
                <item name="pocketcoffee_eav_demo" xsi:type="object">PocketCoffee\Eav\Console\Command\DemoCommand</item>
            </argument>
        </arguments>
    </type>
    <type name="Magento\Catalog\Api\ProductRepositoryInterface">
        <plugin name="pocketcoffee_eav_days_since_roast" type="PocketCoffee\Eav\Plugin\AddDaysSinceRoast"/>
    </type>
</config>

<?php

declare(strict_types=1);

namespace PocketCoffee\Eav\Console\Command;

use Magento\Catalog\Api\Data\ProductInterfaceFactory;
use Magento\Catalog\Api\ProductAttributeRepositoryInterface;
use Magento\Catalog\Api\ProductRepositoryInterface;
use Magento\Catalog\Model\ResourceModel\Product\CollectionFactory;
use Magento\Framework\Api\SearchCriteriaBuilder;
use Magento\Framework\App\Area;
use Magento\Framework\App\State;
use Magento\Framework\Exception\LocalizedException;
use Magento\Framework\Exception\NoSuchEntityException;
use PocketCoffee\Eav\Setup\Patch\Data\AddProductAttributes;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

class DemoCommand extends Command
{
    public function __construct(
        private readonly State $appState,
        private readonly ProductAttributeRepositoryInterface $attributeRepository,
        private readonly ProductRepositoryInterface $productRepository,
        private readonly ProductInterfaceFactory $productFactory,
        private readonly SearchCriteriaBuilder $searchCriteriaBuilder,
        private readonly CollectionFactory $collectionFactory,
        ?string $name = null
    ) {
        parent::__construct($name);
    }

    protected function configure(): void
    {
        $this->setName('pocketcoffee:eav:demo')
            ->setDescription('Save a product with custom attributes and search by them');
    }

    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        try {
            $this->appState->setAreaCode(Area::AREA_ADMINHTML);
        } catch (LocalizedException) {
            // The area code is already set when the command runs inside a web request or a test.
        }

        // 1. Resolve the option id of the label "Ethiopia Yirgacheffe" from the attribute metadata.
        $origin = $this->attributeRepository->get(AddProductAttributes::ORIGIN);
        $originId = null;
        foreach ($origin->getOptions() as $option) {
            $output->writeln(sprintf('option %s => %s', $option->getValue() ?: '(empty)', $option->getLabel()));
            if ($option->getLabel() === 'Ethiopia Yirgacheffe') {
                $originId = $option->getValue();
            }
        }

        // 2. Save a product with custom attribute values.
        try {
            $product = $this->productRepository->get('PC-ETH-WHL-250', true);
        } catch (NoSuchEntityException) {
            $product = $this->productFactory->create();
            $product->setSku('PC-ETH-WHL-250')
                ->setName('Single-origin beans, Ethiopia, whole bean, 250 g')
                ->setTypeId('simple')
                ->setAttributeSetId($product->getDefaultAttributeSetId())
                ->setPrice(9.90)
                ->setWeight(0.25)
                ->setVisibility(4)
                ->setStatus(1)
                ->setWebsiteIds([1])
                ->setStockData(['qty' => 40, 'is_in_stock' => 1, 'manage_stock' => 1]);
        }
        $product->setCustomAttribute(AddProductAttributes::ORIGIN, $originId);
        $product->setCustomAttribute(AddProductAttributes::ROAST_DATE, '2026-10-20');
        $saved = $this->productRepository->save($product);
        $output->writeln('saved id ' . $saved->getId());

        // 3. Read the values back through the data interface.
        $loaded = $this->productRepository->get('PC-ETH-WHL-250', false, null, true);
        $output->writeln('origin option id: ' . $loaded->getCustomAttribute(AddProductAttributes::ORIGIN)->getValue());
        $output->writeln('origin label: ' . $loaded->getAttributeText(AddProductAttributes::ORIGIN));
        $output->writeln('roast date: ' . $loaded->getCustomAttribute(AddProductAttributes::ROAST_DATE)->getValue());

        // 4. Search with an attribute filter (an EAV join under the hood).
        $criteria = $this->searchCriteriaBuilder
            ->addFilter(AddProductAttributes::ORIGIN, $originId)
            ->create();
        foreach ($this->productRepository->getList($criteria)->getItems() as $item) {
            $output->writeln('found: ' . $item->getSku());
        }

        // 5. The same query through a collection; print the SQL to see the EAV joins.
        $collection = $this->collectionFactory->create()
            ->addAttributeToSelect(['name', AddProductAttributes::ORIGIN, AddProductAttributes::ROAST_DATE])
            ->addAttributeToFilter(AddProductAttributes::ORIGIN, $originId);
        $output->writeln((string) $collection->getSelect());

        return Command::SUCCESS;
    }
}

$ bin/magento pocketcoffee:eav:demo
option (empty) =>
option 4 => Ethiopia Yirgacheffe
option 5 => Colombia Huila
option 6 => Brazil Cerrado
saved id 2
origin option id: 4
origin label: Ethiopia Yirgacheffe
roast date: 2026-10-20 00:00:00
found: PC-ETH-WHL-250
SELECT `e`.*, `at_pc_origin`.`value` AS `pc_origin` FROM `catalog_product_entity` AS `e`
 INNER JOIN `catalog_product_entity_int` AS `at_pc_origin` ON (`at_pc_origin`.`entity_id` = `e`.`entity_id`) AND (`at_pc_origin`.`attribute_id` = '147') AND (`at_pc_origin`.`store_id` = 0) WHERE (at_pc_origin.value = '4')

<?php

declare(strict_types=1);

namespace PocketCoffee\Eav\Model\Customer\Attribute\Source;

use Magento\Eav\Model\Entity\Attribute\Source\AbstractSource;

/**
 * Fixed option list for the favourite grind: the values are code constants, not rows in eav_attribute_option.
 */
class Grind extends AbstractSource
{
    public const WHOLE = 'whole';
    public const ESPRESSO = 'espresso';
    public const FILTER = 'filter';

    public function getAllOptions(): array
    {
        if ($this->_options === null) {
            $this->_options = [
                ['value' => '', 'label' => __('-- Please Select --')],
                ['value' => self::WHOLE, 'label' => __('Whole bean')],
                ['value' => self::ESPRESSO, 'label' => __('Espresso')],
                ['value' => self::FILTER, 'label' => __('Filter')],
            ];
        }

        return $this->_options;
    }
}

<?php

declare(strict_types=1);

namespace PocketCoffee\Eav\Setup\Patch\Data;

use Magento\Customer\Api\CustomerMetadataInterface;
use Magento\Customer\Model\Customer;
use Magento\Customer\Setup\CustomerSetup;
use Magento\Customer\Setup\CustomerSetupFactory;
use Magento\Eav\Model\Entity\Attribute\SetFactory as AttributeSetFactory;
use Magento\Framework\Setup\ModuleDataSetupInterface;
use Magento\Framework\Setup\Patch\DataPatchInterface;
use Magento\Framework\Setup\Patch\PatchRevertableInterface;
use PocketCoffee\Eav\Model\Customer\Attribute\Source\Grind;

/**
 * Adds the favourite grind customer attribute and shows it in the admin and storefront account forms.
 */
class AddCustomerAttribute implements DataPatchInterface, PatchRevertableInterface
{
    public const FAVOURITE_GRIND = 'pc_favourite_grind';

    public function __construct(
        private readonly ModuleDataSetupInterface $moduleDataSetup,
        private readonly CustomerSetupFactory $customerSetupFactory,
        private readonly AttributeSetFactory $attributeSetFactory
    ) {
    }

    public function apply(): self
    {
        $this->moduleDataSetup->getConnection()->startSetup();
        /** @var CustomerSetup $customerSetup */
        $customerSetup = $this->customerSetupFactory->create(['setup' => $this->moduleDataSetup]);

        $customerEntity = $customerSetup->getEavConfig()->getEntityType(Customer::ENTITY);
        $attributeSetId = $customerEntity->getDefaultAttributeSetId();
        $attributeSet = $this->attributeSetFactory->create();
        $attributeGroupId = $attributeSet->getDefaultGroupId($attributeSetId);

        $customerSetup->addAttribute(CustomerMetadataInterface::ENTITY_TYPE_CUSTOMER, self::FAVOURITE_GRIND, [
            'type' => 'varchar',
            'label' => 'Favourite grind',
            'input' => 'select',
            'source' => Grind::class,
            'required' => false,
            'visible' => true,
            'user_defined' => true,
            'system' => false,
            'position' => 200,
            'sort_order' => 200,
        ]);

        // Customer attributes are attached to an attribute set, a group and the forms that render them.
        $attribute = $customerSetup->getEavConfig()
            ->getAttribute(CustomerMetadataInterface::ENTITY_TYPE_CUSTOMER, self::FAVOURITE_GRIND)
            ->addData([
                'attribute_set_id' => $attributeSetId,
                'attribute_group_id' => $attributeGroupId,
                'used_in_forms' => ['adminhtml_customer', 'customer_account_create', 'customer_account_edit'],
            ]);
        $attribute->save();

        $this->moduleDataSetup->getConnection()->endSetup();

        return $this;
    }

    public function revert(): void
    {
        $this->moduleDataSetup->getConnection()->startSetup();
        /** @var CustomerSetup $customerSetup */
        $customerSetup = $this->customerSetupFactory->create(['setup' => $this->moduleDataSetup]);
        $customerSetup->removeAttribute(CustomerMetadataInterface::ENTITY_TYPE_CUSTOMER, self::FAVOURITE_GRIND);
        $this->moduleDataSetup->getConnection()->endSetup();
    }

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

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

eav_attribute            146  entity_type_id 1  pc_favourite_grind  varchar  select  source_model ...Grind
eav_entity_attribute     145  attribute_set 1, group 1, attribute 146, sort_order 200
customer_eav_attribute   146  is_visible 1, is_system 0, sort_order 200
customer_form_attribute  adminhtml_customer, customer_account_create, customer_account_edit -> 146

curl -s -X POST localhost:8082/rest/V1/customers \
  -H "Authorization: Bearer <admin-token>" -H "Content-Type: application/json" \
  -d '{"customer":{"email":"ada@example.test","firstname":"Ada","lastname":"Lovelace","website_id":1,"group_id":1,
       "custom_attributes":[{"attribute_code":"pc_favourite_grind","value":"espresso"}]},
       "password":"<a-test-password>"}'

<?php

declare(strict_types=1);

namespace PocketCoffee\Eav\Setup\Patch\Data;

use Magento\Catalog\Model\Category;
use Magento\Eav\Model\Entity\Attribute\ScopedAttributeInterface;
use Magento\Eav\Setup\EavSetup;
use Magento\Eav\Setup\EavSetupFactory;
use Magento\Framework\Setup\ModuleDataSetupInterface;
use Magento\Framework\Setup\Patch\DataPatchInterface;
use Magento\Framework\Setup\Patch\PatchRevertableInterface;

/**
 * Adds a "roast story" text attribute to categories.
 */
class AddCategoryAttribute implements DataPatchInterface, PatchRevertableInterface
{
    public const ROAST_STORY = 'pc_roast_story';

    public function __construct(
        private readonly ModuleDataSetupInterface $moduleDataSetup,
        private readonly EavSetupFactory $eavSetupFactory
    ) {
    }

    public function apply(): self
    {
        $this->moduleDataSetup->getConnection()->startSetup();
        /** @var EavSetup $eavSetup */
        $eavSetup = $this->eavSetupFactory->create(['setup' => $this->moduleDataSetup]);
        $eavSetup->addAttribute(Category::ENTITY, self::ROAST_STORY, [
            'type' => 'text',
            'label' => 'Roast story',
            'input' => 'textarea',
            'required' => false,
            'sort_order' => 90,
            'global' => ScopedAttributeInterface::SCOPE_STORE,
            'wysiwyg_enabled' => true,
            'is_html_allowed_on_front' => true,
            'group' => 'General Information',
        ]);
        $this->moduleDataSetup->getConnection()->endSetup();

        return $this;
    }

    public function revert(): void
    {
        $this->moduleDataSetup->getConnection()->startSetup();
        /** @var EavSetup $eavSetup */
        $eavSetup = $this->eavSetupFactory->create(['setup' => $this->moduleDataSetup]);
        $eavSetup->removeAttribute(Category::ENTITY, self::ROAST_STORY);
        $this->moduleDataSetup->getConnection()->endSetup();
    }

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

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

<?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="content">
        <field name="pc_roast_story" sortOrder="90" formElement="textarea">
            <argument name="data" xsi:type="array">
                <item name="config" xsi:type="array">
                    <item name="source" xsi:type="string">category</item>
                </item>
            </argument>
            <settings>
                <dataType>text</dataType>
                <label translate="true">Roast story</label>
                <dataScope>pc_roast_story</dataScope>
            </settings>
        </field>
    </fieldset>
</form>

value_id  attribute_id  store_id  entity_id  value
2         145           1         2          Roasted every Tuesday in small batches.
3         145           0         2          Roasted every Tuesday in small batches (all scopes).

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Api/etc/extension_attributes.xsd">
    <extension_attributes for="Magento\Catalog\Api\Data\ProductInterface">
        <attribute code="days_since_roast" type="int"/>
    </extension_attributes>
</config>

<?php

declare(strict_types=1);

namespace PocketCoffee\Eav\Plugin;

use Magento\Catalog\Api\Data\ProductInterface;
use Magento\Catalog\Api\Data\ProductSearchResultsInterface;
use Magento\Catalog\Api\ProductRepositoryInterface;
use PocketCoffee\Eav\Setup\Patch\Data\AddProductAttributes;

/**
 * Fills the days_since_roast extension attribute on products returned by the repository.
 */
class AddDaysSinceRoast
{
    public function afterGet(ProductRepositoryInterface $subject, ProductInterface $product): ProductInterface
    {
        return $this->addDays($product);
    }

    public function afterGetList(
        ProductRepositoryInterface $subject,
        ProductSearchResultsInterface $searchResults
    ): ProductSearchResultsInterface {
        foreach ($searchResults->getItems() as $product) {
            $this->addDays($product);
        }

        return $searchResults;
    }

    private function addDays(ProductInterface $product): ProductInterface
    {
        $attribute = $product->getCustomAttribute(AddProductAttributes::ROAST_DATE);
        if ($attribute === null || !$attribute->getValue()) {
            return $product;
        }
        $roasted = new \DateTimeImmutable((string) $attribute->getValue());
        $days = (int) $roasted->diff(new \DateTimeImmutable('today'))->format('%r%a');

        $extension = $product->getExtensionAttributes();
        $extension->setDaysSinceRoast($days);
        $product->setExtensionAttributes($extension);

        return $product;
    }
}