Quantcast
Channel: Issues for Drupal core
Viewing all articles
Browse latest Browse all 293539

Entity API documentation needs to explain what an "entity handler" is

$
0
0

Problem/Motivation

"Entity handlers" are classes that provide different sorts of functionality for entity types: storage, listing, access control, and so on. They used to be called "controllers" but were renamed because this caused confusion with routing controllers. See #1976158: Rename entity storage/list/form/render "controllers" to handlers.

Currently, however, there is not really any place in our documentation that explains what "handlers" are, and there are still some incorrect references to "controllers".

Proposed resolution

  1. Update the Entity API documentation topic to refer to "handlers" instead of controllers where appropriate, and add a brief explanation of what a "handler" is.
  2. Update the docblocks for EntityHandlerInterface and EntityHandlerBase to briefly explain what a "handler" is, and reference the group documentation for more detail. [Note: see comment #1, where it was suggested just to reference the group documentation for more detail.]
  3. Check for other places in documentation that might still inappropriately refer to "controllers" that are actually entity handlers. Note that most references to "controller" in the Drupal codebase are correct and refer instead to routing controllers.

Remaining tasks

User interface changes

API changes

Beta phase evaluation

Reference: https://www.drupal.org/core/beta-changes
Issue categoryBug because we fix wrong documentation.
Issue priorityNormal because the impact is very limited.
Unfrozen changesUnfrozen because it only changes documentation of the entity API.
Prioritized changesNone
DisruptionNone

Viewing all articles
Browse latest Browse all 293539

Trending Articles



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