When you programmatically create a field with the option "locked => TRUE", there can be errors. [#1720576]

When you programmatically create a field with the option "locked => TRUE" there can be errors like:

- Notice: Undefined index: description in token_form_field_ui_field_edit_form_alter() (line 715 of /sites/all/modules/token/token.module).
- Notice: Undefined index: #description in token_form_field_ui_field_edit_form_alter() (line 715 of /sites/all/modules/token/token.module).

The $form['instance'] variable should be empty, but this does not always happen.

Comment	File	Size	Author
#1	field-locked-test-1720576.patch	453 bytes	daffie
#1

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Comment #1

daffie CreditAttribution: daffie commented 9 August 2012 at 11:24

File	Size
field-locked-test-1720576.patch	453 bytes

I have made a patch. Please review it.

Comment #2

Dave Reid

he/him

English

Nebraska USA

CreditAttribution: Dave Reid commented 10 August 2012 at 16:41

Status:

Active

» Postponed (maintainer needs more info)

I'm not able to duplicate this with just core + Token module. What type of field type should I add which should be locked?

Comment #3

daffie CreditAttribution: daffie commented 11 August 2012 at 05:51

To get the errors you need core + Token + Custom add another modules.
If you create a field instance programmatically with the option "locked => TRUE" and you go to the field_ui_field_edit_form, you should get a message like "The field XXX is locked and cannot be edited.".
You only get the message, there is no form data. This is part of field_create_field() function.

The hook_form_field_ui_field_edit_form_alter function from the Custom add another module adds a form item to the $form['#instance']. The token module only test if the $form['#instance'] is empty. If it is not then it does a string attach to the variable $form['instance']['description']['#description'].
I think that it is wise to not only test if $form['#instance'] is empty, but also to test $form['#field']['locked'] to see of the field instance is locked.

I do not know if there is an explicit understanding that if a field instance is created with the option "locked => true" that the variable $form['#instance'] must be empty. And that every module can expect that. Even if you expect that, I think that it is wise to add the extra check to test if the field instance is locked.