Skip to content

Commit ebc4a65

Browse files
paul-mpaul-m
committed
Issue #2102639: Remove usages of #prefix and #suffix per #18
1 parent fdc329f commit ebc4a65

File tree

5 files changed

+60
-51
lines changed

5 files changed

+60
-51
lines changed

‎ajax_example/src/Form/Autotextfields.php

+18-13
Original file line numberDiff line numberDiff line change
@@ -25,45 +25,49 @@ public function buildForm(array $form, FormStateInterface $form_state) {
2525
'#type' => 'checkbox',
2626
'#title' => $this->t('Ask me my first name'),
2727
'#ajax' => [
28-
'callback' => '::prompt',
29-
'wrapper' => 'textfields',
28+
'callback' => '::promptCallback',
29+
'wrapper' => 'textfields-container',
3030
'effect' => 'fade',
3131
],
3232
];
3333
$form['ask_last_name'] = [
3434
'#type' => 'checkbox',
3535
'#title' => $this->t('Ask me my last name'),
3636
'#ajax' => [
37-
'callback' => '::prompt',
38-
'wrapper' => 'textfields',
37+
'callback' => '::promptCallback',
38+
'wrapper' => 'textfields-container',
3939
'effect' => 'fade',
4040
],
4141
];
4242

43-
$form['textfields'] = [
44-
'#title' => $this->t("Generated text fields for first and last name"),
45-
'#prefix' => '<div id="textfields">',
46-
'#suffix' => '</div>',
43+
// Wrap textfields in a container. This container will be replaced through
44+
// AJAX.
45+
$form['textfields_container'] = [
46+
'#type' => 'container',
47+
'#attributes' => ['id' => 'textfields-container'],
48+
];
49+
$form['textfields_container']['textfields'] = [
4750
'#type' => 'fieldset',
51+
'#title' => $this->t("Generated text fields for first and last name"),
4852
'#description' => t('This is where we put automatically generated textfields'),
4953
];
5054

5155
// Since checkboxes return TRUE or FALSE, we have to check that
5256
// $form_state has been filled as well as what it contains.
5357
if (!empty($form_state->getValue('ask_first_name')) && $form_state->getValue('ask_first_name')) {
54-
$form['textfields']['first_name'] = [
58+
$form['textfields_container']['textfields']['first_name'] = [
5559
'#type' => 'textfield',
5660
'#title' => $this->t('First Name'),
5761
];
5862
}
5963
if (!empty($form_state->getValue('ask_last_name')) && $form_state->getValue('ask_last_name')) {
60-
$form['textfields']['last_name'] = [
64+
$form['textfields_container']['textfields']['last_name'] = [
6165
'#type' => 'textfield',
6266
'#title' => $this->t('Last Name'),
6367
];
6468
}
6569

66-
$form['submit'] = [
70+
$form['textfields_container']['submit'] = [
6771
'#type' => 'submit',
6872
'#value' => $this->t('Click Me'),
6973
];
@@ -75,6 +79,7 @@ public function buildForm(array $form, FormStateInterface $form_state) {
7579
* {@inheritdoc}
7680
*/
7781
public function submitForm(array &$form, FormStateInterface $form_state) {
82+
// @todo: Do something on submit.
7883
}
7984

8085
/**
@@ -83,8 +88,8 @@ public function submitForm(array &$form, FormStateInterface $form_state) {
8388
* Selects the piece of the form we want to use as replacement text and
8489
* returns it as a form (renderable array).
8590
*/
86-
public function prompt($form, FormStateInterface $form_state) {
87-
return $form['textfields'];
91+
public function promptCallback($form, FormStateInterface $form_state) {
92+
return $form['textfields_container'];
8893
}
8994

9095
}

‎ajax_example/src/Form/DependentDropdown.php

+18-15
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ public function buildForm(array $form, FormStateInterface $form_state, $nojs = N
8989
// select elements), but valid values include any jQuery event,
9090
// most notably 'mousedown', 'blur', and 'submit'.
9191
'callback' => '::instrumentDropdownCallback',
92-
'wrapper' => 'instrument-fieldset',
92+
'wrapper' => 'instrument-fieldset-container',
9393
],
9494
];
9595
// Since we don't know if the user has js or not, we always need to output
@@ -111,25 +111,27 @@ public function buildForm(array $form, FormStateInterface $form_state, $nojs = N
111111
unset($form['instrument_family_fieldset']['choose_family']['#attributes']);
112112
}
113113

114+
// Since we're managing state for this whole fieldset (both the dropdown
115+
// and enabling the Submit button), we want to replace the whole thing
116+
// on AJAX requests. That's why we put it in this container.
117+
$form['instrument_fieldset_container'] = [
118+
'#type' => 'container',
119+
'#attributes' => ['id' => 'instrument-fieldset-container'],
120+
];
114121
// Build the instrument field set.
115-
$form['instrument_fieldset'] = [
122+
$form['instrument_fieldset_container']['instrument_fieldset'] = [
116123
'#type' => 'fieldset',
117124
'#title' => $this->t('Choose an instrument'),
118-
// Since we're managing state for this whole fieldset (both the dropdown
119-
// and enabling the Submit button), we want to replace the whole thing
120-
// on AJAX requests.
121-
'#prefix' => '<div id="instrument-fieldset">',
122-
'#suffix' => '</div>',
123125
];
124-
$form['instrument_fieldset']['instrument_dropdown'] = [
126+
$form['instrument_fieldset_container']['instrument_fieldset']['instrument_dropdown'] = [
125127
'#type' => 'select',
126128
'#title' => $instrument_family_options[$selected_family] . ' ' . $this->t('Instruments'),
127129
// When the form is rebuilt during ajax processing, the $selected_family
128130
// variable will now have the new value and so the options will change.
129131
'#options' => static::getSecondDropdownOptions($selected_family),
130132
'#default_value' => !empty($form_state->getValue('instrument_dropdown')) ? $form_state->getValue('instrument_dropdown') : '',
131133
];
132-
$form['instrument_fieldset']['submit'] = [
134+
$form['instrument_fieldset_container']['instrument_fieldset']['submit'] = [
133135
'#type' => 'submit',
134136
'#value' => $this->t('Submit'),
135137
];
@@ -138,13 +140,14 @@ public function buildForm(array $form, FormStateInterface $form_state, $nojs = N
138140
// JavaScript running, #state won't work either. We have to set up the state
139141
// of the instrument fieldset here, based on the selected instrument family.
140142
if ($selected_family == 'none') {
141-
$form['instrument_fieldset']['instrument_dropdown']['#title'] = $this->t('You must choose an instrument family.');
142-
$form['instrument_fieldset']['instrument_dropdown']['#disabled'] = TRUE;
143-
$form['instrument_fieldset']['submit']['#disabled'] = TRUE;
143+
$form['instrument_fieldset_container']['instrument_fieldset']['instrument_dropdown']['#title'] =
144+
$this->t('You must choose an instrument family.');
145+
$form['instrument_fieldset_container']['instrument_fieldset']['instrument_dropdown']['#disabled'] = TRUE;
146+
$form['instrument_fieldset_container']['instrument_fieldset']['submit']['#disabled'] = TRUE;
144147
}
145148
else {
146-
$form['instrument_fieldset']['instrument_dropdown']['#disabled'] = FALSE;
147-
$form['instrument_fieldset']['submit']['#disabled'] = FALSE;
149+
$form['instrument_fieldset_container']['instrument_fieldset']['instrument_dropdown']['#disabled'] = FALSE;
150+
$form['instrument_fieldset_container']['instrument_fieldset']['submit']['#disabled'] = FALSE;
148151
}
149152

150153
return $form;
@@ -186,7 +189,7 @@ public function submitForm(array &$form, FormStateInterface $form_state) {
186189
* instrument-dropdown-replace form element.
187190
*/
188191
public function instrumentDropdownCallback(array $form, FormStateInterface $form_state) {
189-
return $form['instrument_fieldset'];
192+
return $form['instrument_fieldset_container'];
190193
}
191194

192195
/**

‎ajax_example/src/Form/Simplest.php

+10-13
Original file line numberDiff line numberDiff line change
@@ -35,29 +35,26 @@ public function buildForm(array $form, FormStateInterface $form_state) {
3535
// changes.
3636
'callback' => '::promptCallback',
3737
// 'wrapper' is the HTML id of the page element that will be replaced.
38-
'wrapper' => 'replace_textfield_div',
39-
// There are also several optional keys - see AjaxExampleAutoCheckboxes
40-
// below for details on 'method', 'effect' and 'speed' and
41-
// AjaxExampleDependentDropDown for 'event'.
38+
'wrapper' => 'replace-textfield-container',
4239
],
4340
];
4441

45-
// The 'replace_textfield_div' div will be replace whenever 'changethis' is
46-
// updated.
47-
$form['replace_textfield'] = [
42+
// The 'replace-textfield-container' container will be replace whenever
43+
// 'changethis' is updated.
44+
$form['replace_textfield_container'] = [
45+
'#type' => 'container',
46+
'#attributes' => ['id' => 'replace-textfield-container'],
47+
];
48+
$form['replace_textfield_container']['replace_textfield'] = [
4849
'#type' => 'textfield',
4950
'#title' => $this->t("Why"),
50-
// The prefix/suffix provide the div that we're replacing, named by
51-
// #ajax['wrapper'] above.
52-
'#prefix' => '<div id="replace_textfield_div">',
53-
'#suffix' => '</div>',
5451
];
5552

5653
// An AJAX request calls the form builder function for every change.
5754
// We can change how we build the form based on $form_state.
5855
$value = $form_state->getValue('changethis');
5956
if (!empty($value)) {
60-
$form['replace_textfield']['#description'] = $this->t("Say why you chose '@value'", ['@value' => $value]);
57+
$form['replace_textfield_container']['replace_textfield']['#description'] = $this->t("Say why you chose '@value'", ['@value' => $value]);
6158
}
6259
return $form;
6360
}
@@ -74,7 +71,7 @@ public function submitForm(array &$form, FormStateInterface $form_state) {
7471
* Handles switching the available regions based on the selected theme.
7572
*/
7673
public function promptCallback($form, FormStateInterface $form_state) {
77-
return $form['replace_textfield'];
74+
return $form['replace_textfield_container'];
7875
}
7976

8077
}

‎ajax_example/src/Form/SubmitDriven.php

+14-8
Original file line numberDiff line numberDiff line change
@@ -21,18 +21,24 @@ public function getFormId() {
2121
* {@inheritdoc}
2222
*/
2323
public function buildForm(array $form, FormStateInterface $form_state) {
24-
$form['box'] = [
24+
// This container wil be replaced by AJAX.
25+
$form['container'] = [
26+
'#type' => 'container',
27+
'#attributes' => ['id' => 'box-container'],
28+
];
29+
// The box contains some markup that we can change on a submit request.
30+
$form['container']['box'] = [
2531
'#type' => 'markup',
26-
'#prefix' => '<div id="box">',
27-
'#suffix' => '</div>',
2832
'#markup' => '<h1>Initial markup for box</h1>',
2933
];
3034

3135
$form['submit'] = [
3236
'#type' => 'submit',
37+
// The AJAX handler will call our callback, and will replace whatever page
38+
// element has id box-container.
3339
'#ajax' => [
34-
'callback' => '::prompt',
35-
'wrapper' => 'box',
40+
'callback' => '::promptCallback',
41+
'wrapper' => 'box-container',
3642
],
3743
'#value' => $this->t('Submit'),
3844
];
@@ -55,12 +61,12 @@ public function submitForm(array &$form, FormStateInterface $form_state) {
5561
* @return array
5662
* Renderable array (the box element)
5763
*/
58-
public function prompt(array &$form, FormStateInterface $form_state) {
64+
public function promptCallback(array &$form, FormStateInterface $form_state) {
5965
// In most cases, it is recommended that you put this logic in form
6066
// generation rather than the callback. Submit driven forms are an
6167
// exception, because you may not want to return the form at all.
62-
$element = $form['box'];
63-
$element['#markup'] = "Clicked submit ({$form_state->getValue('op')}): " . date('c');
68+
$element = $form['container'];
69+
$element['box']['#markup'] = "Clicked submit ({$form_state->getValue('op')}): " . date('c');
6470
return $element;
6571
}
6672

‎ajax_example/src/Form/Wizard.php

-2
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,6 @@ public function buildForm(array $form, FormStateInterface $form_state, $no_js_us
3434
$linktwo = Link::fromTextAndUrl($this->t('examples/ajax-example/wizard'), $urltwo)
3535
->toString();
3636

37-
// $form['#prefix'] = '<div id="wizard-form-wrapper">';
38-
// $form['#suffix'] = '</div>';
3937
// We want to deal with hierarchical form values.
4038
$form['#tree'] = TRUE;
4139
$form['description'] = [

0 commit comments

Comments
 (0)