1
|
<?php
|
2
|
|
3
|
/**
|
4
|
* @file
|
5
|
* Simpletest mock module for Ajax forms testing.
|
6
|
*/
|
7
|
|
8
|
/**
|
9
|
* Implements hook_menu().
|
10
|
*/
|
11
|
function ajax_forms_test_menu() {
|
12
|
$items = array();
|
13
|
$items['ajax_forms_test_get_form'] = array(
|
14
|
'title' => 'AJAX forms simple form test',
|
15
|
'page callback' => 'drupal_get_form',
|
16
|
'page arguments' => array('ajax_forms_test_simple_form'),
|
17
|
'access callback' => TRUE,
|
18
|
);
|
19
|
$items['ajax_forms_test_ajax_commands_form'] = array(
|
20
|
'title' => 'AJAX forms AJAX commands test',
|
21
|
'page callback' => 'drupal_get_form',
|
22
|
'page arguments' => array('ajax_forms_test_ajax_commands_form'),
|
23
|
'access callback' => TRUE,
|
24
|
);
|
25
|
$items['ajax_validation_test'] = array(
|
26
|
'title' => 'AJAX Validation Test',
|
27
|
'page callback' => 'drupal_get_form',
|
28
|
'page arguments' => array('ajax_forms_test_validation_form'),
|
29
|
'access callback' => TRUE,
|
30
|
);
|
31
|
$items['ajax_forms_test_lazy_load_form'] = array(
|
32
|
'title' => 'AJAX forms lazy load test',
|
33
|
'page callback' => 'drupal_get_form',
|
34
|
'page arguments' => array('ajax_forms_test_lazy_load_form'),
|
35
|
'access callback' => TRUE,
|
36
|
);
|
37
|
return $items;
|
38
|
}
|
39
|
|
40
|
|
41
|
/**
|
42
|
* A basic form used to test form_state['values'] during callback.
|
43
|
*/
|
44
|
function ajax_forms_test_simple_form($form, &$form_state) {
|
45
|
$form = array();
|
46
|
$form['select'] = array(
|
47
|
'#type' => 'select',
|
48
|
'#options' => array(
|
49
|
'red' => 'red',
|
50
|
'green' => 'green',
|
51
|
'blue' => 'blue'),
|
52
|
'#ajax' => array(
|
53
|
'callback' => 'ajax_forms_test_simple_form_select_callback',
|
54
|
),
|
55
|
'#suffix' => '<div id="ajax_selected_color">No color yet selected</div>',
|
56
|
);
|
57
|
|
58
|
$form['checkbox'] = array(
|
59
|
'#type' => 'checkbox',
|
60
|
'#title' => t('Test checkbox'),
|
61
|
'#ajax' => array(
|
62
|
'callback' => 'ajax_forms_test_simple_form_checkbox_callback',
|
63
|
),
|
64
|
'#suffix' => '<div id="ajax_checkbox_value">No action yet</div>',
|
65
|
);
|
66
|
$form['submit'] = array(
|
67
|
'#type' => 'submit',
|
68
|
'#value' => t('submit'),
|
69
|
);
|
70
|
return $form;
|
71
|
}
|
72
|
|
73
|
/**
|
74
|
* Ajax callback triggered by select.
|
75
|
*/
|
76
|
function ajax_forms_test_simple_form_select_callback($form, $form_state) {
|
77
|
$commands = array();
|
78
|
$commands[] = ajax_command_html('#ajax_selected_color', $form_state['values']['select']);
|
79
|
$commands[] = ajax_command_data('#ajax_selected_color', 'form_state_value_select', $form_state['values']['select']);
|
80
|
return array('#type' => 'ajax', '#commands' => $commands);
|
81
|
}
|
82
|
|
83
|
/**
|
84
|
* Ajax callback triggered by checkbox.
|
85
|
*/
|
86
|
function ajax_forms_test_simple_form_checkbox_callback($form, $form_state) {
|
87
|
$commands = array();
|
88
|
$commands[] = ajax_command_html('#ajax_checkbox_value', (int) $form_state['values']['checkbox']);
|
89
|
$commands[] = ajax_command_data('#ajax_checkbox_value', 'form_state_value_select', (int) $form_state['values']['checkbox']);
|
90
|
return array('#type' => 'ajax', '#commands' => $commands);
|
91
|
}
|
92
|
|
93
|
|
94
|
/**
|
95
|
* Form to display the Ajax Commands.
|
96
|
*/
|
97
|
function ajax_forms_test_ajax_commands_form($form, &$form_state) {
|
98
|
$form = array();
|
99
|
|
100
|
// Shows the 'after' command with a callback generating commands.
|
101
|
$form['after_command_example'] = array(
|
102
|
'#value' => t("AJAX 'After': Click to put something after the div"),
|
103
|
'#type' => 'submit',
|
104
|
'#ajax' => array(
|
105
|
'callback' => 'ajax_forms_test_advanced_commands_after_callback',
|
106
|
),
|
107
|
'#suffix' => '<div id="after_div">Something can be inserted after this</div>',
|
108
|
);
|
109
|
|
110
|
// Shows the 'alert' command.
|
111
|
$form['alert_command_example'] = array(
|
112
|
'#value' => t("AJAX 'Alert': Click to alert"),
|
113
|
'#type' => 'submit',
|
114
|
'#ajax' => array(
|
115
|
'callback' => 'ajax_forms_test_advanced_commands_alert_callback',
|
116
|
),
|
117
|
);
|
118
|
|
119
|
// Shows the 'append' command.
|
120
|
$form['append_command_example'] = array(
|
121
|
'#value' => t("AJAX 'Append': Click to append something"),
|
122
|
'#type' => 'submit',
|
123
|
'#ajax' => array(
|
124
|
'callback' => 'ajax_forms_test_advanced_commands_append_callback',
|
125
|
),
|
126
|
'#suffix' => '<div id="append_div">Append inside this div</div>',
|
127
|
);
|
128
|
|
129
|
|
130
|
// Shows the 'before' command.
|
131
|
$form['before_command_example'] = array(
|
132
|
'#value' => t("AJAX 'before': Click to put something before the div"),
|
133
|
'#type' => 'submit',
|
134
|
'#ajax' => array(
|
135
|
'callback' => 'ajax_forms_test_advanced_commands_before_callback',
|
136
|
),
|
137
|
'#suffix' => '<div id="before_div">Insert something before this.</div>',
|
138
|
);
|
139
|
|
140
|
// Shows the 'changed' command without asterisk.
|
141
|
$form['changed_command_example'] = array(
|
142
|
'#value' => t("AJAX changed: Click to mark div changed."),
|
143
|
'#type' => 'submit',
|
144
|
'#ajax' => array(
|
145
|
'callback' => 'ajax_forms_test_advanced_commands_changed_callback',
|
146
|
),
|
147
|
'#suffix' => '<div id="changed_div"> <div id="changed_div_mark_this">This div can be marked as changed or not.</div></div>',
|
148
|
);
|
149
|
// Shows the 'changed' command adding the asterisk.
|
150
|
$form['changed_command_asterisk_example'] = array(
|
151
|
'#value' => t("AJAX changed: Click to mark div changed with asterisk."),
|
152
|
'#type' => 'submit',
|
153
|
'#ajax' => array(
|
154
|
'callback' => 'ajax_forms_test_advanced_commands_changed_asterisk_callback',
|
155
|
),
|
156
|
);
|
157
|
|
158
|
// Shows the Ajax 'css' command.
|
159
|
$form['css_command_example'] = array(
|
160
|
'#value' => t("Set the the '#box' div to be blue."),
|
161
|
'#type' => 'submit',
|
162
|
'#ajax' => array(
|
163
|
'callback' => 'ajax_forms_test_advanced_commands_css_callback',
|
164
|
),
|
165
|
'#suffix' => '<div id="css_div" style="height: 50px; width: 50px; border: 1px solid black"> box</div>',
|
166
|
);
|
167
|
|
168
|
|
169
|
// Shows the Ajax 'data' command. But there is no use of this information,
|
170
|
// as this would require a javascript client to use the data.
|
171
|
$form['data_command_example'] = array(
|
172
|
'#value' => t("AJAX data command: Issue command."),
|
173
|
'#type' => 'submit',
|
174
|
'#ajax' => array(
|
175
|
'callback' => 'ajax_forms_test_advanced_commands_data_callback',
|
176
|
),
|
177
|
'#suffix' => '<div id="data_div">Data attached to this div.</div>',
|
178
|
);
|
179
|
|
180
|
// Shows the Ajax 'invoke' command.
|
181
|
$form['invoke_command_example'] = array(
|
182
|
'#value' => t("AJAX invoke command: Invoke addClass() method."),
|
183
|
'#type' => 'submit',
|
184
|
'#ajax' => array(
|
185
|
'callback' => 'ajax_forms_test_advanced_commands_invoke_callback',
|
186
|
),
|
187
|
'#suffix' => '<div id="invoke_div">Original contents</div>',
|
188
|
);
|
189
|
|
190
|
// Shows the Ajax 'html' command.
|
191
|
$form['html_command_example'] = array(
|
192
|
'#value' => t("AJAX html: Replace the HTML in a selector."),
|
193
|
'#type' => 'submit',
|
194
|
'#ajax' => array(
|
195
|
'callback' => 'ajax_forms_test_advanced_commands_html_callback',
|
196
|
),
|
197
|
'#suffix' => '<div id="html_div">Original contents</div>',
|
198
|
);
|
199
|
|
200
|
// Shows the Ajax 'insert' command.
|
201
|
$form['insert_command_example'] = array(
|
202
|
'#value' => t("AJAX insert: Let client insert based on #ajax['method']."),
|
203
|
'#type' => 'submit',
|
204
|
'#ajax' => array(
|
205
|
'callback' => 'ajax_forms_test_advanced_commands_insert_callback',
|
206
|
'method' => 'prepend',
|
207
|
),
|
208
|
'#suffix' => '<div id="insert_div">Original contents</div>',
|
209
|
);
|
210
|
|
211
|
// Shows the Ajax 'prepend' command.
|
212
|
$form['prepend_command_example'] = array(
|
213
|
'#value' => t("AJAX 'prepend': Click to prepend something"),
|
214
|
'#type' => 'submit',
|
215
|
'#ajax' => array(
|
216
|
'callback' => 'ajax_forms_test_advanced_commands_prepend_callback',
|
217
|
),
|
218
|
'#suffix' => '<div id="prepend_div">Something will be prepended to this div. </div>',
|
219
|
);
|
220
|
|
221
|
// Shows the Ajax 'remove' command.
|
222
|
$form['remove_command_example'] = array(
|
223
|
'#value' => t("AJAX 'remove': Click to remove text"),
|
224
|
'#type' => 'submit',
|
225
|
'#ajax' => array(
|
226
|
'callback' => 'ajax_forms_test_advanced_commands_remove_callback',
|
227
|
),
|
228
|
'#suffix' => '<div id="remove_div"><div id="remove_text">text to be removed</div></div>',
|
229
|
);
|
230
|
|
231
|
// Shows the Ajax 'restripe' command.
|
232
|
$form['restripe_command_example'] = array(
|
233
|
'#type' => 'submit',
|
234
|
'#value' => t("AJAX 'restripe' command"),
|
235
|
'#ajax' => array(
|
236
|
'callback' => 'ajax_forms_test_advanced_commands_restripe_callback',
|
237
|
),
|
238
|
'#suffix' => '<div id="restripe_div">
|
239
|
<table id="restripe_table" style="border: 1px solid black" >
|
240
|
<tr id="table-first"><td>first row</td></tr>
|
241
|
<tr ><td>second row</td></tr>
|
242
|
</table>
|
243
|
</div>',
|
244
|
);
|
245
|
|
246
|
// Demonstrates the Ajax 'settings' command. The 'settings' command has
|
247
|
// nothing visual to "show", but it can be tested via SimpleTest and via
|
248
|
// Firebug.
|
249
|
$form['settings_command_example'] = array(
|
250
|
'#type' => 'submit',
|
251
|
'#value' => t("AJAX 'settings' command"),
|
252
|
'#ajax' => array(
|
253
|
'callback' => 'ajax_forms_test_advanced_commands_settings_callback',
|
254
|
),
|
255
|
);
|
256
|
|
257
|
// Shows the Ajax 'add_css' command.
|
258
|
$form['add_css_command_example'] = array(
|
259
|
'#type' => 'submit',
|
260
|
'#value' => t("AJAX 'add_css' command"),
|
261
|
'#ajax' => array(
|
262
|
'callback' => 'ajax_forms_test_advanced_commands_add_css_callback',
|
263
|
),
|
264
|
);
|
265
|
|
266
|
$form['submit'] = array(
|
267
|
'#type' => 'submit',
|
268
|
'#value' => t('Submit'),
|
269
|
);
|
270
|
|
271
|
return $form;
|
272
|
}
|
273
|
|
274
|
/**
|
275
|
* Ajax callback for 'after'.
|
276
|
*/
|
277
|
function ajax_forms_test_advanced_commands_after_callback($form, $form_state) {
|
278
|
$selector = '#after_div';
|
279
|
|
280
|
$commands = array();
|
281
|
$commands[] = ajax_command_after($selector, "This will be placed after");
|
282
|
return array('#type' => 'ajax', '#commands' => $commands);
|
283
|
}
|
284
|
|
285
|
/**
|
286
|
* Ajax callback for 'alert'.
|
287
|
*/
|
288
|
function ajax_forms_test_advanced_commands_alert_callback($form, $form_state) {
|
289
|
$commands = array();
|
290
|
$commands[] = ajax_command_alert("Alert");
|
291
|
return array('#type' => 'ajax', '#commands' => $commands);
|
292
|
}
|
293
|
|
294
|
/**
|
295
|
* Ajax callback for 'append'.
|
296
|
*/
|
297
|
function ajax_forms_test_advanced_commands_append_callback($form, $form_state) {
|
298
|
$selector = '#append_div';
|
299
|
$commands = array();
|
300
|
$commands[] = ajax_command_append($selector, "Appended text");
|
301
|
return array('#type' => 'ajax', '#commands' => $commands);
|
302
|
}
|
303
|
|
304
|
/**
|
305
|
* Ajax callback for 'before'.
|
306
|
*/
|
307
|
function ajax_forms_test_advanced_commands_before_callback($form, $form_state) {
|
308
|
$selector = '#before_div';
|
309
|
|
310
|
$commands = array();
|
311
|
$commands[] = ajax_command_before($selector, "Before text");
|
312
|
return array('#type' => 'ajax', '#commands' => $commands);
|
313
|
}
|
314
|
|
315
|
/**
|
316
|
* Ajax callback for 'changed'.
|
317
|
*/
|
318
|
function ajax_forms_test_advanced_commands_changed_callback($form, $form_state) {
|
319
|
$commands[] = ajax_command_changed('#changed_div');
|
320
|
return array('#type' => 'ajax', '#commands' => $commands);
|
321
|
}
|
322
|
/**
|
323
|
* Ajax callback for 'changed' with asterisk marking inner div.
|
324
|
*/
|
325
|
function ajax_forms_test_advanced_commands_changed_asterisk_callback($form, $form_state) {
|
326
|
$commands = array();
|
327
|
$commands[] = ajax_command_changed('#changed_div', '#changed_div_mark_this');
|
328
|
return array('#type' => 'ajax', '#commands' => $commands);
|
329
|
}
|
330
|
|
331
|
/**
|
332
|
* Ajax callback for 'css'.
|
333
|
*/
|
334
|
function ajax_forms_test_advanced_commands_css_callback($form, $form_state) {
|
335
|
$selector = '#css_div';
|
336
|
$color = 'blue';
|
337
|
|
338
|
$commands = array();
|
339
|
$commands[] = ajax_command_css($selector, array('background-color' => $color));
|
340
|
return array('#type' => 'ajax', '#commands' => $commands);
|
341
|
}
|
342
|
|
343
|
/**
|
344
|
* Ajax callback for 'data'.
|
345
|
*/
|
346
|
function ajax_forms_test_advanced_commands_data_callback($form, $form_state) {
|
347
|
$selector = '#data_div';
|
348
|
|
349
|
$commands = array();
|
350
|
$commands[] = ajax_command_data($selector, 'testkey', 'testvalue');
|
351
|
return array('#type' => 'ajax', '#commands' => $commands);
|
352
|
}
|
353
|
|
354
|
/**
|
355
|
* Ajax callback for 'invoke'.
|
356
|
*/
|
357
|
function ajax_forms_test_advanced_commands_invoke_callback($form, $form_state) {
|
358
|
$commands = array();
|
359
|
$commands[] = ajax_command_invoke('#invoke_div', 'addClass', array('error'));
|
360
|
return array('#type' => 'ajax', '#commands' => $commands);
|
361
|
}
|
362
|
|
363
|
/**
|
364
|
* Ajax callback for 'html'.
|
365
|
*/
|
366
|
function ajax_forms_test_advanced_commands_html_callback($form, $form_state) {
|
367
|
$commands = array();
|
368
|
$commands[] = ajax_command_html('#html_div', 'replacement text');
|
369
|
return array('#type' => 'ajax', '#commands' => $commands);
|
370
|
}
|
371
|
|
372
|
/**
|
373
|
* Ajax callback for 'insert'.
|
374
|
*/
|
375
|
function ajax_forms_test_advanced_commands_insert_callback($form, $form_state) {
|
376
|
$commands = array();
|
377
|
$commands[] = ajax_command_insert('#insert_div', 'insert replacement text');
|
378
|
return array('#type' => 'ajax', '#commands' => $commands);
|
379
|
}
|
380
|
|
381
|
/**
|
382
|
* Ajax callback for 'prepend'.
|
383
|
*/
|
384
|
function ajax_forms_test_advanced_commands_prepend_callback($form, $form_state) {
|
385
|
$commands = array();
|
386
|
$commands[] = ajax_command_prepend('#prepend_div', "prepended text");
|
387
|
return array('#type' => 'ajax', '#commands' => $commands);
|
388
|
}
|
389
|
|
390
|
/**
|
391
|
* Ajax callback for 'remove'.
|
392
|
*/
|
393
|
function ajax_forms_test_advanced_commands_remove_callback($form, $form_state) {
|
394
|
$commands = array();
|
395
|
$commands[] = ajax_command_remove('#remove_text');
|
396
|
return array('#type' => 'ajax', '#commands' => $commands);
|
397
|
}
|
398
|
|
399
|
/**
|
400
|
* Ajax callback for 'restripe'.
|
401
|
*/
|
402
|
function ajax_forms_test_advanced_commands_restripe_callback($form, $form_state) {
|
403
|
$commands = array();
|
404
|
$commands[] = ajax_command_restripe('#restripe_table');
|
405
|
return array('#type' => 'ajax', '#commands' => $commands);
|
406
|
}
|
407
|
|
408
|
/**
|
409
|
* Ajax callback for 'settings'.
|
410
|
*/
|
411
|
function ajax_forms_test_advanced_commands_settings_callback($form, $form_state) {
|
412
|
$commands = array();
|
413
|
$setting['ajax_forms_test']['foo'] = 42;
|
414
|
$commands[] = ajax_command_settings($setting);
|
415
|
return array('#type' => 'ajax', '#commands' => $commands);
|
416
|
}
|
417
|
|
418
|
/**
|
419
|
* Ajax callback for 'add_css'.
|
420
|
*/
|
421
|
function ajax_forms_test_advanced_commands_add_css_callback($form, $form_state) {
|
422
|
$commands = array();
|
423
|
$commands[] = ajax_command_add_css('my/file.css');
|
424
|
return array('#type' => 'ajax', '#commands' => $commands);
|
425
|
}
|
426
|
|
427
|
/**
|
428
|
* This form and its related submit and callback functions demonstrate
|
429
|
* not validating another form element when a single Ajax element is triggered.
|
430
|
*
|
431
|
* The "drivertext" element is an Ajax-enabled textfield, free-form.
|
432
|
* The "required_field" element is a textfield marked required.
|
433
|
*
|
434
|
* The correct behavior is that the Ajax-enabled drivertext element should
|
435
|
* be able to trigger without causing validation of the "required_field".
|
436
|
*/
|
437
|
function ajax_forms_test_validation_form($form, &$form_state) {
|
438
|
|
439
|
$form['drivertext'] = array(
|
440
|
'#title' => t('AJAX-enabled textfield.'),
|
441
|
'#description' => t("When this one AJAX-triggers and the spare required field is empty, you should not get an error."),
|
442
|
'#type' => 'textfield',
|
443
|
'#default_value' => !empty($form_state['values']['drivertext']) ? $form_state['values']['drivertext'] : "",
|
444
|
'#ajax' => array(
|
445
|
'callback' => 'ajax_forms_test_validation_form_callback',
|
446
|
'wrapper' => 'message_area',
|
447
|
'method' => 'replace',
|
448
|
),
|
449
|
'#suffix' => '<div id="message_area"></div>',
|
450
|
);
|
451
|
|
452
|
$form['spare_required_field'] = array(
|
453
|
'#title' => t("Spare Required Field"),
|
454
|
'#type' => 'textfield',
|
455
|
'#required' => TRUE,
|
456
|
);
|
457
|
|
458
|
$form['submit'] = array(
|
459
|
'#type' => 'submit',
|
460
|
'#value' => t('Submit'),
|
461
|
);
|
462
|
|
463
|
return $form;
|
464
|
}
|
465
|
/**
|
466
|
* Submit handler for the validation form.
|
467
|
*/
|
468
|
function ajax_forms_test_validation_form_submit($form, $form_state) {
|
469
|
drupal_set_message(t("Validation form submitted"));
|
470
|
}
|
471
|
|
472
|
/**
|
473
|
* Ajax callback for the 'drivertext' element of the validation form.
|
474
|
*/
|
475
|
function ajax_forms_test_validation_form_callback($form, $form_state) {
|
476
|
drupal_set_message("ajax_forms_test_validation_form_callback invoked");
|
477
|
drupal_set_message(t("Callback: drivertext=%drivertext, spare_required_field=%spare_required_field", array('%drivertext' => $form_state['values']['drivertext'], '%spare_required_field' => $form_state['values']['spare_required_field'])));
|
478
|
return '<div id="message_area">ajax_forms_test_validation_form_callback at ' . date('c') . '</div>';
|
479
|
}
|
480
|
|
481
|
/**
|
482
|
* Form builder: Builds a form that triggers a simple AJAX callback.
|
483
|
*/
|
484
|
function ajax_forms_test_lazy_load_form($form, &$form_state) {
|
485
|
$form['add_files'] = array(
|
486
|
'#type' => 'checkbox',
|
487
|
'#default_value' => FALSE,
|
488
|
);
|
489
|
$form['submit'] = array(
|
490
|
'#type' => 'submit',
|
491
|
'#value' => t('Submit'),
|
492
|
'#ajax' => array(
|
493
|
'callback' => 'ajax_forms_test_lazy_load_form_ajax',
|
494
|
),
|
495
|
);
|
496
|
return $form;
|
497
|
}
|
498
|
|
499
|
/**
|
500
|
* Form submit handler: Adds JavaScript and CSS that wasn't on the original form.
|
501
|
*/
|
502
|
function ajax_forms_test_lazy_load_form_submit($form, &$form_state) {
|
503
|
if ($form_state['values']['add_files']) {
|
504
|
drupal_add_js(array('ajax_forms_test_lazy_load_form_submit' => 'executed'), 'setting');
|
505
|
drupal_add_css(drupal_get_path('module', 'system') . '/system.admin.css');
|
506
|
drupal_add_js(drupal_get_path('module', 'system') . '/system.js');
|
507
|
}
|
508
|
$form_state['rebuild'] = TRUE;
|
509
|
}
|
510
|
|
511
|
/**
|
512
|
* AJAX callback for the ajax_forms_test_lazy_load_form() form.
|
513
|
*
|
514
|
* This function returns nothing, because all we're interested in testing is
|
515
|
* ajax_render() adding commands for JavaScript and CSS added during the page
|
516
|
* request, such as the ones added in ajax_forms_test_lazy_load_form_submit().
|
517
|
*/
|
518
|
function ajax_forms_test_lazy_load_form_ajax($form, &$form_state) {
|
519
|
return NULL;
|
520
|
}
|