API page: https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21Entity%21...

> bundles: The bundles in which the field appears.

This should state that both the keys and values in the bundles array are bundle names -- in other words, each key => value pair is identical.

CommentFileSizeAuthor
#4 interdiff-2700491-1-4.txt1.36 KBpushpinderchauhan
#4 D8-getFieldMap-docs-2700491-4.patch1.28 KBpushpinderchauhan
#2 D8-getFieldMap-docs-2700491-1.patch1.17 KBpushpinderchauhan

Comments

joachim created an issue. See original summary.

pushpinderchauhan’s picture

pushpinderchauhan commented
Status: Active » Needs review
StatusFileSize
new D8-getFieldMap-docs-2700491-1.patch1.17 KB

Updated the same for getFieldMapByFieldType() too, please review.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Needs review » Needs work

Thanks for the issue and patch!

+++ b/core/lib/Drupal/Core/Entity/EntityFieldManagerInterface.php
@@ -73,7 +73,8 @@ public function getFieldStorageDefinitions($entity_type_id);
-   *   - bundles: The bundles in which the field appears.
+   *   - bundles: The bundles array in which both the keys and values are
+   *     identical.

Hm. This is not very clear, and we've lost the information about "in which the field appears". How about something like:

bundles: An associative array of the bundles in which the field appears, where the keys and values are both the bundle's machine name.

pushpinderchauhan’s picture

pushpinderchauhan commented
Status: Needs work » Needs review
StatusFileSize
new D8-getFieldMap-docs-2700491-4.patch1.28 KB
new interdiff-2700491-1-4.txt1.36 KB

Thank you! Please review again.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Needs review » Reviewed & tested by the community

Thanks!

alexpott’s picture

alexpott
he/they
Primary language English
Location 🇪🇺🌍
commented
Status: Reviewed & tested by the community » Fixed

Committed 06d6e22 and pushed to 8.1.x and 8.2.x. Thanks!

As a documentation improvement this is eligible for commit during the 8.1.x RC.

  • alexpott committed 9533835 on 8.2.x 
    Issue #2700491 by er.pushpinderrana, jhodgdon: getFieldMap() should...

  • alexpott committed 06d6e22 on 8.1.x 
    Issue #2700491 by er.pushpinderrana, jhodgdon: getFieldMap() should...

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.