Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added a method to remove an attribute from a group in EavSetup #39618

Open
wants to merge 3 commits into
base: 2.4-develop
Choose a base branch
from

Conversation

stollr
Copy link
Contributor

@stollr stollr commented Feb 11, 2025

Description (*)

The EavSetup class provides methods to add EAV attributes, groups and sets. There are also corresponding methods to remove those records. But there is no opposite to addAttributeToGroup. This commit adds a removeAttributeFromGroup method, which fixes this lack.

An integration test which ensures that the method works, was added, too.

Related Pull Requests

  1. This PR depends on Added app isolation attribute to tests in EavSetupTest #39617

Fixed Issues (if relevant)

  1. Fixes Add a method to remove an attribute from a group in EavSetup community-features#346

Manual testing scenarios (*)

  1. Add a data upgrade setup script with the following content:
$eavSetup = $this->eavSetupFactory->create(['setup' => $setup]);
$eavSetup->addAttribute(Product::ENTITY, 'test_attribute', [
    'type' => 'varchar',
    'label' => 'Test attribute',
    'input' => 'text',
    'required' => false,
    'global' => ScopedAttributeInterface::SCOPE_GLOBAL,
]);
$eavSetup->addAttributeToGroup(Product::ENTITY, 'Default', 'General', 'test_attribute');
$eavSetup->removeAttributeFromGroup(Product::ENTITY, 'Default', 'General', 'test_attribute');
  1. Check if the attribute was correctly removed from the group (eav_entity_attribute table)

Contribution checklist (*)

  • Pull request has a meaningful description of its purpose
  • All commits are accompanied by meaningful commit messages
  • All new or changed code is covered with unit/integration tests (if applicable)
  • All automated tests passed successfully (all builds are green)

because the affect global state (adding error messages to the `Magento\Eav\Model\Validator\Attribute\Code` service) which will affect further tests that try to add eav attributes.

This change fixes magento#39616.
Copy link

m2-assistant bot commented Feb 11, 2025

Hi @stollr. Thank you for your contribution!
Here are some useful tips on how you can test your changes using Magento test environment.
❗ Automated tests can be triggered manually with an appropriate comment:

  • @magento run all tests - run or re-run all required tests against the PR changes
  • @magento run <test-build(s)> - run or re-run specific test build(s)
    For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names.

Allowed build names are:
  1. Database Compare
  2. Functional Tests CE
  3. Functional Tests EE
  4. Functional Tests B2B
  5. Integration Tests
  6. Magento Health Index
  7. Sample Data Tests CE
  8. Sample Data Tests EE
  9. Sample Data Tests B2B
  10. Static Tests
  11. Unit Tests
  12. WebAPI Tests
  13. Semantic Version Checker

You can find more information about the builds here
ℹ️ Run only required test builds during development. Run all test builds before sending your pull request for review.


For more details, review the Code Contributions documentation.
Join Magento Community Engineering Slack and ask your questions in #github channel.

@engcom-Hotel engcom-Hotel added Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it Priority: P2 A defect with this priority could have functionality issues which are not to expectations. labels Feb 11, 2025
The EavSetup class provides methods to add EAV attributes, groups and sets. There are also corresponding methods to remove those records. But there is no opposite to `addAttributeToGroup`. This commit adds a `removeAttributeFromGroup` method, which fixes this lack.

This addition addresses magento/community-features#346
@stollr stollr force-pushed the eavsetup_remove_attribute_from_group branch from 3aeb3b9 to 9cd7680 Compare February 13, 2025 10:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a method to remove an attribute from a group in EavSetup
2 participants