ajax_forms_test.module 16.6 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520
<?php

/**
 * @file
 * Simpletest mock module for Ajax forms testing.
 */

/**
 * Implements hook_menu().
 */
function ajax_forms_test_menu() {
  $items = array();
  $items['ajax_forms_test_get_form'] = array(
    'title' => 'AJAX forms simple form test',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('ajax_forms_test_simple_form'),
    'access callback' => TRUE,
  );
  $items['ajax_forms_test_ajax_commands_form'] = array(
    'title' => 'AJAX forms AJAX commands test',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('ajax_forms_test_ajax_commands_form'),
    'access callback' => TRUE,
  );
  $items['ajax_validation_test'] = array(
    'title' => 'AJAX Validation Test',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('ajax_forms_test_validation_form'),
    'access callback' => TRUE,
  );
  $items['ajax_forms_test_lazy_load_form'] = array(
    'title' => 'AJAX forms lazy load test',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('ajax_forms_test_lazy_load_form'),
    'access callback' => TRUE,
  );
  return $items;
}


/**
 * A basic form used to test form_state['values'] during callback.
 */
function ajax_forms_test_simple_form($form, &$form_state) {
  $form = array();
  $form['select'] = array(
    '#type' => 'select',
    '#options' => array(
      'red' => 'red',
      'green' => 'green',
      'blue' => 'blue'),
    '#ajax' => array(
      'callback' => 'ajax_forms_test_simple_form_select_callback',
    ),
    '#suffix' => '<div id="ajax_selected_color">No color yet selected</div>',
  );

  $form['checkbox'] = array(
    '#type' => 'checkbox',
    '#title' => t('Test checkbox'),
    '#ajax' => array(
       'callback' => 'ajax_forms_test_simple_form_checkbox_callback',
    ),
    '#suffix' => '<div id="ajax_checkbox_value">No action yet</div>',
  );
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('submit'),
  );
  return $form;
}

/**
 * Ajax callback triggered by select.
 */
function ajax_forms_test_simple_form_select_callback($form, $form_state) {
  $commands = array();
  $commands[] = ajax_command_html('#ajax_selected_color', $form_state['values']['select']);
  $commands[] = ajax_command_data('#ajax_selected_color', 'form_state_value_select', $form_state['values']['select']);
  return array('#type' => 'ajax', '#commands' => $commands);
}

/**
 * Ajax callback triggered by checkbox.
 */
function ajax_forms_test_simple_form_checkbox_callback($form, $form_state) {
  $commands = array();
  $commands[] = ajax_command_html('#ajax_checkbox_value', (int) $form_state['values']['checkbox']);
  $commands[] = ajax_command_data('#ajax_checkbox_value', 'form_state_value_select', (int) $form_state['values']['checkbox']);
  return array('#type' => 'ajax', '#commands' => $commands);
}


/**
 * Form to display the Ajax Commands.
 */
function ajax_forms_test_ajax_commands_form($form, &$form_state) {
  $form = array();

  // Shows the 'after' command with a callback generating commands.
  $form['after_command_example'] = array(
    '#value' => t("AJAX 'After': Click to put something after the div"),
    '#type' => 'submit',
    '#ajax' => array(
      'callback' => 'ajax_forms_test_advanced_commands_after_callback',
    ),
    '#suffix' => '<div id="after_div">Something can be inserted after this</div>',
  );

  // Shows the 'alert' command.
  $form['alert_command_example'] = array(
    '#value' => t("AJAX 'Alert': Click to alert"),
    '#type' => 'submit',
    '#ajax' => array(
      'callback' => 'ajax_forms_test_advanced_commands_alert_callback',
    ),
  );

  // Shows the 'append' command.
  $form['append_command_example'] = array(
    '#value' => t("AJAX 'Append': Click to append something"),
    '#type' => 'submit',
    '#ajax' => array(
      'callback' => 'ajax_forms_test_advanced_commands_append_callback',
    ),
    '#suffix' => '<div id="append_div">Append inside this div</div>',
  );


  // Shows the 'before' command.
  $form['before_command_example'] = array(
    '#value' => t("AJAX 'before': Click to put something before the div"),
    '#type' => 'submit',
    '#ajax' => array(
      'callback' => 'ajax_forms_test_advanced_commands_before_callback',
    ),
    '#suffix' => '<div id="before_div">Insert something before this.</div>',
  );

  // Shows the 'changed' command without asterisk.
  $form['changed_command_example'] = array(
    '#value' => t("AJAX changed: Click to mark div changed."),
    '#type' => 'submit',
    '#ajax' => array(
      'callback' => 'ajax_forms_test_advanced_commands_changed_callback',
    ),
    '#suffix' => '<div id="changed_div"> <div id="changed_div_mark_this">This div can be marked as changed or not.</div></div>',
  );
  // Shows the 'changed' command adding the asterisk.
  $form['changed_command_asterisk_example'] = array(
    '#value' => t("AJAX changed: Click to mark div changed with asterisk."),
    '#type' => 'submit',
    '#ajax' => array(
      'callback' => 'ajax_forms_test_advanced_commands_changed_asterisk_callback',
    ),
  );

  // Shows the Ajax 'css' command.
  $form['css_command_example'] = array(
    '#value' => t("Set the '#box' div to be blue."),
    '#type' => 'submit',
    '#ajax' => array(
      'callback' => 'ajax_forms_test_advanced_commands_css_callback',
    ),
    '#suffix' => '<div id="css_div" style="height: 50px; width: 50px; border: 1px solid black"> box</div>',
  );


  // Shows the Ajax 'data' command. But there is no use of this information,
  // as this would require a javascript client to use the data.
  $form['data_command_example'] = array(
    '#value' => t("AJAX data command: Issue command."),
    '#type' => 'submit',
    '#ajax' => array(
      'callback' => 'ajax_forms_test_advanced_commands_data_callback',
    ),
    '#suffix' => '<div id="data_div">Data attached to this div.</div>',
  );

  // Shows the Ajax 'invoke' command.
  $form['invoke_command_example'] = array(
    '#value' => t("AJAX invoke command: Invoke addClass() method."),
    '#type' => 'submit',
    '#ajax' => array(
      'callback' => 'ajax_forms_test_advanced_commands_invoke_callback',
    ),
    '#suffix' => '<div id="invoke_div">Original contents</div>',
  );

  // Shows the Ajax 'html' command.
  $form['html_command_example'] = array(
    '#value' => t("AJAX html: Replace the HTML in a selector."),
    '#type' => 'submit',
    '#ajax' => array(
      'callback' => 'ajax_forms_test_advanced_commands_html_callback',
    ),
    '#suffix' => '<div id="html_div">Original contents</div>',
  );

  // Shows the Ajax 'insert' command.
  $form['insert_command_example'] = array(
    '#value' => t("AJAX insert: Let client insert based on #ajax['method']."),
    '#type' => 'submit',
    '#ajax' => array(
      'callback' => 'ajax_forms_test_advanced_commands_insert_callback',
      'method' => 'prepend',
    ),
    '#suffix' => '<div id="insert_div">Original contents</div>',
  );

  // Shows the Ajax 'prepend' command.
  $form['prepend_command_example'] = array(
    '#value' => t("AJAX 'prepend': Click to prepend something"),
    '#type' => 'submit',
    '#ajax' => array(
      'callback' => 'ajax_forms_test_advanced_commands_prepend_callback',
    ),
    '#suffix' => '<div id="prepend_div">Something will be prepended to this div. </div>',
  );

  // Shows the Ajax 'remove' command.
  $form['remove_command_example'] = array(
    '#value' => t("AJAX 'remove': Click to remove text"),
    '#type' => 'submit',
    '#ajax' => array(
      'callback' => 'ajax_forms_test_advanced_commands_remove_callback',
    ),
    '#suffix' => '<div id="remove_div"><div id="remove_text">text to be removed</div></div>',
  );

  // Shows the Ajax 'restripe' command.
  $form['restripe_command_example'] = array(
    '#type' => 'submit',
    '#value' => t("AJAX 'restripe' command"),
    '#ajax' => array(
      'callback' => 'ajax_forms_test_advanced_commands_restripe_callback',
    ),
    '#suffix' => '<div id="restripe_div">
                  <table id="restripe_table" style="border: 1px solid black" >
                  <tr id="table-first"><td>first row</td></tr>
                  <tr ><td>second row</td></tr>
                  </table>
                  </div>',
  );

  // Demonstrates the Ajax 'settings' command. The 'settings' command has
  // nothing visual to "show", but it can be tested via SimpleTest and via
  // Firebug.
  $form['settings_command_example'] = array(
    '#type' => 'submit',
    '#value' => t("AJAX 'settings' command"),
    '#ajax' => array(
      'callback' => 'ajax_forms_test_advanced_commands_settings_callback',
    ),
  );

  // Shows the Ajax 'add_css' command.
  $form['add_css_command_example'] = array(
    '#type' => 'submit',
    '#value' => t("AJAX 'add_css' command"),
    '#ajax' => array(
      'callback' => 'ajax_forms_test_advanced_commands_add_css_callback',
    ),
  );

  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Submit'),
  );

  return $form;
}

/**
 * Ajax callback for 'after'.
 */
function ajax_forms_test_advanced_commands_after_callback($form, $form_state) {
  $selector = '#after_div';

  $commands = array();
  $commands[] = ajax_command_after($selector, "This will be placed after");
  return array('#type' => 'ajax', '#commands' => $commands);
}

/**
 * Ajax callback for 'alert'.
 */
function ajax_forms_test_advanced_commands_alert_callback($form, $form_state) {
  $commands = array();
  $commands[] = ajax_command_alert("Alert");
  return array('#type' => 'ajax', '#commands' => $commands);
}

/**
 * Ajax callback for 'append'.
 */
function ajax_forms_test_advanced_commands_append_callback($form, $form_state) {
  $selector = '#append_div';
  $commands = array();
  $commands[] = ajax_command_append($selector, "Appended text");
  return array('#type' => 'ajax', '#commands' => $commands);
}

/**
 * Ajax callback for 'before'.
 */
function ajax_forms_test_advanced_commands_before_callback($form, $form_state) {
  $selector = '#before_div';

  $commands = array();
  $commands[] = ajax_command_before($selector, "Before text");
  return array('#type' => 'ajax', '#commands' => $commands);
}

/**
 * Ajax callback for 'changed'.
 */
function ajax_forms_test_advanced_commands_changed_callback($form, $form_state) {
  $commands[] = ajax_command_changed('#changed_div');
  return array('#type' => 'ajax', '#commands' => $commands);
}
/**
 * Ajax callback for 'changed' with asterisk marking inner div.
 */
function ajax_forms_test_advanced_commands_changed_asterisk_callback($form, $form_state) {
  $commands = array();
  $commands[] = ajax_command_changed('#changed_div', '#changed_div_mark_this');
  return array('#type' => 'ajax', '#commands' => $commands);
}

/**
 * Ajax callback for 'css'.
 */
function ajax_forms_test_advanced_commands_css_callback($form, $form_state) {
  $selector = '#css_div';
  $color = 'blue';

  $commands = array();
  $commands[] = ajax_command_css($selector, array('background-color' => $color));
  return array('#type' => 'ajax', '#commands' => $commands);
}

/**
 * Ajax callback for 'data'.
 */
function ajax_forms_test_advanced_commands_data_callback($form, $form_state) {
  $selector = '#data_div';

  $commands = array();
  $commands[] = ajax_command_data($selector, 'testkey', 'testvalue');
  return array('#type' => 'ajax', '#commands' => $commands);
}

/**
 * Ajax callback for 'invoke'.
 */
function ajax_forms_test_advanced_commands_invoke_callback($form, $form_state) {
  $commands = array();
  $commands[] = ajax_command_invoke('#invoke_div', 'addClass', array('error'));
  return array('#type' => 'ajax', '#commands' => $commands);
}

/**
 * Ajax callback for 'html'.
 */
function ajax_forms_test_advanced_commands_html_callback($form, $form_state) {
  $commands = array();
  $commands[] = ajax_command_html('#html_div', 'replacement text');
  return array('#type' => 'ajax', '#commands' => $commands);
}

/**
 * Ajax callback for 'insert'.
 */
function ajax_forms_test_advanced_commands_insert_callback($form, $form_state) {
  $commands = array();
  $commands[] = ajax_command_insert('#insert_div', 'insert replacement text');
  return array('#type' => 'ajax', '#commands' => $commands);
}

/**
 * Ajax callback for 'prepend'.
 */
function ajax_forms_test_advanced_commands_prepend_callback($form, $form_state) {
  $commands = array();
  $commands[] = ajax_command_prepend('#prepend_div', "prepended text");
  return array('#type' => 'ajax', '#commands' => $commands);
}

/**
 * Ajax callback for 'remove'.
 */
function ajax_forms_test_advanced_commands_remove_callback($form, $form_state) {
  $commands = array();
  $commands[] = ajax_command_remove('#remove_text');
  return array('#type' => 'ajax', '#commands' => $commands);
}

/**
 * Ajax callback for 'restripe'.
 */
function ajax_forms_test_advanced_commands_restripe_callback($form, $form_state) {
  $commands = array();
  $commands[] = ajax_command_restripe('#restripe_table');
  return array('#type' => 'ajax', '#commands' => $commands);
}

/**
 * Ajax callback for 'settings'.
 */
function ajax_forms_test_advanced_commands_settings_callback($form, $form_state) {
  $commands = array();
  $setting['ajax_forms_test']['foo'] = 42;
  $commands[] = ajax_command_settings($setting);
  return array('#type' => 'ajax', '#commands' => $commands);
}

/**
 * Ajax callback for 'add_css'.
 */
function ajax_forms_test_advanced_commands_add_css_callback($form, $form_state) {
  $commands = array();
  $commands[] = ajax_command_add_css('my/file.css');
  return array('#type' => 'ajax', '#commands' => $commands);
}

/**
 * This form and its related submit and callback functions demonstrate
 * not validating another form element when a single Ajax element is triggered.
 *
 * The "drivertext" element is an Ajax-enabled textfield, free-form.
 * The "required_field" element is a textfield marked required.
 *
 * The correct behavior is that the Ajax-enabled drivertext element should
 * be able to trigger without causing validation of the "required_field".
 */
function ajax_forms_test_validation_form($form, &$form_state) {

  $form['drivertext'] = array(
    '#title' => t('AJAX-enabled textfield.'),
    '#description' => t("When this one AJAX-triggers and the spare required field is empty, you should not get an error."),
    '#type' => 'textfield',
    '#default_value' => !empty($form_state['values']['drivertext']) ? $form_state['values']['drivertext'] : "",
    '#ajax' => array(
      'callback' => 'ajax_forms_test_validation_form_callback',
      'wrapper' => 'message_area',
      'method' => 'replace',
    ),
    '#suffix' => '<div id="message_area"></div>',
  );

  $form['spare_required_field'] = array(
    '#title' => t("Spare Required Field"),
    '#type' => 'textfield',
    '#required' => TRUE,
  );

  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Submit'),
  );

  return $form;
}
/**
 * Submit handler for the validation form.
 */
function ajax_forms_test_validation_form_submit($form, $form_state) {
  drupal_set_message(t("Validation form submitted"));
}

/**
 * Ajax callback for the 'drivertext' element of the validation form.
 */
function ajax_forms_test_validation_form_callback($form, $form_state) {
  drupal_set_message("ajax_forms_test_validation_form_callback invoked");
  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'])));
  return '<div id="message_area">ajax_forms_test_validation_form_callback at ' . date('c') . '</div>';
}

/**
 * Form builder: Builds a form that triggers a simple AJAX callback.
 */
function ajax_forms_test_lazy_load_form($form, &$form_state) {
  $form['add_files'] = array(
    '#type' => 'checkbox',
    '#default_value' => FALSE,
  );
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Submit'),
    '#ajax' => array(
      'callback' => 'ajax_forms_test_lazy_load_form_ajax',
    ),
  );
  return $form;
}

/**
 * Form submit handler: Adds JavaScript and CSS that wasn't on the original form.
 */
function ajax_forms_test_lazy_load_form_submit($form, &$form_state) {
  if ($form_state['values']['add_files']) {
    drupal_add_js(array('ajax_forms_test_lazy_load_form_submit' => 'executed'), 'setting');
    drupal_add_css(drupal_get_path('module', 'system') . '/system.admin.css');
    drupal_add_js(drupal_get_path('module', 'system') . '/system.js');
  }
  $form_state['rebuild'] = TRUE;
}

/**
 * AJAX callback for the ajax_forms_test_lazy_load_form() form.
 *
 * This function returns nothing, because all we're interested in testing is
 * ajax_render() adding commands for JavaScript and CSS added during the page
 * request, such as the ones added in ajax_forms_test_lazy_load_form_submit().
 */
function ajax_forms_test_lazy_load_form_ajax($form, &$form_state) {
  return NULL;
}