Catalog Swatch Helper Data Access

[kestraly]

Preconditions and environment

Magento 2.4.x

Accessing the catalog swatch helper data directly from templates is not possible. Is there a reason this is not possible?

Steps to reproduce

Add $this->helper('Magento\Swatches\Helper\Data'); in a .phtml template file that is loaded on a catalog page.

Sample Code

$swatchHelper = $this->helper('Magento\Swatches\Helper\Data');

$color_attribute = $_product->getResource()->getAttribute('color');
$color_options = $color_attribute ? $color_attribute->getSource()->getAllOptions() : [];
$colorOptionIds = [];
foreach ($color_options as $color_option) {
    if ($color_option['value']) {
        $colorOptionIds[] = $color_option['value'];
    }
}
$swatchHelper->getSwatchesByOptionsId($colorOptionIds);

Expected result

Access to Catalog Swatch Helper Data to perform tasks such as

Actual result

main.ERROR: Magento\Swatches\Helper\Data doesn't extends Magento\Framework\App\Helper\AbstractHelper when accessing a page using the .phtml template file.

Additional information

Possible solution for Helper vendor/magento/module-swatches/Helper/Data.php

Update from class Data

to

class Data extends \Magento\Framework\App\Helper\AbstractHelper

Release note

No response

Triage and priority

• [ ] Severity: S0 - Affects critical data or functionality and leaves users without workaround.
• [ ] Severity: S1 - Affects critical data or functionality and forces users to employ a workaround.
• [X] Severity: S2 - Affects non-critical data or functionality and forces users to employ a workaround.
• [ ] Severity: S3 - Affects non-critical data or functionality and does not force users to employ a workaround.
• [ ] Severity: S4 - Affects aesthetics, professional look and feel, “quality” or “usability”.

[m2-assistant[bot]]

Hi @kestraly. Thank you for your report. To speed up processing of this issue, make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce. To deploy vanilla Magento instance on our environment, Add a comment to the issue:

• @magento give me 2.4-develop instance - upcoming 2.4.x release
• For more details, review the Magento Contributor Assistant documentation.
• Add a comment to assign the issue: @magento I am working on this

• To learn more about issue processing workflow, refer to the Code Contributions.

  Join Magento Community Engineering Slack and ask your questions in #github channel. :warning: According to the Magento Contribution requirements, all issues must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting. :clock10: You can find the schedule on the Magento Community Calendar page. :telephone_receiver: The triage of issues happens in the queue order. If you want to speed up the delivery of your contribution, join the Community Contributions Triage session to discuss the appropriate ticket.

[m2-assistant[bot]]

Hi @engcom-Hotel. Thank you for working on this issue. In order to make sure that issue has enough information and ready for development, please read and check the following instruction: :point_down:

• [ ] 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).
• [ ] 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue.
• [ ] 3. Add Area: XXXXX label to the ticket, indicating the functional areas it may be related to.
• [ ] 4. Verify that the issue is reproducible on 2.4-develop branch
  Details

  - Add the comment @magento give me 2.4-develop instance to deploy test instance on Magento infrastructure.
  - If the issue is reproducible on 2.4-develop branch, please, add the label Reproduced on 2.4.x.
  - If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!
• [ ] 5. Add label Issue: Confirmed once verification is complete.
• [ ] 6. Make sure that automatic system confirms that report has been added to the backlog.

[engcom-Hotel]

Hello @kestraly,

Thanks for the report and collaboration!

It seems to us an expected behavior, If you still need to use the methods from Magento\Swatches\Helper\Data in your .phtml file, you should create a ViewModel and use dependency injection to get the Magento\Swatches\Helper\Data class. Then, you can create a method in your ViewModel that uses the methods from the helper. You can then call this method from your .phtml file.

Else please let us know your use case if you don't want to create a ViewModel.

Thanks