Update typing for plugin definition to include object

Reading CR, believe the update is correct.

I'm triaging RTBC issues. I read the IS and the comments. I didn't find any unanswered questions or other work to do.

Leaving at RTBC.

Backported as a docs-only improvement.

Committed and pushed ed6f70f8b8 to 11.x and c3ceee3d74 to 10.3.x and 2a7b91d0d4 to 10.2.x. Thanks!

We're having CI failures on our app with Drupal 10.2.4, which passes under Drupal 10.2.3, and this appears to be the relevant change.

Error: Cannot access offset 'id' on array|Drupal\Component\Plugin\Definition\PluginDefinitionInterface.
 ------ --------------------------------------------------------------------- 
  Line   src/ActiveSitePluginBase.php                                         
 ------ --------------------------------------------------------------------- 
  54     Cannot access offset 'id' on                                         
         array|Drupal\Component\Plugin\Definition\PluginDefinitionInterface.  
 ------ --------------------------------------------------------------------- 

The triggering code:

  /**
   * {@inheritdoc}
   */
  public function id(): string {
    return $this->pluginDefinition['id'];
  }

This should still be correct usage, shouldn't it? Core is still full of instances of $this->pluginDefinition['key'].

@mikeryan you likely have a higher phpstan level than core. I think you might need to change to something like this:

  public function id(): string {
    if (is_array($this->pluginDefinition)) {
      return $this->pluginDefinition['id'];
    }
    return $this->pluginDefinition->id();
  }

Or coerce phpstan in to believing pluginDefinition is always an array:

  public function id(): string {
      assert(is_array($this->pluginDefinition));
      return $this->pluginDefinition['id'];
  }

Edit:

Or you could probably override the typehint on the property in your plugin class:

  /**
   * The plugin definition.
   *
   * @var array
   */
  protected $pluginDefinition;

@mstrelan Thanks! assert() did the job nicely...