Quantcast
Viewing all articles
Browse latest Browse all 293450

[meta] Add @internal to core classes, methods, properties

Problem/Motivation

This is a meta issue to organize child issues for applying the Drupal 8 core backwards compatibility policy: https://www.drupal.org/core/d8-bc-policy.

Proposed resolution

Done when all child issues are complete.

Each child issue should apply to each of the following areas on the policy page:

Novice categories that can be done quickly

  • Tests
  • Controllers and Form classes
  • Plugins
  • Entity handlers
  • Param converters
  • Access checkers
  • Event Subscribers
  • JavaScript classes
  • Constructors for service objects
  • Constructors for plugins
  • Constructors for controllers (Is this duplicated by the controller class task above?)
  • Protected methods
  • Protected properties
  • Public properties
  • Public methods
  • Underscore-prefixed functions and methods

Categories that need more time and review

  • PHP classes
  • The Installer: install global functions, install tasks, and classes.
  • Hook implementations

How to fix each child issue

  1. Read the description for a category in its issue
  2. Identify and confirm an example. Ask in IRC if unclear.
  3. Search core for the relevant category.
    • Using PHPStorm's subclass hinting feature. Go to relevant base class (e.g.core/lib/Drupal/Core/Form/FormBase.php) and search for all usages.
    • Add @internal to subclasses that are not base classes. If there is no DocBlock, create one.
    • Add @internal per the backwards compatibility policy.
    • Reviewers should confirm that each @internal mention is appropriate for that category according to the policy.

    Remaining tasks

    • Create child issues. Each issue should:
      • Contain the description of the category in the issue description
      • A link to the this issue and a link to the backwards compatibility policy: https://www.drupal.org/core/d8-bc-policy
      • Tag issue as Novice if the category is listed in the Novice section above.

    User interface changes

    None.

    API changes

    There should be no implicit API changes.


    Viewing all articles
    Browse latest Browse all 293450

    Trending Articles



    <script src="https://jsc.adskeeper.com/r/s/rssing.com.1596347.js" async> </script>