Contrib.social

MapItem violates FieldItemInterface::schema()'s contract - breaks widgets

Open on Drupal.org →
Created on 18 June 2017, about 8 years ago
Updated 1 February 2023, over 2 years ago

Problem/Motivation

Originally raised this in #2563843-37: MapItem is broken for configurable fields → but now splitting this off into its own issue.

FieldItemInterface::schema() states:

  /**
   * ...
   *
   * @return array
   *   An empty array if there is no schema, or an associative array with the
   *   following key/value pairs:
   *   - columns: An array of Schema API column specifications, keyed by column
   *     name. The columns need to be a subset of the properties defined in
   *     propertyDefinitions().
   * ...
   */

So since MapItem::schema() returns a value column, you would expect that there must be a value property defined by MapItem::propertyDefinitions().

That is no longer the case, however, since #2229181: MapItem::propertyDefinitions() claims it has a static value property, which is wrong → .

Besides clearly being a violation of the API, this breaks any widget that you try to write for MapItem as widgets rely on the aforementioned relationship between schema columns and properties. Possibly other things are broken as well, but this is the one I encountered.

Proposed resolution

Roll back #2229181: MapItem::propertyDefinitions() claims it has a static value property, which is wrong → .

🐛 Bug report
Status

Needs work

Version

10.1 ✨

Component
Field  →

Last updated 2 days ago

Created by

🇩🇪Germany tstoeckler Essen, Germany

Live updates comments and jobs are added and updated live.
  • Needs tests

    The change is currently missing an automated test that fails when run with the original code, and succeeds when the bug has been fixed.

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.

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024