Contrib.social

Name typed data interface methods unambiguously

Open on Drupal.org →
Created on 15 May 2014, over 11 years ago
Updated 18 August 2025, 23 days ago

Motivation

Field items and field item lists implement the typed data interface, what leads to same confusing method names.

Proposed resolution

Let's rename them:

Taken from #2002138-51: Use an adapter for supporting typed data on ContentEntities → and updated:

  • getDefinition() -> getDataDefinition()
  • getName() + getParent() -> getDataContext()
  • setContext() - either rename to e.g. setDataContext() or remove in #2268009: Make typed data object instantiation more flexible →
  • getPropertyPath() -> replace with a method on the manager working based on getDataContext() (it's hardly used anyway)
  • getRoot() -> replace as getPropertyPath() with a method on the manager, (getEntity() can stay)

Remaining tasks

Do it.

User interface changes

-

API changes

- The method names change. Those methods are on entities, field items, field item lists and field item properties right now.

📌 Task
Status

Postponed: needs info

Version

11.0 🔥

Component

typed data system

Created by

🇦🇹Austria fago Vienna

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

Sign in to follow issues

Comments & Activities

Not all content is available!

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

  • Comment 23 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!

  • Comment 23 days ago →
    🇷🇴Romania amateescu

    I think this is still worth doing.

  • Comment 10 days ago →
    🇦🇹Austria fago Vienna

    This would lead to some API-deprecations, but I think it's all not very frequently used APIs, so I guess to would not be too disruptive.
    I agree that the suggestion still makes sense + would be a rather important change, so increasing to prio to Major.

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024