[meta] Document service name interfaces

Created on 11 October 2014, over 10 years ago

Updated 14 April 2025, 8 days ago

Problem/Motivation

Say, you have a service called access_manager. What can I do with? For AccessManager it's easy because it only implements one interface but other classes might have 5-6 interfaces scattered in 2-3 ancestors.

Proposed resolution

Add * Service name: access_manager to the AccessManagerInterface so that it's possible to grep for this exact string. Repeat and rinse for every Drupal service in *.services.yml except "plain" event subscribers. When in doubt, ask. router.route_provider needs to be documented but router.route_preloader doesn't. Most services make this easy because they are called something_subscriber, these don't require documentation without a doubt.

If a class implements more than one interface

class AccessManager implements AccessManagerInterface, ContainerAwareInterface

choose the one sounding specific: AccessManagerInterface. When in doubt, ask.

Remaining tasks

Do it!

User interface changes

API changes

None.

📌 Task

Status

Postponed: needs info

Version

11.0 🔥

Component

documentation

Created by

🇨🇦Canada chx

Live updates comments and jobs are added and updated live.

stale-issue-cleanup
To track issues in the developing policy for closing stale issues, [Policy, no patch] closing older issues

Incomplete comments

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Comment 8 days ago →
🇺🇸United States smustgrave
Thank you for creating this issue to improve Drupal.

We are working to decide if this task is still relevant to a currently supported version of Drupal. There hasn't been any discussion here for over 8 years which suggests that this has either been implemented or is no longer relevant. Your thoughts on this will allow a decision to be made.

Since we need more information to move forward with this issue, the status is now Postponed (maintainer needs more info). If we don't receive additional information to help with the issue, it may be closed after three months.

Thanks!

contrib.social Blog FAQ Discussions

Production build 0.71.5 2024