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

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
13
14
15
16
17
18
19
20

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);
21
define('CLIENTSIDE_VALIDATION_CUSTOM_ERROR_FUNCTION', 7);
22

Peter Droogmans's avatar
Peter Droogmans committed
23
24
25
26
/**
 * Implements hook_menu().
 */
function clientside_validation_menu() {
27
28
29
30
31
32
33
34
  $items['admin/config/validation'] = array(
    'title' => 'Validation',
    'description' => 'Validation settings.',
    'position' => 'right',
    'weight' => -10,
    'page callback' => 'drupal_get_form',
    'page arguments' => array('clientside_validation_admin_settings'),
    'access arguments' => array('access administration pages'),
35
    'file' => 'clientside_validation.admin.inc',
36
37
  );
  $items['admin/config/validation/clientside_validation'] = array(
Peter Droogmans's avatar
Peter Droogmans committed
38
39
40
41
42
    'title' => 'Clientside Validation',
    'description' => 'Administer clientside validation.',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('clientside_validation_admin_settings'),
    'access arguments' => array('administer site configuration'),
43
    'file' => 'clientside_validation.admin.inc',
Jelle Sebreghts's avatar
Jelle Sebreghts committed
44
  );
45
  $items['clientside_validation/ajax'] = array(
Jelle Sebreghts's avatar
Jelle Sebreghts committed
46
47
48
49
    '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
50
51
52
53
  );
  return $items;
}

Jelle Sebreghts's avatar
Jelle Sebreghts committed
54
function _clientside_validation_ajax_call() {
Jelle Sebreghts's avatar
Jelle Sebreghts committed
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
  $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);
}

Peter Droogmans's avatar
Peter Droogmans committed
70
/**
71
 * Implementation of hook_form_alter().
Peter Droogmans's avatar
Peter Droogmans committed
72
 */
73
function clientside_validation_form_alter(&$form, &$form_state, $form_id) {
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
  $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
90
  if (!$page_match) {
91
92
    return;
  }
93
94
  $validate_specific_setting = variable_get('clientside_validation_validate_specific', '');
  $validate_specific = preg_split('/(\r\n?|\n)/', $validate_specific_setting, -1, PREG_SPLIT_NO_EMPTY);
95
96
97
98
99
100
  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)) {
101
102
    return;
  }
103
104
  if (strpos($form_id, 'webform_client_form') !== FALSE) {
    if (isset($form['actions']['previous'])) {
105
      $form['actions']['previous']['#attributes']['class'][] = 'cancel';
106
    }
107
    $form['#after_build'][] = 'clientside_validation_webform_after_build';
108
  }
109
  else {
110
111
112
    if (isset($form['actions']['delete'])) {
      $form['actions']['delete']['#attributes']['class'][] = 'cancel';
    }
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
    switch ($form['#id']) {
      case 'node-form':
      case 'webform-component-edit-form':
        $form['#after_build'][] = 'clientside_validation_form_after_build';
        break;
      default:
        $form['#after_build'][] = 'clientside_validation_form_after_build';
        break;
    }
  }
}

/**
 * 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
131
  if (!empty($js_rules)) {
132
    $settings = array();
133
    _clientside_validation_add_general_settings($settings, $form['#id']);
Jelle's avatar
Jelle committed
134
    foreach ($js_rules as $key => $rule) {
Peter Droogmans's avatar
Peter Droogmans committed
135
136
137
138
139
140
141
142
143
144
145
146
147
148
      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 (!empty($rule)) {
        $settings['clientsideValidation']['forms'][$form['#id']]['rules'][$key] = $rule;
      }
Peter Droogmans's avatar
Peter Droogmans committed
149
    }
Peter Droogmans's avatar
Peter Droogmans committed
150
151
152
153
154
155
156
    
    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');
    }
157
158
    //add our js file to the footer to support vertical_tabs
    drupal_add_js(drupal_get_path('module', 'clientside_validation') . '/clientside_validation.js', array('scope' => 'footer'));
Peter Droogmans's avatar
Peter Droogmans committed
159
160
161
162
163
164
    drupal_add_js($settings, 'setting');
  }
  return $form;
}

/**
165
 * Regular form.
Peter Droogmans's avatar
Peter Droogmans committed
166
167
168
 */
function clientside_validation_form_after_build(&$form, &$form_state) {
  static $js_rules = array();
169
170
171
172
  static $form_ids = array();
  if (isset($form_ids[$form['#id']])) {
    return $form;
  }
173
  
174
  drupal_alter("clientside_validation_form", $form, $form_state, $js_rules);
Peter Droogmans's avatar
Peter Droogmans committed
175
  if (!empty($js_rules)) {
176
    $settings = array();
177
    _clientside_validation_add_general_settings($settings, $form['#id']);
Jelle's avatar
Jelle committed
178
    foreach ($js_rules as $key => $rule) {
Jelle Sebreghts's avatar
Jelle Sebreghts committed
179
180
181
182
183
184
185
186
187
188
189
190
191
192
      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 (!empty($rule)) {
        $settings['clientsideValidation']['forms'][$form['#id']]['rules'][$key] = $rule;
      }
Peter Droogmans's avatar
Peter Droogmans committed
193
    }
Peter Droogmans's avatar
Peter Droogmans committed
194
195
196
197
198
199
    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');
    }
200
201
    //add our js file to the footer to support vertical_tabs
    drupal_add_js(drupal_get_path('module', 'clientside_validation') . '/clientside_validation.js', array('scope' => 'footer'));
Peter Droogmans's avatar
Peter Droogmans committed
202
    drupal_add_js($settings, 'setting');
203
    $form_ids[$form['#id']] = TRUE;
Peter Droogmans's avatar
Peter Droogmans committed
204
205
  }

206
  return $form;
Peter Droogmans's avatar
Peter Droogmans committed
207
208
}

209
210
211
212
213
214
215
216
217
218
219
220
221
function _clientside_validation_add_general_settings(&$settings, $form_id) {
  // Add a setting for this form if the hidden elements should still be validated
  $include_hidden_setting = variable_get('clientside_validation_include_hidden', '');
  $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;
  }

  $jquery = preg_split('/(\r\n?|\n)/', variable_get('clientside_validation_error_placement_jquery', ''), -1, PREG_SPLIT_NO_EMPTY);
  $top_of_form = preg_split('/(\r\n?|\n)/', variable_get('clientside_validation_error_placement_top_of_form', ''), -1, PREG_SPLIT_NO_EMPTY);
  $before_label = preg_split('/(\r\n?|\n)/', variable_get('clientside_validation_error_placement_before_label', ''), -1, PREG_SPLIT_NO_EMPTY);
  $after_label = preg_split('/(\r\n?|\n)/', variable_get('clientside_validation_error_placement_after_label', ''), -1, PREG_SPLIT_NO_EMPTY);
  $before_input = preg_split('/(\r\n?|\n)/', variable_get('clientside_validation_error_placement_before_input', ''), -1, PREG_SPLIT_NO_EMPTY);
222
  $custom_function = preg_split('/(\r\n?|\n)/', variable_get('clientside_validation_error_placement_custom_function', ''), -1, PREG_SPLIT_NO_EMPTY);
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
  $after_input = preg_split('/(\r\n?|\n)/', variable_get('clientside_validation_error_placement_after_input', ''), -1, PREG_SPLIT_NO_EMPTY);
  $jquery_selector = variable_get('clientside_validation_jquery_selector', '');

  if (in_array(str_replace('-', '_', $form_id), $jquery) && !empty($jquery_selector)) {
    $settings['clientsideValidation']['forms'][$form_id]['errorPlacement'] = CLIENTSIDE_VALIDATION_JQUERY_SELECTOR;
    $settings['clientsideValidation']['forms'][$form_id]['errorJquerySelector'] = $jquery_selector;
  }
  elseif (in_array(str_replace('-', '_', $form_id), $top_of_form)) {
    $settings['clientsideValidation']['forms'][$form_id]['errorPlacement'] = CLIENTSIDE_VALIDATION_TOP_OF_FORM;
  }
  elseif (in_array(str_replace('-', '_', $form_id), $before_label)) {
    $settings['clientsideValidation']['forms'][$form_id]['errorPlacement'] = CLIENTSIDE_VALIDATION_BEFORE_LABEL;
  }
  elseif (in_array(str_replace('-', '_', $form_id), $after_label)) {
    $settings['clientsideValidation']['forms'][$form_id]['errorPlacement'] = CLIENTSIDE_VALIDATION_AFTER_LABEL;
  }
  elseif (in_array(str_replace('-', '_', $form_id), $before_input)) {
    $settings['clientsideValidation']['forms'][$form_id]['errorPlacement'] = CLIENTSIDE_VALIDATION_BEFORE_INPUT;
  }
  elseif (in_array(str_replace('-', '_', $form_id), $after_input)) {
    $settings['clientsideValidation']['forms'][$form_id]['errorPlacement'] = CLIENTSIDE_VALIDATION_AFTER_INPUT;
  }
245
246
247
248
  elseif (in_array(str_replace('-', '_', $form_id), $custom_function)) {
    $settings['clientsideValidation']['forms'][$form_id]['errorPlacement'] = CLIENTSIDE_VALIDATION_CUSTOM_ERROR_FUNCTION;
    $settings['clientsideValidation']['forms'][$form_id]['customErrorFunction'] = variable_get('clientside_validation_custom_error_function', '');
  }
249
250
251
252
253
254
255
256
  else {
    if (variable_get('clientside_validation_error_placement_default', CLIENTSIDE_VALIDATION_TOP_OF_FIRST_FORM) == CLIENTSIDE_VALIDATION_JQUERY_SELECTOR
        && empty($jquery_selector)) {
      $settings['clientsideValidation']['forms'][$form_id]['errorPlacement'] = CLIENTSIDE_VALIDATION_TOP_OF_FIRST_FORM;
    }
    else {
      $settings['clientsideValidation']['forms'][$form_id]['errorPlacement'] = variable_get('clientside_validation_error_placement_default', CLIENTSIDE_VALIDATION_TOP_OF_FIRST_FORM);
      $settings['clientsideValidation']['forms'][$form_id]['errorJquerySelector'] = $jquery_selector;
257
      $settings['clientsideValidation']['forms'][$form_id]['customErrorFunction'] = variable_get('clientside_validation_custom_error_function', '');
258
259
260
    }
  }
  $form_settings_added[] = str_replace('-', '_', $form_id);
261
262
263
264
265
266
267
268
269
270
271
272
273
  $settings['clientsideValidation']['general'] = array(
    "errorClass" => "error",
    "wrapper" => "li",
    "validateTabs" =>  variable_get('clientside_validation_validate_tabs', 1),
    "scrollTo" => variable_get('clientside_validation_scrollto_errormessage', 1),
    "scrollSpeed" => (int)variable_get('clientside_validation_scroll_speed', 1000),
    "disableHtml5Validation" => variable_get('clientside_validation_disable_html5', 1),
    "validateOnBlur" => variable_get('clientside_validation_validate_onblur', 1),
    "validateOnKeyUp" => variable_get('clientside_validation_validate_onkeyup', 1),
    "validateOnSubmit" => variable_get('clientside_validation_validate_onsubmit', 1),
  );
}

274
275
276
/**
 * Set validation rule for required fields.
 */
Jelle's avatar
Jelle committed
277
function _clientside_validation_set_required($name, $title, $required, &$js_rules, $message = '') {
Jelle Sebreghts's avatar
Jelle Sebreghts committed
278
  $title = variable_get('clientside_validation_prefix', '') . $title . variable_get('clientside_validation_suffix', '');
Peter Droogmans's avatar
Peter Droogmans committed
279
280
  if ($required) {
    $js_rules[$name]['required'] = TRUE;
281
    $js_rules[$name]['messages']['required'] = (empty($message)) ? theme('clientside_error', array('message' => '!name field is required.', 'placeholders' => array('!name' => $title))) : theme('clientside_error', array('message' => $message));
Peter Droogmans's avatar
Peter Droogmans committed
282
283
284
  }
}

285
286
287
/**
 * Set validation rule for number fields.
 */
288
function _clientside_validation_set_number($name, $title, &$js_rules) {
Jelle Sebreghts's avatar
Jelle Sebreghts committed
289
  $title = variable_get('clientside_validation_prefix', '') . $title . variable_get('clientside_validation_suffix', '');
Peter Droogmans's avatar
Peter Droogmans committed
290
  $js_rules[$name]['digits_negative'] = TRUE;
291
  $js_rules[$name]['messages']['digits_negative'] = theme('clientside_error', array('message' => '!name field accepts only numbers.', 'placeholders' => array('!name' => $title)));
Peter Droogmans's avatar
Peter Droogmans committed
292
293
}

294
295
296
/**
 * Set validation rule for decimal fields.
 */
297
function _clientside_validation_set_number_decimal($name, $title, $decimalpoint, &$js_rules) {
Jelle Sebreghts's avatar
Jelle Sebreghts committed
298
  $title = variable_get('clientside_validation_prefix', '') . $title . variable_get('clientside_validation_suffix', '');
Peter Droogmans's avatar
Peter Droogmans committed
299
300
  if ($decimalpoint == '.') {
    $js_rules[$name]['number'] = TRUE;
301
    $js_rules[$name]['messages']['number'] = theme('clientside_error', array('message' => '!name field accepts only numbers (use a \'.\' as decimal point).', 'placeholders' => array('!name' => $title)));
Peter Droogmans's avatar
Peter Droogmans committed
302
303
304
  }
  else {
    $js_rules[$name]['numberDE'] = TRUE;
305
    $js_rules[$name]['messages']['numberDE'] = theme('clientside_error', array('message' => '!name field accepts only numbers (use a \',\' as decimal point).', 'placeholders' => array('!name' => $title)));
Peter Droogmans's avatar
Peter Droogmans committed
306
307
308
  }
}

309
310
311
/**
 * Set validation rule for fields with a minimum and/or a maximum value.
 */
Jelle's avatar
Jelle committed
312
function _clientside_validation_set_minmax($name, $title, $min, $max, &$js_rules, $message = '') {
Jelle Sebreghts's avatar
Jelle Sebreghts committed
313
  $title = variable_get('clientside_validation_prefix', '') . $title . variable_get('clientside_validation_suffix', '');
314
  if (isset($min) && $min !== '' && isset($max) && $max !== '') {
Peter Droogmans's avatar
Peter Droogmans committed
315
    $js_rules[$name]['range'] = array($min, $max);
316
    $js_rules[$name]['messages']['range'] = (empty($message)) ? theme('clientside_error', array('message' => '!name field has to be between !min and !max.', 'placeholders' => array('!name' => $title, '!min' => $min, '!max' => $max))) : theme('clientside_error', array('message' => $message));
Peter Droogmans's avatar
Peter Droogmans committed
317
  }
318
  elseif (isset($min) && $min !== '') {
Peter Droogmans's avatar
Peter Droogmans committed
319
    $js_rules[$name]['min'] = $min;
320
    $js_rules[$name]['messages']['min'] = (empty($message)) ? theme('clientside_error', array('message' => '!name field has to be greater than !min.', 'placeholders' => array('!name' => $title, '!min' => $min))) : theme('clientside_error', array('message' => $message));
Peter Droogmans's avatar
Peter Droogmans committed
321
  }
322
  elseif (isset($max) && $max !== '') {
Peter Droogmans's avatar
Peter Droogmans committed
323
    $js_rules[$name]['max'] = $max;
324
    $js_rules[$name]['messages']['max'] = (empty($message)) ? theme('clientside_error', array('message' => '!name field has to be smaller than !max.', 'placeholders' => array('!name' => $title, '!max' => $max))) : theme('clientside_error', array('message' => $message));
Peter Droogmans's avatar
Peter Droogmans committed
325
326
327
  }
}

328
329
330
/**
 * Set validation rule for fields with a minimum and/or maximum length.
 */
Jelle's avatar
Jelle committed
331
function _clientside_validation_set_minmaxlength($name, $title, $min, $max, &$js_rules, $message = '') {
Jelle Sebreghts's avatar
Jelle Sebreghts committed
332
  $title = variable_get('clientside_validation_prefix', '') . $title . variable_get('clientside_validation_suffix', '');
Jelle Sebreghts's avatar
Jelle Sebreghts committed
333
  if ($max == 1) {
334
335
    $max = '';
  }
336
  if (isset($min) && $min !== '' && isset($max) && $max !== '') {
Peter Droogmans's avatar
Peter Droogmans committed
337
    $js_rules[$name]['rangelength'] = array($min, $max);
338
    $js_rules[$name]['messages']['rangelength'] = (empty($message)) ? theme('clientside_error', array('message' => '!name field has to have between !min and !max values.', 'placeholders' => array('!name' => $title, '!min' => $min, '!max' => $max))) : theme('clientside_error', array('message' => $message));
Peter Droogmans's avatar
Peter Droogmans committed
339
  }
340
  elseif (isset($min) && $min !== '') {
Peter Droogmans's avatar
Peter Droogmans committed
341
    $js_rules[$name]['minlength'] = $min;
342
    $js_rules[$name]['messages']['minlength'] = (empty($message)) ? theme('clientside_error', array('message' => '!name field has to have minimal !min values.', 'placeholders' => array('!name' => $title, '!min' => $min))) : theme('clientside_error', array('message' => $message));
Peter Droogmans's avatar
Peter Droogmans committed
343
  }
344
  elseif (isset($max) && $max !== '') {
Peter Droogmans's avatar
Peter Droogmans committed
345
    $js_rules[$name]['maxlength'] = $max;
346
    $js_rules[$name]['messages']['maxlength'] = (empty($message)) ? theme('clientside_error', array('message' => '!name field has to have maximum !max values.', array('!name' => $title, '!max' => $max))) : theme('clientside_error', array('message' => $message));
Peter Droogmans's avatar
Peter Droogmans committed
347
348
349
  }
}

350
351
352
/**
 * Set validation rule for required fields that must equal a value from an other field.
 */
Jelle's avatar
Jelle committed
353
function _clientside_validation_set_equal($name, $title, $value, &$js_rules) {
Jelle Sebreghts's avatar
Jelle Sebreghts committed
354
  $title = variable_get('clientside_validation_prefix', '') . $title . variable_get('clientside_validation_suffix', '');
355
  $js_rules[$name]['equalTo'] = ':input[name=\'submitted[' . $value['form_key'] . ']\']';
356
  $js_rules[$name]['messages']['equalTo'] = theme('clientside_error', array('message' => '!name field has to be equal to !firstone.', 'placeholders' => array('!name' => $title, '!firstone' => $value['name'])));
357
358
359
360
361
}

/**
 * Set validation rule for fields that can not be equal to a value from an other field.
 */
Jelle's avatar
Jelle committed
362
function _clientside_validation_set_not_equal($name, $title, $value, &$js_rules, $message = '') {
363
  $js_rules[$name]['notEqualTo'] = ':input[name=\'submitted[' . $value['form_key'] . ']\']';
Jelle Sebreghts's avatar
Jelle Sebreghts committed
364
  $title = variable_get('clientside_validation_prefix', '') . $title . variable_get('clientside_validation_suffix', '');
365
  $message = empty($message) ? theme('clientside_error', array('message' => '!name field has to different from !firstone.', 'placeholders' => array('!name' => $title, '!firstone' => $value['name']))) : theme('clientside_error', array('message' => $message));
366
367
368
369
370
371
  $js_rules[$name]['messages']['notEqualTo'] = $message;
}

/**
 * Set validation rule for fields that must be equal to a specific value.
 */
Jelle's avatar
Jelle committed
372
function _clientside_validation_set_specific_value($name, $title, $value, &$js_rules, $message = '') {
373
  $js_rules[$name]['oneOf'] = $value;
Jelle Sebreghts's avatar
Jelle Sebreghts committed
374
  $title = variable_get('clientside_validation_prefix', '') . $title . variable_get('clientside_validation_suffix', '');
375
  $message = empty($message) ? theme('clientside_error', array('message' => '!name field has to different from !firstone.', 'placeholders' => array('!name' => $title, '!firstone' => $value['name']))) : theme('clientside_error', array('message' => $message));
376
377
378
  $js_rules[$name]['messages']['oneOf'] = $message;
}

379
380
381
382
383
384
/**
 * 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;
  $title = variable_get('clientside_validation_prefix', '') . $title . variable_get('clientside_validation_suffix', '');
385
  $message = empty($message) ? theme('clientside_error', array('message' => '!name field must consist of following elements only: !elements.', 'placeholders' => array('!name' => $title, '!elements' => implode(', ', $values)))) : theme('clientside_error', array('message' => $message));
386
387
388
  $js_rules[$name]['messages']['specificVals'] = $message;
}

389
390
391
/**
 * Set validation rule for ean number fields.
 */
Jelle's avatar
Jelle committed
392
function _clientside_validation_set_ean($name, $title, &$js_rules, $message = '') {
Jelle Sebreghts's avatar
Jelle Sebreghts committed
393
  $title = variable_get('clientside_validation_prefix', '') . $title . variable_get('clientside_validation_suffix', '');
394
  $message = empty($message) ? theme('clientside_error', array('message' => '!name field is not a valid EAN number.', 'placeholders' => array('!name' => $title))) : theme('clientside_error', array('message' => $message));
395
  $js_rules[$name]['validEAN'] = TRUE;
Peter Droogmans's avatar
Peter Droogmans committed
396
  $js_rules[$name]['messages']['validEAN'] = $message;
Peter Droogmans's avatar
Peter Droogmans committed
397
398
}

399
400
401
/**
 * Set validation rule for fields with regex validation from webform_validation
 */
402
function _clientside_validation_set_regex($name, $title, &$js_rules, $expression, $message = '', $modifiers = "") {
403
  $title = variable_get('clientside_validation_prefix', '') . $title . variable_get('clientside_validation_suffix', '');
404
  $message = empty($message) ? theme('clientside_error', array('message' => '!name field is not match the given format.', 'placeholders' => array('!name' => $title))) : theme('clientside_error', array('message' => $message));
405
  $js_rules[$name]['regexMatch'] = array($expression);
Jelle Sebreghts's avatar
Jelle Sebreghts committed
406
  if (!empty($modifiers)) {
407
408
    $js_rules[$name]['regexMatch'][] = $modifiers;
  }
409
410
411
  $js_rules[$name]['messages']['regexMatch'] = $message;
}

Jelle Sebreghts's avatar
Jelle Sebreghts committed
412
413
414
415
416
/**
 * Set validation rule for fields with regex validation from webform_validation
 */
function _clientside_validation_set_regex_pcre($name, $title, &$js_rules, $expression, $message = '') {
  $title = variable_get('clientside_validation_prefix', '') . $title . variable_get('clientside_validation_suffix', '');
417
  $message = empty($message) ? theme('clientside_error', array('message' => '!name field is not a valid EAN number.', 'placeholders' => array('!name' => $title))) : theme('clientside_error', array('message' => $message));
Jelle Sebreghts's avatar
Jelle Sebreghts committed
418
419
420
421
  $js_rules[$name]['regexMatchPCRE']['expressions'][] = $expression;
    $js_rules[$name]['regexMatchPCRE']['messages'][] = $message;
}

422
423
424
/**
 * Set validation rule for file fields that must have a certain extension.
 */
Jelle's avatar
Jelle committed
425
function _clientside_validation_set_extensions($name, $extensions, &$js_rules) {
426
427
  $extension_list = preg_replace('#,(?![^,]+,)#', ' or', implode(', ', $extensions));
  $js_rules[$name]['accept'] = implode('|', $extensions);
428
  $js_rules[$name]['messages']['accept'] = theme('clientside_error', array('message' => "Only files with a %exts extension are allowed.", 'placeholders' => array('%exts' => $extension_list)));
429
430
431
432
433
}

/**
 * Set validation rule for checkboxes.
 */
434
function _clientside_validation_set_checkboxgroup_minmax($name, $title, $id, &$js_rules, $message = '', $min = 1, $max = 99) {
Jelle Sebreghts's avatar
Jelle Sebreghts committed
435
  $title = variable_get('clientside_validation_prefix', '') . $title . variable_get('clientside_validation_suffix', '');
436
  $message = empty($message) ? theme('clientside_error', array('message' => '!name field is required.', 'placeholders' => array('!name' => $title))) : theme('clientside_error', array('message' => $message));
437
  $js_rules[$name]['checkboxgroupminmax'] = array($min, $max, $id);
438
  $js_rules[$name]['messages']['checkboxgroupminmax'] = $message;
439
440
441
442
443
}

/**
 * Set validation rule for email fields.
 */
Jelle's avatar
Jelle committed
444
function _clientside_validation_set_email($name, $title, &$js_rules) {
Jelle Sebreghts's avatar
Jelle Sebreghts committed
445
  $title = variable_get('clientside_validation_prefix', '') . $title . variable_get('clientside_validation_suffix', '');
446
  $js_rules[$name]['email'] = TRUE;
447
  $js_rules[$name]['messages']['email'] = theme('clientside_error', array('message' => 'The value in !name is not a valid email address.', 'placeholders' => array('!name' => $title)));
448
449
}

450
451
452
/**
 * Set validation rule for url fields.
 */
Jelle Sebreghts's avatar
Jelle Sebreghts committed
453
function _clientside_validation_set_url($name, $title, &$js_rules) {
454
455
  $title = variable_get('clientside_validation_prefix', '') . $title . variable_get('clientside_validation_suffix', '');
  $js_rules[$name]['url'] = TRUE;
456
  $js_rules[$name]['messages']['url'] = theme('clientside_error', array('message' => 'The value in !name is not a valid url.', 'placeholders' => array('!name' => $title)));
457
458
}

459
460
function clientside_validation_drupal_json_encode($var) {
  return str_replace(array('<', '>', '&'), array('\u003c', '\u003e', '\u0026'), json_encode($var));
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

/**
 * Implements hook_theme().
 */
function clientside_validation_theme($existing, $type, $theme, $path) {
   return array(
    'clientside_error' => array(
      'variables' => array(
        'message' => '',
        'placeholders' => array(),
      )
    )
  );
}

/**
 * Theme callback function.
 * @param string $message
 * A string containing the error message
 * @param array $placeholders
 * An associative array of replacements to make after translation.
 * Incidences of any key in this array are replaced with the corresponding value.
 * Based on the first character of the key, the value is escaped and/or themed:
 *  !variable: inserted as is
 *  @variable: escape plain text to HTML (check_plain)
 *  %variable: escape text and theme as a placeholder for user-submitted content (check_plain + theme_placeholder)
 *
 * @return string
 */
function theme_clientside_error($variables) {
  return t($variables['message'], $variables['placeholders']);
}