clientside_validation.module 43.4 KB
Newer Older
Peter Droogmans's avatar
Peter Droogmans committed
1
2
3
<?php
/**
 * @file
4
 * Add client side validation to forms.
Peter Droogmans's avatar
Peter Droogmans committed
5
 */
6
7
8
define('CLIENTSIDE_VALIDATION_VALIDATE_ALL', 1);
define('CLIENTSIDE_VALIDATION_VALIDATE_SPECIFIC', 0);
define('CLIENTSIDE_VALIDATION_VALIDATE_ALL_EXCEPT', 2);
9
10
11

define('CLIENTSIDE_VALIDATION_EXCLUDE_PATHS', 0); //Add validation on all paths except those specified
define('CLIENTSIDE_VALIDATION_INCLUDE_PATHS', 1); //Only add validation on specified paths
12
13
14
15
16
17
18
19

define('CLIENTSIDE_VALIDATION_JQUERY_SELECTOR', 0);
define('CLIENTSIDE_VALIDATION_TOP_OF_FORM', 1);
define('CLIENTSIDE_VALIDATION_BEFORE_LABEL', 2);
define('CLIENTSIDE_VALIDATION_AFTER_LABEL', 3);
define('CLIENTSIDE_VALIDATION_BEFORE_INPUT', 4);
define('CLIENTSIDE_VALIDATION_AFTER_INPUT', 5);
define('CLIENTSIDE_VALIDATION_TOP_OF_FIRST_FORM', 6);
20
define('CLIENTSIDE_VALIDATION_CUSTOM_ERROR_FUNCTION', 7);
21

Peter Droogmans's avatar
Peter Droogmans committed
22
23
24
25
/**
 * Implements hook_menu().
 */
function clientside_validation_menu() {
26
27
28
29
30
31
  $items['admin/config/validation'] = array(
    'title' => 'Validation',
    'description' => 'Validation settings.',
    'position' => 'right',
    'weight' => -10,
    'page callback' => 'drupal_get_form',
32
    'page arguments' => array('clientside_validation_general_settings_form'),
33
    'access arguments' => array('access administration pages'),
34
    'file' => 'clientside_validation.admin.inc',
35
36
  );
  $items['admin/config/validation/clientside_validation'] = array(
Peter Droogmans's avatar
Peter Droogmans committed
37
38
39
    'title' => 'Clientside Validation',
    'description' => 'Administer clientside validation.',
    'page callback' => 'drupal_get_form',
40
41
42
43
44
45
46
47
48
49
50
51
52
53
    'page arguments' => array('clientside_validation_general_settings_form'),
    'access arguments' => array('administer site configuration'),
    'file' => 'clientside_validation.admin.inc',
  );
  $items['admin/config/validation/clientside_validation/general'] = array(
    'title' => 'General',
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => -1,
  );
  $items['admin/config/validation/clientside_validation/default'] = array(
    'title' => 'Default',
    'type' => MENU_LOCAL_TASK,
    'page callback' => 'drupal_get_form',
    'page arguments' => array('clientside_validation_settings_form'),
Peter Droogmans's avatar
Peter Droogmans committed
54
    'access arguments' => array('administer site configuration'),
55
    'file' => 'clientside_validation.admin.inc',
Peter Droogmans's avatar
Peter Droogmans committed
56
    'weight' => 5,
Jelle Sebreghts's avatar
Jelle Sebreghts committed
57
  );
Peter Droogmans's avatar
Peter Droogmans committed
58
59
60
61
62
63
64
  $items['admin/config/validation/clientside_validation/content-types'] = array(
    'title' => 'Content types',
    'type' => MENU_LOCAL_TASK,
    'page callback' => 'drupal_get_form',
    'page arguments' => array('clientside_validation_settings_overview', 'content-types'),
    'access arguments' => array('administer site configuration'),
    'file' => 'clientside_validation.admin.inc',
Peter Droogmans's avatar
Peter Droogmans committed
65
    'weight' => 10,
Peter Droogmans's avatar
Peter Droogmans committed
66
  );
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
  $items['admin/config/validation/clientside_validation/webforms'] = array(
    'title' => 'Webforms',
    'type' => MENU_LOCAL_TASK,
    'page callback' => 'drupal_get_form',
    'page arguments' => array('clientside_validation_settings_overview', 'webforms'),
    'access arguments' => array('administer site configuration'),
    'file' => 'clientside_validation.admin.inc',
    'weight' => 11,
  );
  $items['admin/config/validation/clientside_validation/custom-forms'] = array(
    'title' => 'Custom forms',
    'type' => MENU_LOCAL_TASK,
    'page callback' => 'drupal_get_form',
    'page arguments' => array('clientside_validation_settings_overview', 'custom-forms'),
    'access arguments' => array('administer site configuration'),
    'file' => 'clientside_validation.admin.inc',
    'weight' => 12,
  );
Peter Droogmans's avatar
Peter Droogmans committed
85
86
  $items['admin/config/validation/clientside_validation/%/%/edit'] = array(
    'title' => 'Edit settings',
Peter Droogmans's avatar
Peter Droogmans committed
87
    'type' => MENU_CALLBACK,
Peter Droogmans's avatar
Peter Droogmans committed
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
    'page callback' => 'drupal_get_form',
    'page arguments' => array('clientside_validation_settings_form', 5, 4),
    'access arguments' => array('administer site configuration'),
    'file' => 'clientside_validation.admin.inc',
  );
  $items['admin/config/validation/clientside_validation/%/%/disable'] = array(
    'title' => 'Disable settings',
    'type' => MENU_CALLBACK,
    'page callback' => 'drupal_get_form',
    'page arguments' => array('clientside_validation_settings_confirmation_form', 5, 4, 'disable'),
    'access arguments' => array('administer site configuration'),
    'file' => 'clientside_validation.admin.inc',
  );
  $items['admin/config/validation/clientside_validation/%/%/enable'] = array(
    'title' => 'Enable settings',
    'type' => MENU_CALLBACK,
    'page callback' => 'drupal_get_form',
    'page arguments' => array('clientside_validation_settings_confirmation_form', 5, 4, 'enable'),
    'access arguments' => array('administer site configuration'),
    'file' => 'clientside_validation.admin.inc',
  );
  $items['admin/config/validation/clientside_validation/%/%/delete'] = array(
    'title' => 'Delete settings',
    'type' => MENU_CALLBACK,
    'page callback' => 'drupal_get_form',
    'page arguments' => array('clientside_validation_settings_confirmation_form', 5, 4, 'delete'),
    'access arguments' => array('administer site configuration'),
    'file' => 'clientside_validation.admin.inc',
  );
  
118
  $items['clientside_validation/ajax'] = array(
Jelle Sebreghts's avatar
Jelle Sebreghts committed
119
120
121
122
    'title' => 'Clientside validation ajax callback',
    'page callback' => '_clientside_validation_ajax_call',
    'access arguments' => array('access content'),
    'type' => MENU_CALLBACK,
Peter Droogmans's avatar
Peter Droogmans committed
123
  );
124
125
126
127
128
129
  $items['clientside_validation/phone'] = array(
    'title' => 'Clientside validation ajax callback to validate phone numbers',
    'page callback' => '_clientside_validation_ajax_phone',
    'access arguments' => array('access content'),
    'type' => MENU_CALLBACK,
  );
Peter Droogmans's avatar
Peter Droogmans committed
130
131
132
  return $items;
}

Jelle Sebreghts's avatar
Jelle Sebreghts committed
133
function _clientside_validation_ajax_call() {
Jelle Sebreghts's avatar
Jelle Sebreghts committed
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
  $param = $_POST['param'];
  $value = $_POST['value'];
  $result = array();
  foreach ($param['expressions'] as $key => $regex) {
    if (!(bool) preg_match($regex, (string) $value)) {
      $result =  array('result' => FALSE, 'message' => $param['messages'][$key]);
      break;
    }
  }
  if (empty($result)) {
    $result = array('result' => TRUE);
  }
  drupal_json_output($result);
}

149
150
151
152
153
154
155
function _clientside_validation_ajax_phone() {
  $value = $_POST['value'];
  $country_code = $_POST['country_code'];
  $result['result'] = valid_phone_number($country_code, $value);
  drupal_json_output($result);
}

Peter Droogmans's avatar
Peter Droogmans committed
156
/**
Jelle Sebreghts's avatar
Jelle Sebreghts committed
157
 * Implements hook_form_alter().
Peter Droogmans's avatar
Peter Droogmans committed
158
 */
159
function clientside_validation_form_alter(&$form, &$form_state, $form_id) {
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
  $page_match = TRUE;
  $path_filter = variable_get('clientside_validation_path_list', '');
  $in_or_exclude = variable_get('clientside_validation_filter_paths', CLIENTSIDE_VALIDATION_EXCLUDE_PATHS);
  if (!empty($path_filter)) {
    $path = drupal_get_path_alias($_GET['q']);
    // Compare with the internal and path alias (if any).
    $page_match = drupal_match_path($path, $path_filter);
    if ($path != $_GET['q']) {
      $page_match = $page_match || drupal_match_path($_GET['q'], $path_filter);
    }
    // When $in_or_exclude has a value of 0 (CLIENTSIDE_VALIDATION_EXCLUDE_PATHS),
    // Clientside Validation is added on all pages except those listed in $path_filter.
    // When set to 1 (CLIENTSIDE_VALIDATION_INCLUDE_PATHS), it is displayed only on
    // those pages listed in $path_filter.
    $page_match = !((bool)$in_or_exclude xor $page_match);
  }
Jelle Sebreghts's avatar
Jelle Sebreghts committed
176
  if (!$page_match) {
177
178
    return;
  }
179
180
  $validate_specific_setting = variable_get('clientside_validation_validate_specific', '');
  $validate_specific = preg_split('/(\r\n?|\n)/', $validate_specific_setting, -1, PREG_SPLIT_NO_EMPTY);
181
182
183
184
185
186
  if (variable_get('clientside_validation_validate_all', CLIENTSIDE_VALIDATION_VALIDATE_ALL) == CLIENTSIDE_VALIDATION_VALIDATE_SPECIFIC
    && !in_array($form_id, $validate_specific)) {
    return;
  }
  elseif (variable_get('clientside_validation_validate_all', CLIENTSIDE_VALIDATION_VALIDATE_ALL) == CLIENTSIDE_VALIDATION_VALIDATE_ALL_EXCEPT
    && in_array($form_id, $validate_specific)) {
187
188
    return;
  }
Peter Droogmans's avatar
Peter Droogmans committed
189
  
190
  if (strpos($form_id, 'webform_client_form') !== FALSE) {
Peter Droogmans's avatar
Peter Droogmans committed
191
192
    $definedsettings = clientside_validation_settings_load(NULL, 'webforms', $form['#node']->nid);
    clientside_validation_settings_current_form($definedsettings);
193
    if (isset($form['actions']['previous'])) {
194
      $form['actions']['previous']['#attributes']['class'][] = 'cancel';
195
    }
196
    $form['#after_build'][] = 'clientside_validation_webform_after_build';
197
  }
198
  else {
Peter Droogmans's avatar
Peter Droogmans committed
199
200
201
202
203
204
205
    if (isset($form['#node_edit_form']) && $form['#node_edit_form']) {
      $definedsettings = clientside_validation_settings_load(NULL, 'content-types', $form['#node']->type);
    }
    else {
      $definedsettings = clientside_validation_settings_load(NULL, 'content-types', $form_id);
    }
    clientside_validation_settings_current_form($definedsettings);
206
207
208
    if (isset($form['actions']['delete'])) {
      $form['actions']['delete']['#attributes']['class'][] = 'cancel';
    }
209
    $form['#after_build'][] = 'clientside_validation_form_after_build';
210
211
212
213
214
215
216
217
218
  }
}

/**
 * Webform.
 */
function clientside_validation_webform_after_build(&$form, &$form_state) {
  $js_rules = array();
  drupal_alter("clientside_validation_webform", $form, $form_state, $js_rules);
Peter Droogmans's avatar
Peter Droogmans committed
219
  if (!empty($js_rules)) {
220
    $settings = array();
221
    _clientside_validation_add_general_settings($settings, $form['#id']);
222
    _clientside_validation_add_special_rules($js_rules, $settings, $form);
Jelle Sebreghts's avatar
Jelle Sebreghts committed
223

Peter Droogmans's avatar
Peter Droogmans committed
224
225
226
227
228
229
    if (variable_get('clientside_validation_use_minified', 0) == 0) {
      drupal_add_js(drupal_get_path('module', 'clientside_validation') . '/jquery-validate/jquery.validate.js');
    }
    else {
      drupal_add_js(drupal_get_path('module', 'clientside_validation') . '/jquery-validate/jquery.validate.min.js');
    }
230
    //add our js file to the footer to support vertical_tabs
231
    drupal_add_js(drupal_get_path('module', 'clientside_validation') . '/clientside_validation.js', array('scope' => 'footer', 'weight' => 20));
Peter Droogmans's avatar
Peter Droogmans committed
232
233
234
235
236
    drupal_add_js($settings, 'setting');
  }
  return $form;
}

237
function _clientside_validation_add_special_rules(&$js_rules, &$settings, $form) {
238
  if (isset($js_rules['_groups'])) {
239
    $settings['clientsideValidation']['groups'][$form['#id']] = (object)$js_rules['_groups'];
240
241
242
    unset($js_rules['_groups']);
  }
  else {
Jelle Sebreghts's avatar
Jelle Sebreghts committed
243
    $settings['clientsideValidation']['groups'][$form['#id']] = new stdClass();
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
  foreach ($js_rules as $key => $rule) {
    if (isset($rule['checkboxgroupminmax'])) {
      $settings['clientsideValidation']['forms'][$form['#id']]['checkboxrules'][$key] = array(
          'checkboxgroupminmax' => $rule['checkboxgroupminmax'],
          'messages' => array('checkboxgroupminmax' => $rule['messages']['checkboxgroupminmax'])
      );
      unset($rule['checkboxgroupminmax']);
      unset($rule['messages']['checkboxgroupminmax']);
      if (empty($rule['messages'])) {
        unset($rule['messages']);
      }
    }
    if (isset($rule['daterange'])) {
      $settings['clientsideValidation']['forms'][$form['#id']]['daterangerules'][$key] = array(
          'daterange' => $rule['daterange'],
          'messages' => array('daterange' => $rule['messages']['daterange'])
      );
      unset($rule['daterange']);
      unset($rule['messages']['daterange']);
      if (empty($rule['messages'])) {
        unset($rule['messages']);
      }
    }
    if (isset($rule['datemin'])) {
      $settings['clientsideValidation']['forms'][$form['#id']]['dateminrules'][$key] = array(
          'daterange' => $rule['datemin'],
          'messages' => array('datemin' => $rule['messages']['datemin'])
      );
      unset($rule['datemin']);
      unset($rule['messages']['datemin']);
      if (empty($rule['messages'])) {
        unset($rule['messages']);
      }
    }
    if (isset($rule['datemax'])) {
      $settings['clientsideValidation']['forms'][$form['#id']]['datemaxrules'][$key] = array(
          'daterange' => $rule['datemax'],
          'messages' => array('datemax' => $rule['messages']['datemax'])
      );
      unset($rule['datemax']);
      unset($rule['messages']['datemax']);
      if (empty($rule['messages'])) {
        unset($rule['messages']);
      }
    }
    if (!empty($rule)) {
      $settings['clientsideValidation']['forms'][$form['#id']]['rules'][$key] = $rule;
    }
  }
}

Peter Droogmans's avatar
Peter Droogmans committed
296
/**
297
 * Regular form.
Peter Droogmans's avatar
Peter Droogmans committed
298
299
300
 */
function clientside_validation_form_after_build(&$form, &$form_state) {
  static $js_rules = array();
301
  static $form_ids = array();
Peter Droogmans's avatar
Peter Droogmans committed
302

303
304
305
  if (isset($form_ids[$form['#id']])) {
    return $form;
  }
Jelle Sebreghts's avatar
Jelle Sebreghts committed
306

307
  drupal_alter("clientside_validation_form", $form, $form_state, $js_rules);
Peter Droogmans's avatar
Peter Droogmans committed
308
  if (!empty($js_rules)) {
309
    $settings = array();
310
    _clientside_validation_add_general_settings($settings, $form['#id']);
311
    _clientside_validation_add_special_rules($js_rules, $settings, $form);
Peter Droogmans's avatar
Peter Droogmans committed
312
313
314
315
316
317
    if (variable_get('clientside_validation_use_minified', 0) == 0) {
      drupal_add_js(drupal_get_path('module', 'clientside_validation') . '/jquery-validate/jquery.validate.js');
    }
    else {
      drupal_add_js(drupal_get_path('module', 'clientside_validation') . '/jquery-validate/jquery.validate.min.js');
    }
318
    //add our js file to the footer to support vertical_tabs
319
    drupal_add_js(drupal_get_path('module', 'clientside_validation') . '/clientside_validation.js', array('scope' => 'footer', 'weight' => 20));
Peter Droogmans's avatar
Peter Droogmans committed
320
    drupal_add_js($settings, 'setting');
321
    $form_ids[$form['#id']] = TRUE;
Peter Droogmans's avatar
Peter Droogmans committed
322
323
  }

324
  return $form;
Peter Droogmans's avatar
Peter Droogmans committed
325
326
}

327
function _clientside_validation_add_general_settings(&$settings, $form_id) {
Peter Droogmans's avatar
Peter Droogmans committed
328
329
  $definedsettings = clientside_validation_settings_current_form();

330
  // Add a setting for this form if the hidden elements should still be validated
Peter Droogmans's avatar
Peter Droogmans committed
331
  $include_hidden_setting = $definedsettings['include_hidden']['include_hidden'];
332
333
334
335
  $include_hidden = preg_split('/(\r\n?|\n)/', $include_hidden_setting, -1, PREG_SPLIT_NO_EMPTY);
  if (in_array(str_replace('-', '_', $form_id), $include_hidden)) {
    $setting['clientsideValidation']['forms'][$form_id]['includeHidden'] = TRUE;
  }
Peter Droogmans's avatar
Peter Droogmans committed
336
337
  elseif ($definedsettings['include_hidden']['include_hidden']) {
    $setting['clientsideValidation']['forms'][$form_id]['includeHidden'] = TRUE;
338
  }
Peter Droogmans's avatar
Peter Droogmans committed
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357

  $settings['clientsideValidation']['forms'][$form_id]['errorPlacement'] = $definedsettings['error_placement']['error_placement_default'];
  switch ($definedsettings['error_placement']['error_placement_default']) {
    case CLIENTSIDE_VALIDATION_JQUERY_SELECTOR:
      if (!empty($definedsettings['error_placement']['jquery_selector'])) {
        $settings['clientsideValidation']['forms'][$form_id]['errorJquerySelector'] = $definedsettings['error_placement']['jquery_selector'];
      }
      else {
        $settings['clientsideValidation']['forms'][$form_id]['errorPlacement'] = CLIENTSIDE_VALIDATION_TOP_OF_FIRST_FORM;
      }
      break;
    case CLIENTSIDE_VALIDATION_CUSTOM_ERROR_FUNCTION:
      if (!empty($definedsettings['error_placement']['custom_error_function'])) {
        $settings['clientsideValidation']['forms'][$form_id]['customErrorFunction'] = $definedsettings['error_placement']['custom_error_function'];
      }
      else {
        $settings['clientsideValidation']['forms'][$form_id]['errorPlacement'] = CLIENTSIDE_VALIDATION_TOP_OF_FIRST_FORM;
      }
      break;
358
  }
Peter Droogmans's avatar
Peter Droogmans committed
359

360
  $form_settings_added[] = str_replace('-', '_', $form_id);
Peter Droogmans's avatar
Peter Droogmans committed
361
362
363
364
365
366
367
368
369
370
371
372
373
374
  
  $settings['clientsideValidation']['forms'][$form_id]['general'] = array(
    "errorClass" => "error", // @TODO: option?
    "wrapper" => "li", // @TODO: option?
    "validateTabs" => $definedsettings['include_hidden']['validate_tabs'],
    "scrollTo" => $definedsettings['error']['scrollto_errormessage'],
    "scrollSpeed" => $definedsettings['error']['scroll_speed'],
    "disableHtml5Validation" => $definedsettings['validate_options']['disable_html5'],
    "validateOnBlur" => $definedsettings['validate_options']['validate_onblur'],
    "validateOnBlurAlways" => $definedsettings['validate_options']['validate_onblur_always'],
    "validateOnKeyUp" => $definedsettings['validate_options']['validate_onkeyup'],
    "validateOnSubmit" => $definedsettings['validate_options']['validate_onsubmit'],
    "showMessages" => $definedsettings['validate_options']['show_messages'],
    "errorElement" => $definedsettings['error']['error_element'],
375
376
377
  );
}

378
379
380
/**
 * Set validation rule for required fields.
 */
Jelle's avatar
Jelle committed
381
function _clientside_validation_set_required($name, $title, $required, &$js_rules, $message = '') {
Peter Droogmans's avatar
Peter Droogmans committed
382
  $title = _clientside_validation_set_title($title);
Peter Droogmans's avatar
Peter Droogmans committed
383
384
  if ($required) {
    $js_rules[$name]['required'] = TRUE;
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
    if (empty($message)) {
      $variables = array(
        'message' => '!title field is required.',
        'placeholders' => array('!title' => $title),
        'error_type' => 'required',
        'element_name' => $name,
      );
    }
    else {
      $variables = array(
        'message' => $message,
        'error_type' => 'required',
        'element_name' => $name,
      );
    }
    $js_rules[$name]['messages']['required'] = theme('clientside_error', $variables);
Peter Droogmans's avatar
Peter Droogmans committed
401
402
403
  }
}

Peter Droogmans's avatar
Peter Droogmans committed
404
405
406
407
408
409
410
411
/**
 * Set validation rule for number fields.
 */
function _clientside_validation_set_title($title) {
  $settings = clientside_validation_settings_current_form();
  return $settings['error']['prefix'] . $title . $settings['error']['suffix'];
}

412
413
414
/**
 * Set validation rule for number fields.
 */
415
function _clientside_validation_set_number($name, $title, &$js_rules, $message = '') {
Peter Droogmans's avatar
Peter Droogmans committed
416
  $title = _clientside_validation_set_title($title);
Peter Droogmans's avatar
Peter Droogmans committed
417
  $js_rules[$name]['digits_negative'] = TRUE;
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
  if (empty($message)) {
    $variables = array(
      'message' => '!title field accepts only numbers.',
      'placeholders' => array('!title' => $title),
      'error_type' => 'number',
      'element_name' => $name,
    );
  }
  else {
    $variables = array(
      'message' => $message,
      'error_type' => 'number',
      'element_name' => $name,
    );
  }
433
  $js_rules[$name]['messages']['digits_negative'] = theme('clientside_error', $variables);
Peter Droogmans's avatar
Peter Droogmans committed
434
435
}

436
437
438
/**
 * Set validation rule for decimal fields.
 */
439
function _clientside_validation_set_number_decimal($name, $title, $decimalpoint, &$js_rules, $message = '') {
Peter Droogmans's avatar
Peter Droogmans committed
440
  $title = _clientside_validation_set_title($title);
Peter Droogmans's avatar
Peter Droogmans committed
441
442
  if ($decimalpoint == '.') {
    $js_rules[$name]['number'] = TRUE;
443
    $variables = array(
444
445
      'message' => empty($message) ? '!title field accepts only numbers (use a \'.\' as decimal point).' : $message,
      'placeholders' => empty($message) ? array('!title' => $title) : array(),
446
447
448
449
      'error_type' => 'number',
      'element_name' => $name,
    );
    $js_rules[$name]['messages']['number'] = theme('clientside_error', $variables);
Peter Droogmans's avatar
Peter Droogmans committed
450
451
452
  }
  else {
    $js_rules[$name]['numberDE'] = TRUE;
453
    $variables = array(
454
455
      'message' => empty($message) ? '!title field accepts only numbers (use a \',\' as decimal point).' : $message,
      'placeholers' => empty($message) ? array('!title' => $title) : array(),
456
457
458
459
      'error_type' => 'number',
      'element_name' => $name,
    );
    $js_rules[$name]['messages']['numberDE'] = theme('clientside_error', $variables);
Peter Droogmans's avatar
Peter Droogmans committed
460
461
462
  }
}

463
464
465
/**
 * Set validation rule for fields with a minimum and/or a maximum value.
 */
Jelle's avatar
Jelle committed
466
function _clientside_validation_set_minmax($name, $title, $min, $max, &$js_rules, $message = '') {
Peter Droogmans's avatar
Peter Droogmans committed
467
  $title = _clientside_validation_set_title($title);
468
  if (isset($min) && $min !== '' && isset($max) && $max !== '') {
Peter Droogmans's avatar
Peter Droogmans committed
469
    $js_rules[$name]['range'] = array($min, $max);
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
    if (empty($message)) {
      $variables = array(
        'message' => '!title field has to be between !min and !max.',
        'placeholders' => array('!title' => $title, '!min' => $min, '!max' => $max),
        'error_type' => 'range',
        'element_name' => $name,
      );
    }
    else {
      $variables = array(
        'message' => $message,
        'error_type' => 'range',
        'element_name' => $name,
      );
    }
    $js_rules[$name]['messages']['range'] = theme('clientside_error', $variables);
Peter Droogmans's avatar
Peter Droogmans committed
486
  }
487
  elseif (isset($min) && $min !== '') {
Peter Droogmans's avatar
Peter Droogmans committed
488
    $js_rules[$name]['min'] = $min;
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
    if (empty($message)) {
      $variables = array(
        'message' => '!title field has to be greater than !min.',
        'placeholders' => array('!title' => $title, '!min' => $min),
        'error_type' => 'min',
        'element_name' => $name,
      );
    }
    else {
      $variables = array(
        'message' => $message,
        'error_type' => 'min',
        'element_name' => $name,
      );
    }
    $js_rules[$name]['messages']['min'] = theme('clientside_error', $variables);
Peter Droogmans's avatar
Peter Droogmans committed
505
  }
506
  elseif (isset($max) && $max !== '') {
Peter Droogmans's avatar
Peter Droogmans committed
507
    $js_rules[$name]['max'] = $max;
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
    if (empty($message)) {
      $variables = array(
        'message' => '!title field has to be smaller than !max.',
        'placeholders' => array('!title' => $title, '!max' => $max),
        'error_type' => 'max',
        'element_name' => $name,
      );
    }
    else {
      $variables = array(
        'message' => $message,
        'error_type' => 'max',
        'element_name' => $name,
      );
    }
    $js_rules[$name]['messages']['max'] = theme('clientside_error', $variables);
Peter Droogmans's avatar
Peter Droogmans committed
524
525
526
  }
}

527
function _clientside_validation_set_minmax_date($name, $title, $start_date, $end_date, &$js_rules, $message = '') {
Peter Droogmans's avatar
Peter Droogmans committed
528
  $title = _clientside_validation_set_title($title);
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
  if (isset($start_date) && $start_date !== '' && isset($end_date) && $end_date !== '') {
    $js_rules[$name]['daterange'] = array($start_date, $end_date);
    if (empty($message)) {
      $variables = array(
        'message' => '!title field has to be between !min and !max.',
        'placeholders' => array('!title' => $title, '!min' => $start_date, '!max' => $end_date),
        'error_type' => 'daterange',
        'element_name' => $name,
      );
    }
    else {
      $variables = array(
        'message' => $message,
        'error_type' => 'daterange',
        'element_name' => $name,
      );
    }
    $js_rules[$name]['messages']['daterange'] = theme('clientside_error', $variables);
  }
  elseif (isset($start_date) && $start_date !== '') {
    $js_rules[$name]['datemin'] = $start_date;
    if (empty($message)) {
      $variables = array(
        'message' => '!title field has to be greater than !min.',
        'placeholders' => array('!title' => $title, '!min' => $start_date),
        'error_type' => 'datemin',
        'element_name' => $name,
      );
    }
    else {
      $variables = array(
        'message' => $message,
        'error_type' => 'datemin',
        'element_name' => $name,
      );
    }
    $js_rules[$name]['messages']['datemin'] = theme('clientside_error', $variables);
  }
  elseif (isset($end_date) && $end_date !== '') {
    $js_rules[$name]['datemax'] = $end_date;
    if (empty($message)) {
      $variables = array(
        'message' => '!title field has to be smaller than !max.',
        'placeholders' => array('!title' => $title, '!max' => $end_date),
        'error_type' => 'datemax',
        'element_name' => $name,
      );
    }
    else {
      $variables = array(
        'message' => $message,
        'error_type' => 'datemax',
        'element_name' => $name,
      );
    }
    $js_rules[$name]['messages']['datemax'] = theme('clientside_error', $variables);
  }
}

588
589
590
/**
 * Set validation rule for fields with a minimum and/or maximum length.
 */
Jelle's avatar
Jelle committed
591
function _clientside_validation_set_minmaxlength($name, $title, $min, $max, &$js_rules, $message = '') {
Peter Droogmans's avatar
Peter Droogmans committed
592
  $title = _clientside_validation_set_title($title);
Jelle Sebreghts's avatar
Jelle Sebreghts committed
593
  if ($max == 1) {
594
595
    $max = '';
  }
596
  if (isset($min) && $min !== '' && isset($max) && $max !== '') {
Peter Droogmans's avatar
Peter Droogmans committed
597
    $js_rules[$name]['rangelength'] = array($min, $max);
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
    if (empty($message)) {
      $variables = array(
        'message' => '!title field has to have between !min and !max values.',
        'placeholders' => array('!title' => $title, '!min' => $min, '!max' => $max),
        'error_type' => 'rangelength',
        'element_name' => $name,
      );
    }
    else {
      $variables = array(
        'message' => $message,
        'error_type' => 'rangelength',
        'element_name' => $name,
      );
    }
    $js_rules[$name]['messages']['rangelength'] = theme('clientside_error', $variables);
Peter Droogmans's avatar
Peter Droogmans committed
614
  }
615
  elseif (isset($min) && $min !== '') {
Peter Droogmans's avatar
Peter Droogmans committed
616
    $js_rules[$name]['minlength'] = $min;
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
    if (empty($message)) {
      $variables = array(
        'message' => '!title field has to have minimal !min values.',
        'placeholders' => array('!title' => $title, '!min' => $min),
        'error_type' => 'minlength',
        'element_name' => $name,
      );
    }
    else {
      $variables = array(
        'message' => $message,
        'error_type' => 'minlength',
        'element_name' => $name,
      );
    }
    $js_rules[$name]['messages']['minlength'] = theme('clientside_error', $variables);
Peter Droogmans's avatar
Peter Droogmans committed
633
  }
634
  elseif (isset($max) && $max !== '') {
Peter Droogmans's avatar
Peter Droogmans committed
635
    $js_rules[$name]['maxlength'] = $max;
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
    if (empty($message)) {
      $variables = array(
        'message' => '!title field has to have maximum !max values.',
        'placeholders' => array('!title' => $title, '!max' => $max),
        'error_type' => 'maxlength',
        'element_name' => $name,
      );
    }
    else {
      $variables = array(
        'message' => $message,
        'error_type' => 'maxlength',
        'element_name' => $name,
      );
    }
    $js_rules[$name]['messages']['maxlength'] = theme('clientside_error', $variables);
Peter Droogmans's avatar
Peter Droogmans committed
652
653
654
  }
}

655
656
657
658
/**
 * Set validation rule for fields with a minimum and/or maximum amount of words.
 */
function _clientside_validation_set_minmax_words($name, $title, $min, $max, &$js_rules, $message = '') {
Peter Droogmans's avatar
Peter Droogmans committed
659
  $title = _clientside_validation_set_title($title);
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
  if (isset($min) && $min !== '' && isset($max) && $max !== '') {
    $js_rules[$name]['rangewords'] = array($min, $max);
    if (empty($message)) {
      $variables = array(
        'message' => '!title field has to have between !min and !max words.',
        'placeholders' => array('!title' => $title, '!min' => $min, '!max' => $max),
        'error_type' => 'rangewords',
        'element_name' => $name,
      );
    }
    else {
      $variables = array(
        'message' => $message,
        'error_type' => 'rangewords',
        'element_name' => $name,
      );
    }
    $js_rules[$name]['messages']['rangewords'] = theme('clientside_error', $variables);
  }
  elseif (isset($min) && $min !== '') {
    $js_rules[$name]['minwords'] = $min;
    if (empty($message)) {
      $variables = array(
        'message' => '!title field has to have minimal !min words.',
        'placeholders' => array('!title' => $title, '!min' => $min),
        'error_type' => 'minwords',
        'element_name' => $name,
      );
    }
    else {
      $variables = array(
        'message' => $message,
        'error_type' => 'minwords',
        'element_name' => $name,
      );
    }
    $js_rules[$name]['messages']['minwords'] = theme('clientside_error', $variables);
  }
  elseif (isset($max) && $max !== '') {
    $js_rules[$name]['maxwords'] = $max;
    if (empty($message)) {
      $variables = array(
        'message' => '!title field has to have maximum !max words.',
        'placeholders' => array('!title' => $title, '!max' => $max),
        'error_type' => 'maxwords',
        'element_name' => $name,
      );
    }
    else {
      $variables = array(
        'message' => $message,
        'error_type' => 'maxwords',
        'element_name' => $name,
      );
    }
    $js_rules[$name]['messages']['maxwords'] = theme('clientside_error', $variables);
  }
}

/**
 * Set validation rule for plain text fields
 */
function _clientside_validation_set_plain_text($name, $title, $allowed_tags, &$js_rules, $message = '') {
Peter Droogmans's avatar
Peter Droogmans committed
723
  $title = _clientside_validation_set_title($title);
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
  $js_rules[$name]['plaintext'] = empty($allowed_tags) ? '' : $allowed_tags;
  if (empty($message)) {
      $variables = array(
        'message' => (empty($allowed_tags)) ? '!title field can not contain any HTML tags' :  '!title field can not contain any HTML tags exept !allowed',
        'placeholders' => array('!title' => $title, '!allowed' => $allowed_tags),
        'error_type' => 'plaintext',
        'element_name' => $name,
      );
    }
    else {
      $variables = array(
        'message' => $message,
        'error_type' => 'plaintext',
        'element_name' => $name,
      );
    }
    $js_rules[$name]['messages']['plaintext'] = theme('clientside_error', $variables);
}

743
744
745
/**
 * Set validation rule for required fields that must equal a value from an other field.
 */
Jelle's avatar
Jelle committed
746
function _clientside_validation_set_equal($name, $title, $value, &$js_rules) {
Peter Droogmans's avatar
Peter Droogmans committed
747
  $title = _clientside_validation_set_title($title);
748
  $js_rules[$name]['equalTo'] = ':input[name=\'submitted[' . $value['form_key'] . ']\']';
749
750
751
752
753
754
755
  $variables = array(
    'message' => '!title field has to be equal to !firstone.',
    'placeholders' => array('!title' => $title, '!firstone' => $value['name']),
    'error_type' => 'equalto',
    'element_name' => $name,
  );
  $js_rules[$name]['messages']['equalTo'] = theme('clientside_error', $variables);
756
757
758
759
760
}

/**
 * Set validation rule for fields that can not be equal to a value from an other field.
 */
761
function _clientside_validation_set_not_equal($name, $title, $element, &$js_rules, $message = '', $webform = FALSE) {
Peter Droogmans's avatar
Peter Droogmans committed
762
  $title = _clientside_validation_set_title($title);
763
764
765
766
767
768
  if ($webform) {
    $js_rules[$name]['notEqualTo'] = ':input[name=\'submitted[' . $element['form_key'] . ']\']';
  }
  else {
    $js_rules[$name]['notEqualTo'] = ':input[name=\'' . $element['form_key'] . '\']';
  }
769
770
771
  if (empty($message)) {
    $variables = array(
      'message' => '!title field has to different from !firstone.',
772
      'placeholders' => array('!title' => $title, '!firstone' => $element['name']),
773
774
775
776
777
778
779
780
781
782
783
784
      'error_type' => 'notequalto',
      'element_name' => $name,
    );
  }
  else {
    $variables = array(
      'message' => $message,
      'error_type' => 'notequalto',
      'element_name' => $name,
    );
  }
  $message = theme('clientside_error', $variables);
785
786
787
788
789
790
  $js_rules[$name]['messages']['notEqualTo'] = $message;
}

/**
 * Set validation rule for fields that must be equal to a specific value.
 */
Jelle's avatar
Jelle committed
791
function _clientside_validation_set_specific_value($name, $title, $value, &$js_rules, $message = '') {
792
  $js_rules[$name]['oneOf'] = $value;
Peter Droogmans's avatar
Peter Droogmans committed
793
  $title = _clientside_validation_set_title($title);
794
795
  if (empty($message)) {
    $variables = array(
796
797
      'message' => '!title field has to be one of the following values: !values.',
      'placeholders' => array('!title' => $title, '!values' => implode(', ', $value)),
798
799
800
801
802
803
804
805
806
807
808
809
      'error_type' => 'specific value',
      'element_name' => $name
    );
  }
  else{
    $variables = array(
      'message' => $message,
      'error_type' => 'specific value',
      'element_name' => $name
    );
  }
  $message = theme('clientside_error', $variables);
810
811
812
  $js_rules[$name]['messages']['oneOf'] = $message;
}

813
814
815
816
817
/**
 * Set validation rule for fields that consist of one or more of specific values (e.g. string with only a, b and c in it).
 */
function _clientside_validation_set_specific_values($name, $title, $values, &$js_rules, $message = '') {
  $js_rules[$name]['specificVals'] = $values;
Peter Droogmans's avatar
Peter Droogmans committed
818
  $title = _clientside_validation_set_title($title);
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
  if (empty($message)) {
    $variables = array(
      'message' => '!title field must consist of following elements only: !elements.',
      'placeholders' => array('!title' => $title, '!elements' => implode(', ', $values)),
      'error_type' => 'specific values',
      'element_name' => $name
    );
  }
  else {
    $variables = array(
      'message' => $message,
      'error_type' => 'specific values',
      'element_name' => $name
    );
  }
  $message = theme('clientside_error', $variables);
835
836
837
  $js_rules[$name]['messages']['specificVals'] = $message;
}

838
839
840
841
842
/**
 * Set validation rule for fields that can not consist of one or more specific values
 */
function _clientside_validation_set_blacklist($name, $title, $values, &$js_rules, $message='') {
  $js_rules[$name]['blacklist'] = $values;
Peter Droogmans's avatar
Peter Droogmans committed
843
  $title = _clientside_validation_set_title($title);
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
  if (empty($message)) {
    $variables = array(
      'message' => '!title field can not consist of following elements: !elements.',
      'placeholders' => array('!title' => $title, '!elements' => implode(', ', $values)),
      'error_type' => 'blacklist',
      'element_name' => $name
    );
  }
  else {
    $variables = array(
      'message' => $message,
      'error_type' => 'blacklist',
      'element_name' => $name
    );
  }
  $message = theme('clientside_error', $variables);
  $js_rules[$name]['messages']['blacklist'] = $message;
}

863
864
865
/**
 * Set validation rule for ean number fields.
 */
Jelle's avatar
Jelle committed
866
function _clientside_validation_set_ean($name, $title, &$js_rules, $message = '') {
Peter Droogmans's avatar
Peter Droogmans committed
867
  $title = _clientside_validation_set_title($title);
868
869
870
871
872
873
  if (empty($message)) {
    $variables = array(
      'message' => '!title field is not a valid EAN number.',
      'placeholders' => array('!title' => $title),
      'error_type' => 'ean',
      'element_name' => $name
Jelle Sebreghts's avatar
Jelle Sebreghts committed
874
    );
875
876
877
878
879
880
881
882
883
  }
  else {
    $variables = array(
      'message' => $message,
      'error_type' => 'ean',
      'element_name' => $name
    );
  }
  $message = theme('clientside_error', $variables);
884
  $js_rules[$name]['validEAN'] = TRUE;
Peter Droogmans's avatar
Peter Droogmans committed
885
  $js_rules[$name]['messages']['validEAN'] = $message;
Peter Droogmans's avatar
Peter Droogmans committed
886
887
}

888
889
890
/**
 * Set validation rule for fields with regex validation from webform_validation
 */
891
function _clientside_validation_set_regex($name, $title, &$js_rules, $expression, $message = '', $modifiers = "", $type = 'regex') {
Peter Droogmans's avatar
Peter Droogmans committed
892
  $title = _clientside_validation_set_title($title);
Jelle Sebreghts's avatar
Jelle Sebreghts committed
893
  if (empty($message)) {
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
    $variables = array(
      'message' => '!title field does not match the required pattern.',
      'placeholders' => array('!title' => $title),
      'error_type' => $type,
      'element_name' => $name
    );
  }
  else {
    $variables = array(
      'message' => $message,
      'error_type' => $type,
      'element_name' => $name
    );
  }
  $message = theme('clientside_error', $variables);
909
  $js_rules[$name]['regexMatch'] = array($expression);
Jelle Sebreghts's avatar
Jelle Sebreghts committed
910
  if (!empty($modifiers)) {
911
912
    $js_rules[$name]['regexMatch'][] = $modifiers;
  }
913
914
915
  $js_rules[$name]['messages']['regexMatch'] = $message;
}

Jelle Sebreghts's avatar
Jelle Sebreghts committed
916
917
918
/**
 * Set validation rule for fields with regex validation from webform_validation
 */
919
function _clientside_validation_set_regex_pcre($name, $title, &$js_rules, $expression, $message = '', $type = 'regex pcre') {
Peter Droogmans's avatar
Peter Droogmans committed
920
  $title = _clientside_validation_set_title($title);
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
  if (empty($message)) {
    $variables = array(
      'message' => '!title field does not match the required pattern.',
      'placeholders' => array('!title' => $title),
      'error_type' => $type,
      'element_name' => $name
    );
  }
  else {
    $variables = array(
      'message' => $message,
      'error_type' => $type,
      'element_name' => $name
    );
  }
  $message = theme('clientside_error', $variables);
Jelle Sebreghts's avatar
Jelle Sebreghts committed
937
  $js_rules[$name]['regexMatchPCRE']['expressions'][] = $expression;
938
  $js_rules[$name]['regexMatchPCRE']['messages'][] = $message;
Jelle Sebreghts's avatar
Jelle Sebreghts committed
939
940
}

941
942
943
/**
 * Set validation rule for file fields that must have a certain extension.
 */
Jelle's avatar
Jelle committed
944
function _clientside_validation_set_extensions($name, $extensions, &$js_rules) {
945
946
  $extension_list = preg_replace('#,(?![^,]+,)#', ' or', implode(', ', $extensions));
  $js_rules[$name]['accept'] = implode('|', $extensions);
947
948
949
950
951
952
953
  $variables = array(
    'message' => "Only files with a %exts extension are allowed.",
    'placeholders' => array('%exts' => $extension_list),
    'error_type' => 'extensions',
    'element_name' => $name
  );
  $js_rules[$name]['messages']['accept'] = theme('clientside_error', $variables);
954
955
956
957
958
}

/**
 * Set validation rule for checkboxes.
 */
959
function _clientside_validation_set_checkboxgroup_minmax($name, $title, $id, &$js_rules, $message = '', $min = 1, $max = 99) {
Peter Droogmans's avatar
Peter Droogmans committed
960
  $title = _clientside_validation_set_title($title);
961
  $js_rules[$name]['checkboxgroupminmax'] = array($min, $max, $id);
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
  if ($message == '') {
    if ($min == 1 && $max == 99) {
      $message = '!title field is required.';
      $placeholders = array('!title' => $title);
    }
    if ($min == 0 && $max != 99) {
      $message = 'You can select no more than !max values for !title.';
      $placeholders = array('!title' => $title, '!max' => $max);
    }
    if ($min != 1 && $max == 99) {
      $message = 'You must select at least !min values for !title.';
      $placeholders = array('!title' => $title, '!min' => $min);
    }
    if ($min > 0 && $max != 99) {
      $message = 'You must select between !min and !max values for !title.';
      $placeholders = array('!title' => $title, '!min' => $min, '!max' => $max);
    }
  }
  else {
    $placeholders = array();
  }
  $variables = array(
    'message' => $message,
    'placeholders' => $placeholders,
986
987
988
989
    'error_type' => 'required',
    'element_name' => $name
  );
  $js_rules[$name]['messages']['checkboxgroupminmax'] = theme('clientside_error', $variables);
990
991
992
993
994
}

/**
 * Set validation rule for email fields.
 */
995
function _clientside_validation_set_email($name, $title, &$js_rules, $message = '') {
Peter Droogmans's avatar
Peter Droogmans committed
996
  $title = _clientside_validation_set_title($title);
997
  $js_rules[$name]['email'] = TRUE;
998
  $variables = array(
999
1000
    'message' => empty($message) ? 'The value in !title is not a valid email address.' : $message,
    'placeholders' => empty($message) ? array('!title' => $title) : array(),
For faster browsing, not all history is shown. View entire blame