Contrib.social

ImageStyle::getReplacementID missing from interface

Open on Drupal.org →
Created on 9 January 2025, 3 months ago

Problem/Motivation

ImageStyle::getReplacementID is written like its implementing an interface but it doesn't exist on the interface:


  /**
   * {@inheritdoc}
   */
  public function getReplacementID() {

This means the method doesn't actually have any documentation.

Steps to reproduce

Code issue. You'll have to look at ImageStyle.php and ImageStyleInterface.php or see the missing hints in your IDE.

Proposed resolution

Add method to interface and document the method.

Remaining tasks

User interface changes

Introduced terminology

API changes

Data model changes

Release notes snippet

🐛 Bug report
Status

Active

Version

11.1 🔥

Component

image system

Created by

🇺🇸United States neclimdul Houston, TX

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

  • Issue created by @neclimdul
  • Comment 3 months ago →
    🇺🇸United States neclimdul Houston, TX

    This actually shows up in the phpstan report as well.

    I think this might actually be a dead method as well so removing it might also be an option. It just proxies through to the storage method of the similar name(different capitalization) and using that might be the correct way of accomplishing this.

  • Comment 3 months ago →
    🇳🇿New Zealand quietone
  • First commit to issue fork.
  • Merge request !10902Issue #3498540: Added method to ImageStyleInterface → (Open) created by shalini_jha
  • Pipeline finished with Failed
    3 months ago
    Total: 106s
    #395588
  • Pipeline finished with Success
    3 months ago
    Total: 398s
    #395595
  • Comment 3 months ago →
    🇺🇸United States neclimdul Houston, TX

    Looks good for the straightforward fix.

    Will leave questions of the not strictly camelcacse code and possible code removal to committer review and RTBC this.

  • Comment 3 months ago →
    🇳🇿New Zealand quietone

    If it really isn't used we should deprecate it now instead of postponing that..

    I didn't find usages in core. I didn't find one in contrib either. Did I miss a usage? Can someone check on that?

  • Comment 3 months ago →
    🇮🇳India shalini_jha

    @quietone You are correct. I have also checked the usage of ImageStyle::getReplacementID, and I could not find any.

  • Comment about 2 months ago →
    🇬🇧United Kingdom catch

    I think @quietone is right and we should deprecate this instead.

  • Pipeline finished with Success
    about 7 hours ago
    Total: 846s
    #481005
  • Status changed to Needs review about 7 hours ago
  • Comment about 7 hours ago →
    🇮🇳India shalini_jha

    I’ve deprecated the getReplacementID() method after confirming it isn’t used in core or contrib, and I followed a similar approach to other deprecated methods. Moving this NR , Could you please review and let me know if anything needs to be updated or improved?

    Thank you for the guidance!

  • Comment about 2 hours ago →
    🇺🇸United States smustgrave

    Feedback appears to be addressed.

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024