Media Gallery behavior when duplicating a product: Keep/Skip product images

[m-michalis]

Description

I'm splitting up the work in 3 PRs after @addison74's comment in

• Fix media gallery actions on duplicate and product deletion procedures #5026

Parts:

• Keep/Skip product images (this pr): Ask whether to keep or skip product images on "Duplicate" + configuration for automating this behavior
• Delete product/images: Whether to physically delete images on either when removing images from a product and/or deleting a product + configuration for default behavior.
• Use new copied images: Copy and actually use copied images on new duplicated product (bug for many years) + propagate store values correctly regarding image, small_image, thumbnail attributes

This PR: Keep/Skip product images

• Configuration option System > Configuration > Catalog > Product Image > Skip Images on Duplicate (always ask, skip, keep)
• Prompt user on "Duplicate" click button.
• Added

   // ..
   * @method bool getSkipImagesOnDuplicate()
   * @method $this setSkipImagesOnDuplicate(bool $value)
   // ..
   class Mage_Catalog_Model_Product // ..

• Translation strings
• Tests

Questions or comments

Need help in adding tests

[sreichel]

Much thanks.

Please run phpcs-fixer and phpstan. Some errors should be fixed via suggestions.

I'd add constants for options, of -1, 0 and 1.

Please revert changes for trailing spaces.

[sreichel]

@m-michalis do you have time to re-review? Next release is planed in a few days. Would be nice to have it in.

[m-michalis]

@m-michalis do you have time to re-review? Next release is planed in a few days. Would be nice to have it in.

@sreichel i was overloaded for the past month. i'll try committing some hours in the next weeks.

[addison74]

I'll take the time to check a few PRs, this being one of them.

@m-michalis: PHP CS Fixer errors are easy to fix, the GitHub interface shows what they are, unless you use the command line in a DDEV test environment.

Also please let me know your opinion about this implementation https://github.com/MahoCommerce/maho/pull/345/files. Do we need a simple or configurable one?

[m-michalis]

@addison74

@m-michalis: PHP CS Fixer errors are easy to fix, the GitHub interface shows what they are, unless you use the command line in a DDEV test environment.

I use DDEV. any tips?

Also please let me know your opinion about this implementation https://github.com/MahoCommerce/maho/pull/345/files. Do we need a simple or configurable one?

Opinion on what? From my experience it depends on the store. I've only seen 2 cases required, "always ask" and "skip images". I don't believe a store would use "always copy images" on product clone though.

@sreichel

#5083 (comment)
Please revert changes for trailing spaces.
which trailing spaces?

[sreichel]

• PHP CS Fixer and all other tools have ...
  • a DDEV command (ddev php-cs-fixer, ddev rector, ...)
  • a script in composer.json (compser run php-cs-fixer:fix, ...)
• Having "copy always" makes no sense to me.
• Ignore my comment about the spaces. Its okay.
• Mage_Adminhtml_Model_System_Config_Source_Catalog_ImageDuplicate
  • has no copyright block
  • should have declare_strict set as new class

[addison74]

My comments

1. Skip Images on Duplicate can create confusion because it is not about the skip action, it is more than that. Here are a few ideas: "Product Images Handling on Duplicate", "Handle Product Images When Duplicating".
2. The comment must be improved as follows The 'Ask' option only appears in the Admin interface. Programmatic duplication always preserves images.

---

My comments

1. Proposed dropdown order for product image duplication:

Always Ask → First

• Puts control in the admin’s hands.
• Ensures a conscious decision is made for each product duplication.
• Prioritizing user interaction encourages careful handling of media.

Duplicate Product Without Images → Second

• Modern and safe default for optimizing storage.
• Encourages efficient media usage by not duplicating unnecessary files.
• Makes it easy for admins to create duplicates without bloating the media folder.

Copy Images to the New Product → Last

• Keeps Magento’s original behavior available as a fallback.
• Not promoted as the default choice to discourage automatic file duplication.
• Only use when true duplication of images is necessary for business reasons.

2. Better option names:

• Always ask: Ask before duplicate, Prompt before duplicate, Confirm before duplicate
• Copy images to the new product: Duplicate product with images (actually it is not just copy, it is a copy and rename action)
• Duplicate product without images: OK

[addison74]

Regarding the window content.

This is my proposal for this window:

Title: Duplicate Product
Question: This product has images. Do you want to create a duplicate product that includes them?
Buttons: Duplicate with images (left) and Duplicate without images (right)

Here is the visual result

[addison74]

I appreciated the prompt is correctly displayed only when the product has images; and it is skipped when there are no images, which improves the UX significantly. Great work, just check my previous comments and improve.

[m-michalis]

@sreichel @addison74 i've done some changes, see last commit.

how is it formatting with spaces? which tool does this? i have wrong configuration? i mean with:

 * @method int                                                getEntityTypeId()
 * @method bool                                               getForceReindexRequired()
 * @method array                                              getGroupedLinkData()

vs

 * @method int getEntityTypeId()
 * @method bool getForceReindexRequired()
 * @method array getGroupedLinkData()

can't resolve this. Could you shed some light on this?

[addison74]

@m-michalis - the conflict is solved. The first formatting is the correct one. Please check the file again if I missed something from the docblock.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
1 Accepted issue

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[sreichel]

how is it formatting with spaces? which tool does this?

its php-cs-fixer ... check scripts section in composer.json to automatically fix it.

[addison74]

I would like to get PR ready on the next version, as it was proposed two months ago.

We have to discuss the texts used in the config area, then the title, content and buttons of the window (remained unchanged in its initial form). We will revise the code later. At first glance it looks fine but there are some getters and setters there. We'll see...

[sreichel]

I would like to get PR ready on the next version, as it was proposed two months ago.

You can change milestones too.

As we have progess here thats fine.

[addison74]

All right then. We will approve it then I will create a PR for solving the texts and especially the window which is not looking good.