PluginBase api documentation shows no methods or properties

Created on 13 August 2024, 8 months ago
Updated 14 August 2024, 8 months ago

PluginBase (core/lib/Drupal/Core/Plugin/PluginBase.php) API documentation shows NO methods or properties:

PluginBase plays a fundamental role in Drupal, not only in Drupal core but also in most contributed modules. You can see from the image that 46 plugins in Drupal core alone explicitly extend this base class.

But the current documentation shows NOTHING about this class. See the above image. This is clearly on the face of it wrong, because as you can see PluginBase implements two interfaces and uses three Traits, as well as extending another class. Yet NONE of the inherited methods or properties are listed in the documentation. And the parent class documentation is NOT linked in the Hierarchy section - it appears in plain text rather than a link to the parent class documentation.

Perhaps the absence of a link to the parent class is due to problems with the parser not dealing with use Drupal\Component\Plugin\PluginBase as ComponentPluginBase; correctly?

Perhaps the missing methods/properties are due to the fact that PluginBase is an abstract class and that it inherits everything from other classes/interfaces/traits?

But abstract classes, Traits, and aliasing in use statements are old features in PHP - there is no reason these things should be confusing the parser.

Regardless, this is just one of many classes where the API documentation is fundamentally broken and missing vital information. Because this is a major class, perhaps finding the cause here and fixing this one will have a cascade effect on improving the documentation.

I've chosen "Critical" for this issue because this is just fundamentally broken. And it used to work. And it's not just a simple parser problem where the parser hasn't caught up to the current version of PHP, and it breaks almost every single bit of contributed module documentation I have written over the years because now all the links are dead.

πŸ› Bug report
Status

Active

Version

2.0

Component

Code

Created by

πŸ‡ΊπŸ‡ΈUnited States tr Cascadia

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

Comments & Activities

Production build 0.71.5 2024