Contrib.social

InlineEntityFormBase::getEntityTypeLabels() has the wrong docblock

Open on Drupal.org →
Created on 10 January 2024, almost 2 years ago
Updated 15 February 2024, over 1 year ago

See InlineEntityFormBase::getEntityTypeLabels().

  /**
   * Gets the entity type managed by this handler.
   *
   * @return \Drupal\Core\Entity\EntityTypeInterface
   *   The entity type.
   */
  protected function getEntityTypeLabels() {
    // The admin has specified the exact labels that should be used.
    if ($this->getSetting('override_labels')) {
      return [
        'singular' => $this->getSetting('label_singular'),
        'plural' => $this->getSetting('label_plural'),
      ];
    }
    else {
      $this->createInlineFormHandler();
      return $this->inlineFormHandler->getEntityTypeLabels();
    }
  }

I was studying the code related to 📌 Remove hardcoded word 'entities' in EntityInlineForm::getEntityTypeLabels() Fixed when I noticed that the return type of this docblock is wrong. Then I noticed that it's just completely unrelated. I'm kind of surprised that PHPStan didn't pick up on this. It found other incorrect return types at level 1.

Anyone attempting to patch this should probably check the other functions in the class for the same problem. Maybe some docblocks accidentally got swapped or something.

📌 Task
Status

RTBC

Version

3.0

Component

Documentation

Created by

🇺🇸United States dcam

Live updates comments and jobs are added and updated live.
  • Novice

    It would make a good project for someone who is new to the Drupal contribution process. It's preferred over Newbie.

Sign in to follow issues

Merge Requests

Comments & Activities

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024