Provide config schema to field types, widgets and storage in entity_reference module [#1983902]

Follow up for #1953404: Add config schema to field and instance config entities

Problem/motivation

#1866610: Introduce Kwalify-inspired schema format for configuration introduced the idea of config schema. The changelog leads to (hopefully extensive) documentation on the format at http://drupal.org/node/1905070. As a part of schema addition to field module(#1953404: Add config schema to field and instance config entities), found that we have to provide schema for field types, field widgets and field storage.

Proposed solution

Create a configuration schema for field types, field widget and field storage (if applicable) defined in entity_reference module.
Schema in place

Schema not in place
field.entity_reference.settings
field.entity_reference.instance_settings
field.entity_reference.value

field_widget.entity_reference_autocomplete.settings
field_widget.entity_reference_autocomplete_tags.settings

Comment	File	Size	Author
#17	1983902-config-schema-entity_reference-17.patch	2.79 KB	vijaycs85
#17
#17	1983902-diff-15-17.txt	1.4 KB	vijaycs85
#15	1983902-config-schema-entity_reference-15.patch	2.79 KB	vijaycs85
#15
#15	1983902-diff-14-15.txt	1.08 KB	vijaycs85
#14	1983902-config-schema-entity_reference-14.patch	2.37 KB	vijaycs85
#14
#14	1983902-diff-10-14.txt	2.59 KB	vijaycs85
#10	interdiff.txt	644 bytes	swentel
#10	1983902-field-config-schema-entity-reference-10.patch	1.44 KB	swentel
#10
#4	1983902-field-config-schema-entity-reference-4.patch	1.53 KB	piyuesh23
#4
#1	field.field_.entity_reference.png	35.98 KB	vijaycs85
#1	field.instance.entity_reference.png	51.19 KB	vijaycs85
#1	1983902-field-config-schema-entity-reference-1.patch	2.3 KB	vijaycs85
#1

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Comment #1

vijaycs85

London, UK

CreditAttribution: vijaycs85 commented 7 May 2013 at 12:35

Status:

Active

» Needs review

File	Size
1983902-field-config-schema-entity-reference-1.patch	2.3 KB

field.instance.entity_reference.png	51.19 KB
field.field_.entity_reference.png	35.98 KB

Issuing initial patch with config inspector screenshots.

Comment #2

amateescu CreditAttribution: amateescu commented 11 June 2013 at 12:19

Status:

Needs review

» Reviewed & tested by the community

Looks good to me.

Comment #3

amateescu CreditAttribution: amateescu commented 11 June 2013 at 12:27

Status:

Reviewed & tested by the community

» Needs work

Actually, that's not right. Widget definitions have been moved out of the instance definition in #1875992: Add EntityFormDisplay objects for entity forms.

Comment #4

piyuesh23 CreditAttribution: piyuesh23 at QED42 commented 25 September 2015 at 11:41

File	Size
1983902-field-config-schema-entity-reference-4.patch	1.53 KB

Removed widget definitions from schema. Attaching the fixed patch.

Comment #5

piyuesh23 CreditAttribution: piyuesh23 commented 29 June 2013 at 11:19

Status:

Needs work

» Needs review

Comment #6

piyuesh23 CreditAttribution: piyuesh23 commented 5 July 2013 at 13:50

Tested and the schema is working fine. Tested using config inspector.

Comment #7

piyuesh23 CreditAttribution: piyuesh23 commented 5 July 2013 at 13:50

Status:

Needs review

» Reviewed & tested by the community

Comment #8

vijaycs85

London, UK

CreditAttribution: vijaycs85 commented 5 July 2013 at 15:30

Status:

Reviewed & tested by the community

» Needs review

@piyuesh23 lets get one more review before RTBC :)

Comment #9

aspilicious CreditAttribution: aspilicious commented 11 December 2013 at 19:09

Issue summary:	View changes
Status:	Needs review	» Needs work

user register form key is obsolete now

Comment #10

swentel CreditAttribution: swentel commented 11 December 2013 at 20:09

Status:

Needs work

» Needs review

File	Size
1983902-field-config-schema-entity-reference-10.patch	1.44 KB

interdiff.txt	644 bytes

Comment #11

amateescu CreditAttribution: amateescu commented 11 December 2013 at 20:18

+++ b/core/modules/entity_reference/config/schema/entity_reference.schema.yml
@@ -0,0 +1,48 @@
+field.entity_reference.value:
...
+          label: 'Value'

Shouldn't this be 'field.entity_reference.target_id' and 'Target ID'?

Comment #12

vijaycs85

London, UK

CreditAttribution: vijaycs85 commented 11 December 2013 at 20:32

Assigned:

Unassigned

» vijaycs85

We got more than just field implementation as part of this issue. Check https://gist.github.com/vijaycs85/7917782 for more details...

Comment #13

vijaycs85

London, UK

CreditAttribution: vijaycs85 commented 11 December 2013 at 20:32

Status:

Needs review

» Needs work

Comment #14

vijaycs85

London, UK

CreditAttribution: vijaycs85 commented 12 December 2013 at 18:11

Status:

Needs work

» Needs review

File	Size
1983902-diff-10-14.txt	2.59 KB
1983902-config-schema-entity_reference-14.patch	2.37 KB

Updating with views & default entity_reference plugins... remaining to follow...

Comment #15

vijaycs85

London, UK

CreditAttribution: vijaycs85 commented 13 December 2013 at 00:55

Assigned:

vijaycs85

» Unassigned

File	Size
1983902-diff-14-15.txt	1.08 KB
1983902-config-schema-entity_reference-15.patch	2.79 KB

Ok, just did a full scan of entity_reference in our code base and here are the findings:

We got just two groups: default and views.
Except views all other entity reference fall under default
There are three type of entity_references under default
1. No fields in reference type
2. Using existing(target_bundles & sort) fields in reference type
3. Adding new fields to reference type (just two: User[filter] & Taxonomy[auto_create])

The patch in #14 covers all listed above except 3.3. Here is the patch for it.

Comment #16

amateescu CreditAttribution: amateescu commented 13 December 2013 at 00:25

+++ b/core/modules/entity_reference/config/schema/entity_reference.schema.yml
@@ -0,0 +1,68 @@
+      label: 'Create referenced entities if they don''t already exist'

Is '' allowed/the correct syntax? Couldn't we just wrap the whole string in "" ?

+++ b/core/modules/entity_reference/config/schema/entity_reference.schema.yml
@@ -0,0 +1,68 @@
+    filter:
...
+    target_bundles:
...
+    sort:
...
+    auto_create:

I think the correct order (by how they are defined/importance) would be:
- target_bundles
- sort
- filter
- auto_create

Comment #17

vijaycs85

London, UK

CreditAttribution: vijaycs85 commented 13 December 2013 at 00:39

File	Size
1983902-diff-15-17.txt	1.4 KB
1983902-config-schema-entity_reference-17.patch	2.79 KB

@amateescu, thanks for the quick response...

Reg:
#16.1 - Yes, single quotes is the escape character in yml and we have done in lots of places (Can check with reg search [a-zA-Z]+''[a-zA-Z]+)

#16.2 - Order of the fields really not fixed. sometimes it gets changed whenever we save config (view config is a good example.), but I just updated it as we want them in this order...