Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
7e9e8871 | 4 | | CiviCRM version 4.7 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
e7112fa7 | 6 | | Copyright CiviCRM LLC (c) 2004-2015 | |
6a488035 TO |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
10 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
11 | | under the terms of the GNU Affero General Public License | | |
12 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
13 | | | | |
14 | | CiviCRM is distributed in the hope that it will be useful, but | | |
15 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
16 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
17 | | See the GNU Affero General Public License for more details. | | |
18 | | | | |
19 | | You should have received a copy of the GNU Affero General Public | | |
20 | | License and the CiviCRM Licensing Exception along | | |
21 | | with this program; if not, contact CiviCRM LLC | | |
22 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
23 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
24 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
25 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * | |
30 | * @package CRM | |
e7112fa7 | 31 | * @copyright CiviCRM LLC (c) 2004-2015 |
6a488035 TO |
32 | */ |
33 | ||
34 | require_once 'HTML/QuickForm/Rule/Email.php'; | |
f942c321 | 35 | |
5bc392e6 EM |
36 | /** |
37 | * Class CRM_Utils_Rule | |
38 | */ | |
6a488035 TO |
39 | class CRM_Utils_Rule { |
40 | ||
5bc392e6 EM |
41 | /** |
42 | * @param $str | |
43 | * @param int $maxLength | |
44 | * | |
45 | * @return bool | |
46 | */ | |
00be9182 | 47 | public static function title($str, $maxLength = 127) { |
6a488035 TO |
48 | |
49 | // check length etc | |
50 | if (empty($str) || strlen($str) > $maxLength) { | |
51 | return FALSE; | |
52 | } | |
53 | ||
54 | // Make sure it include valid characters, alpha numeric and underscores | |
55 | if (!preg_match('/^\w[\w\s\'\&\,\$\#\-\.\"\?\!]+$/i', $str)) { | |
56 | return FALSE; | |
57 | } | |
58 | ||
59 | return TRUE; | |
60 | } | |
61 | ||
5bc392e6 EM |
62 | /** |
63 | * @param $str | |
64 | * | |
65 | * @return bool | |
66 | */ | |
00be9182 | 67 | public static function longTitle($str) { |
6a488035 TO |
68 | return self::title($str, 255); |
69 | } | |
70 | ||
5bc392e6 EM |
71 | /** |
72 | * @param $str | |
73 | * | |
74 | * @return bool | |
75 | */ | |
00be9182 | 76 | public static function variable($str) { |
6a488035 TO |
77 | // check length etc |
78 | if (empty($str) || strlen($str) > 31) { | |
79 | return FALSE; | |
80 | } | |
81 | ||
50bfb460 | 82 | // make sure it includes valid characters, alpha numeric and underscores |
6a488035 TO |
83 | if (!preg_match('/^[\w]+$/i', $str)) { |
84 | return FALSE; | |
85 | } | |
86 | ||
87 | return TRUE; | |
88 | } | |
89 | ||
5bc392e6 EM |
90 | /** |
91 | * @param $str | |
92 | * | |
93 | * @return bool | |
94 | */ | |
00be9182 | 95 | public static function qfVariable($str) { |
6a488035 TO |
96 | // check length etc |
97 | //if ( empty( $str ) || strlen( $str ) > 31 ) { | |
98 | if (strlen(trim($str)) == 0 || strlen($str) > 31) { | |
99 | return FALSE; | |
100 | } | |
101 | ||
50bfb460 | 102 | // make sure it includes valid characters, alpha numeric and underscores |
6a488035 TO |
103 | // added (. and ,) option (CRM-1336) |
104 | if (!preg_match('/^[\w\s\.\,]+$/i', $str)) { | |
105 | return FALSE; | |
106 | } | |
107 | ||
108 | return TRUE; | |
109 | } | |
110 | ||
5bc392e6 EM |
111 | /** |
112 | * @param $phone | |
113 | * | |
114 | * @return bool | |
115 | */ | |
00be9182 | 116 | public static function phone($phone) { |
6a488035 TO |
117 | // check length etc |
118 | if (empty($phone) || strlen($phone) > 16) { | |
119 | return FALSE; | |
120 | } | |
121 | ||
50bfb460 | 122 | // make sure it includes valid characters, (, \s and numeric |
6a488035 TO |
123 | if (preg_match('/^[\d\(\)\-\.\s]+$/', $phone)) { |
124 | return TRUE; | |
125 | } | |
126 | return FALSE; | |
127 | } | |
128 | ||
5bc392e6 EM |
129 | /** |
130 | * @param $query | |
131 | * | |
132 | * @return bool | |
133 | */ | |
00be9182 | 134 | public static function query($query) { |
6a488035 TO |
135 | // check length etc |
136 | if (empty($query) || strlen($query) < 3 || strlen($query) > 127) { | |
137 | return FALSE; | |
138 | } | |
139 | ||
50bfb460 | 140 | // make sure it includes valid characters, alpha numeric and underscores |
6a488035 TO |
141 | if (!preg_match('/^[\w\s\%\'\&\,\$\#]+$/i', $query)) { |
142 | return FALSE; | |
143 | } | |
144 | ||
145 | return TRUE; | |
146 | } | |
147 | ||
5bc392e6 EM |
148 | /** |
149 | * @param $url | |
150 | * | |
151 | * @return bool | |
152 | */ | |
00be9182 | 153 | public static function url($url) { |
1136a401 | 154 | if (preg_match('/^\//', $url)) { |
155 | // allow relative URL's (CRM-15598) | |
156 | $url = 'http://' . $_SERVER['HTTP_HOST'] . $url; | |
157 | } | |
6a488035 TO |
158 | return (bool) filter_var($url, FILTER_VALIDATE_URL); |
159 | } | |
160 | ||
d9d7e7dd TO |
161 | /** |
162 | * @param $url | |
163 | * | |
164 | * @return bool | |
165 | */ | |
166 | public static function urlish($url) { | |
167 | if (empty($url)) { | |
168 | return TRUE; | |
169 | } | |
e3d28c74 | 170 | $url = Civi::paths()->getUrl($url, 'absolute'); |
d9d7e7dd TO |
171 | return (bool) filter_var($url, FILTER_VALIDATE_URL); |
172 | } | |
173 | ||
5bc392e6 EM |
174 | /** |
175 | * @param $string | |
176 | * | |
177 | * @return bool | |
178 | */ | |
00be9182 | 179 | public static function wikiURL($string) { |
6a488035 TO |
180 | $items = explode(' ', trim($string), 2); |
181 | return self::url($items[0]); | |
182 | } | |
183 | ||
5bc392e6 EM |
184 | /** |
185 | * @param $domain | |
186 | * | |
187 | * @return bool | |
188 | */ | |
00be9182 | 189 | public static function domain($domain) { |
6a488035 TO |
190 | // not perfect, but better than the previous one; see CRM-1502 |
191 | if (!preg_match('/^[A-Za-z0-9]([A-Za-z0-9\.\-]*[A-Za-z0-9])?$/', $domain)) { | |
192 | return FALSE; | |
193 | } | |
194 | return TRUE; | |
195 | } | |
196 | ||
5bc392e6 EM |
197 | /** |
198 | * @param $value | |
199 | * @param null $default | |
200 | * | |
201 | * @return null | |
202 | */ | |
00be9182 | 203 | public static function date($value, $default = NULL) { |
6a488035 TO |
204 | if (is_string($value) && |
205 | preg_match('/^\d\d\d\d-?\d\d-?\d\d$/', $value) | |
206 | ) { | |
207 | return $value; | |
208 | } | |
209 | return $default; | |
210 | } | |
211 | ||
5bc392e6 EM |
212 | /** |
213 | * @param $value | |
214 | * @param null $default | |
215 | * | |
216 | * @return null|string | |
217 | */ | |
00be9182 | 218 | public static function dateTime($value, $default = NULL) { |
6a488035 TO |
219 | $result = $default; |
220 | if (is_string($value) && | |
221 | preg_match('/^\d\d\d\d-?\d\d-?\d\d(\s\d\d:\d\d(:\d\d)?|\d\d\d\d(\d\d)?)?$/', $value) | |
222 | ) { | |
223 | $result = $value; | |
224 | } | |
225 | ||
226 | return $result; | |
227 | } | |
228 | ||
229 | /** | |
100fef9d | 230 | * Check the validity of the date (in qf format) |
6a488035 TO |
231 | * note that only a year is valid, or a mon-year is |
232 | * also valid in addition to day-mon-year. The date | |
233 | * specified has to be beyond today. (i.e today or later) | |
234 | * | |
235 | * @param array $date | |
77855840 TO |
236 | * @param bool $monthRequired |
237 | * Check whether month is mandatory. | |
6a488035 | 238 | * |
a6c01b45 CW |
239 | * @return bool |
240 | * true if valid date | |
6a488035 | 241 | */ |
00be9182 | 242 | public static function currentDate($date, $monthRequired = TRUE) { |
6a488035 TO |
243 | $config = CRM_Core_Config::singleton(); |
244 | ||
245 | $d = CRM_Utils_Array::value('d', $date); | |
246 | $m = CRM_Utils_Array::value('M', $date); | |
247 | $y = CRM_Utils_Array::value('Y', $date); | |
248 | ||
249 | if (!$d && !$m && !$y) { | |
250 | return TRUE; | |
251 | } | |
252 | ||
253 | // CRM-9017 CiviContribute/CiviMember form with expiration date format 'm Y' | |
8cc574cf | 254 | if (!$m && !empty($date['m'])) { |
6a488035 TO |
255 | $m = CRM_Utils_Array::value('m', $date); |
256 | } | |
257 | ||
258 | $day = $mon = 1; | |
259 | $year = 0; | |
260 | if ($d) { | |
261 | $day = $d; | |
262 | } | |
263 | if ($m) { | |
264 | $mon = $m; | |
265 | } | |
266 | if ($y) { | |
267 | $year = $y; | |
268 | } | |
269 | ||
270 | // if we have day we need mon, and if we have mon we need year | |
271 | if (($d && !$m) || | |
272 | ($d && !$y) || | |
273 | ($m && !$y) | |
274 | ) { | |
275 | return FALSE; | |
276 | } | |
277 | ||
278 | $result = FALSE; | |
279 | if (!empty($day) || !empty($mon) || !empty($year)) { | |
280 | $result = checkdate($mon, $day, $year); | |
281 | } | |
282 | ||
283 | if (!$result) { | |
284 | return FALSE; | |
285 | } | |
286 | ||
287 | // ensure we have month if required | |
288 | if ($monthRequired && !$m) { | |
289 | return FALSE; | |
290 | } | |
291 | ||
292 | // now make sure this date is greater that today | |
293 | $currentDate = getdate(); | |
294 | if ($year > $currentDate['year']) { | |
295 | return TRUE; | |
296 | } | |
297 | elseif ($year < $currentDate['year']) { | |
298 | return FALSE; | |
299 | } | |
300 | ||
301 | if ($m) { | |
302 | if ($mon > $currentDate['mon']) { | |
303 | return TRUE; | |
304 | } | |
305 | elseif ($mon < $currentDate['mon']) { | |
306 | return FALSE; | |
307 | } | |
308 | } | |
309 | ||
310 | if ($d) { | |
311 | if ($day > $currentDate['mday']) { | |
312 | return TRUE; | |
313 | } | |
314 | elseif ($day < $currentDate['mday']) { | |
315 | return FALSE; | |
316 | } | |
317 | } | |
318 | ||
319 | return TRUE; | |
320 | } | |
321 | ||
322 | /** | |
100fef9d | 323 | * Check the validity of a date or datetime (timestamp) |
6a488035 TO |
324 | * value which is in YYYYMMDD or YYYYMMDDHHMMSS format |
325 | * | |
326 | * Uses PHP checkdate() - params are ( int $month, int $day, int $year ) | |
327 | * | |
328 | * @param string $date | |
329 | * | |
a6c01b45 CW |
330 | * @return bool |
331 | * true if valid date | |
6a488035 | 332 | */ |
00be9182 | 333 | public static function mysqlDate($date) { |
6a488035 TO |
334 | // allow date to be null |
335 | if ($date == NULL) { | |
336 | return TRUE; | |
337 | } | |
338 | ||
339 | if (checkdate(substr($date, 4, 2), substr($date, 6, 2), substr($date, 0, 4))) { | |
340 | return TRUE; | |
341 | } | |
342 | ||
343 | return FALSE; | |
344 | } | |
345 | ||
5bc392e6 EM |
346 | /** |
347 | * @param $value | |
348 | * | |
349 | * @return bool | |
350 | */ | |
00be9182 | 351 | public static function integer($value) { |
6a488035 TO |
352 | if (is_int($value)) { |
353 | return TRUE; | |
354 | } | |
355 | ||
f942c321 DL |
356 | // CRM-13460 |
357 | // ensure number passed is always a string numeral | |
358 | if (!is_numeric($value)) { | |
359 | return FALSE; | |
360 | } | |
361 | ||
362 | // note that is_int matches only integer type | |
363 | // and not strings which are only integers | |
364 | // hence we do this here | |
365 | if (preg_match('/^\d+$/', $value)) { | |
366 | return TRUE; | |
367 | } | |
368 | ||
369 | if ($value < 0) { | |
6a488035 TO |
370 | $negValue = -1 * $value; |
371 | if (is_int($negValue)) { | |
372 | return TRUE; | |
373 | } | |
374 | } | |
375 | ||
6a488035 TO |
376 | return FALSE; |
377 | } | |
378 | ||
5bc392e6 EM |
379 | /** |
380 | * @param $value | |
381 | * | |
382 | * @return bool | |
383 | */ | |
00be9182 | 384 | public static function positiveInteger($value) { |
6a488035 TO |
385 | if (is_int($value)) { |
386 | return ($value < 0) ? FALSE : TRUE; | |
387 | } | |
388 | ||
f942c321 DL |
389 | // CRM-13460 |
390 | // ensure number passed is always a string numeral | |
391 | if (!is_numeric($value)) { | |
392 | return FALSE; | |
393 | } | |
394 | ||
395 | if (preg_match('/^\d+$/', $value)) { | |
6a488035 TO |
396 | return TRUE; |
397 | } | |
398 | ||
399 | return FALSE; | |
400 | } | |
401 | ||
5bc392e6 EM |
402 | /** |
403 | * @param $value | |
404 | * | |
405 | * @return bool | |
406 | */ | |
00be9182 | 407 | public static function numeric($value) { |
f942c321 DL |
408 | // lets use a php gatekeeper to ensure this is numeric |
409 | if (!is_numeric($value)) { | |
410 | return FALSE; | |
411 | } | |
412 | ||
6a488035 TO |
413 | return preg_match('/(^-?\d\d*\.\d*$)|(^-?\d\d*$)|(^-?\.\d\d*$)/', $value) ? TRUE : FALSE; |
414 | } | |
415 | ||
5bc392e6 EM |
416 | /** |
417 | * @param $value | |
418 | * @param $noOfDigit | |
419 | * | |
420 | * @return bool | |
421 | */ | |
00be9182 | 422 | public static function numberOfDigit($value, $noOfDigit) { |
6a488035 TO |
423 | return preg_match('/^\d{' . $noOfDigit . '}$/', $value) ? TRUE : FALSE; |
424 | } | |
425 | ||
5bc392e6 EM |
426 | /** |
427 | * @param $value | |
428 | * | |
429 | * @return mixed | |
430 | */ | |
00be9182 | 431 | public static function cleanMoney($value) { |
6a488035 TO |
432 | // first remove all white space |
433 | $value = str_replace(array(' ', "\t", "\n"), '', $value); | |
434 | ||
435 | $config = CRM_Core_Config::singleton(); | |
436 | ||
e7292422 | 437 | //CRM-14868 |
ef88f444 | 438 | $currencySymbols = CRM_Core_PseudoConstant::get( |
353ffa53 TO |
439 | 'CRM_Contribute_DAO_Contribution', |
440 | 'currency', array( | |
441 | 'keyColumn' => 'name', | |
442 | 'labelColumn' => 'symbol', | |
e70a7fc0 TO |
443 | ) |
444 | ); | |
e7292422 | 445 | $value = str_replace($currencySymbols, '', $value); |
ef88f444 | 446 | |
6a488035 TO |
447 | if ($config->monetaryThousandSeparator) { |
448 | $mon_thousands_sep = $config->monetaryThousandSeparator; | |
449 | } | |
450 | else { | |
451 | $mon_thousands_sep = ','; | |
452 | } | |
453 | ||
454 | // ugly fix for CRM-6391: do not drop the thousand separator if | |
455 | // it looks like it’s separating decimal part (because a given | |
456 | // value undergoes a second cleanMoney() call, for example) | |
b81f42da | 457 | // CRM-15835 - in case the amount/value contains 0 after decimal |
458 | // eg 150.5 the following if condition will pass | |
459 | if ($mon_thousands_sep != '.' or (substr($value, -3, 1) != '.' && substr($value, -2, 1) != '.')) { | |
6a488035 TO |
460 | $value = str_replace($mon_thousands_sep, '', $value); |
461 | } | |
462 | ||
463 | if ($config->monetaryDecimalPoint) { | |
464 | $mon_decimal_point = $config->monetaryDecimalPoint; | |
465 | } | |
466 | else { | |
467 | $mon_decimal_point = '.'; | |
468 | } | |
469 | $value = str_replace($mon_decimal_point, '.', $value); | |
470 | ||
471 | return $value; | |
472 | } | |
473 | ||
5bc392e6 EM |
474 | /** |
475 | * @param $value | |
476 | * | |
477 | * @return bool | |
478 | */ | |
00be9182 | 479 | public static function money($value) { |
6a488035 TO |
480 | $config = CRM_Core_Config::singleton(); |
481 | ||
50bfb460 SB |
482 | // only edge case when we have a decimal point in the input money |
483 | // field and not defined in the decimal Point in config settings | |
6a488035 TO |
484 | if ($config->monetaryDecimalPoint && |
485 | $config->monetaryDecimalPoint != '.' && | |
50bfb460 | 486 | // CRM-7122 also check for Thousands Separator in config settings |
6a488035 TO |
487 | $config->monetaryThousandSeparator != '.' && |
488 | substr_count($value, '.') | |
489 | ) { | |
490 | return FALSE; | |
491 | } | |
492 | ||
493 | $value = self::cleanMoney($value); | |
494 | ||
495 | if (self::integer($value)) { | |
496 | return TRUE; | |
497 | } | |
498 | ||
499 | return preg_match('/(^-?\d+\.\d?\d?$)|(^-?\.\d\d?$)/', $value) ? TRUE : FALSE; | |
500 | } | |
501 | ||
5bc392e6 EM |
502 | /** |
503 | * @param $value | |
504 | * @param int $maxLength | |
505 | * | |
506 | * @return bool | |
507 | */ | |
00be9182 | 508 | public static function string($value, $maxLength = 0) { |
6a488035 TO |
509 | if (is_string($value) && |
510 | ($maxLength === 0 || strlen($value) <= $maxLength) | |
511 | ) { | |
512 | return TRUE; | |
513 | } | |
514 | return FALSE; | |
515 | } | |
516 | ||
5bc392e6 EM |
517 | /** |
518 | * @param $value | |
519 | * | |
520 | * @return bool | |
521 | */ | |
00be9182 | 522 | public static function boolean($value) { |
6a488035 TO |
523 | return preg_match( |
524 | '/(^(1|0)$)|(^(Y(es)?|N(o)?)$)|(^(T(rue)?|F(alse)?)$)/i', $value | |
525 | ) ? TRUE : FALSE; | |
526 | } | |
527 | ||
5bc392e6 EM |
528 | /** |
529 | * @param $value | |
530 | * | |
531 | * @return bool | |
532 | */ | |
00be9182 | 533 | public static function email($value) { |
6a488035 TO |
534 | return (bool) filter_var($value, FILTER_VALIDATE_EMAIL); |
535 | } | |
536 | ||
5bc392e6 EM |
537 | /** |
538 | * @param $list | |
539 | * | |
540 | * @return bool | |
541 | */ | |
00be9182 | 542 | public static function emailList($list) { |
6a488035 TO |
543 | $emails = explode(',', $list); |
544 | foreach ($emails as $email) { | |
545 | $email = trim($email); | |
546 | if (!self::email($email)) { | |
547 | return FALSE; | |
548 | } | |
549 | } | |
550 | return TRUE; | |
551 | } | |
552 | ||
5bc392e6 | 553 | /** |
4f1f1f2a CW |
554 | * allow between 4-6 digits as postal code since india needs 6 and US needs 5 (or |
555 | * if u disregard the first 0, 4 (thanx excel!) | |
556 | * FIXME: we need to figure out how to localize such rules | |
5bc392e6 EM |
557 | * @param $value |
558 | * | |
559 | * @return bool | |
560 | */ | |
00be9182 | 561 | public static function postalCode($value) { |
6a488035 TO |
562 | if (preg_match('/^\d{4,6}(-\d{4})?$/', $value)) { |
563 | return TRUE; | |
564 | } | |
565 | return FALSE; | |
566 | } | |
567 | ||
568 | /** | |
100fef9d | 569 | * See how file rules are written in HTML/QuickForm/file.php |
6a488035 TO |
570 | * Checks to make sure the uploaded file is ascii |
571 | * | |
a6c01b45 CW |
572 | * @return bool |
573 | * true if file has been uploaded, false otherwise | |
6a488035 | 574 | */ |
00be9182 | 575 | public static function asciiFile($elementValue) { |
6a488035 TO |
576 | if ((isset($elementValue['error']) && $elementValue['error'] == 0) || |
577 | (!empty($elementValue['tmp_name']) && $elementValue['tmp_name'] != 'none') | |
578 | ) { | |
579 | return CRM_Utils_File::isAscii($elementValue['tmp_name']); | |
580 | } | |
581 | return FALSE; | |
582 | } | |
583 | ||
584 | /** | |
585 | * Checks to make sure the uploaded file is in UTF-8, recodes if it's not | |
586 | * | |
a6c01b45 CW |
587 | * @return bool |
588 | * whether file has been uploaded properly and is now in UTF-8 | |
6a488035 | 589 | */ |
00be9182 | 590 | public static function utf8File($elementValue) { |
6a488035 TO |
591 | $success = FALSE; |
592 | ||
593 | if ((isset($elementValue['error']) && $elementValue['error'] == 0) || | |
594 | (!empty($elementValue['tmp_name']) && $elementValue['tmp_name'] != 'none') | |
595 | ) { | |
596 | ||
597 | $success = CRM_Utils_File::isAscii($elementValue['tmp_name']); | |
598 | ||
599 | // if it's a file, but not UTF-8, let's try and recode it | |
600 | // and then make sure it's an UTF-8 file in the end | |
601 | if (!$success) { | |
602 | $success = CRM_Utils_File::toUtf8($elementValue['tmp_name']); | |
603 | if ($success) { | |
604 | $success = CRM_Utils_File::isAscii($elementValue['tmp_name']); | |
605 | } | |
606 | } | |
607 | } | |
608 | return $success; | |
609 | } | |
610 | ||
611 | /** | |
100fef9d | 612 | * See how file rules are written in HTML/QuickForm/file.php |
6a488035 TO |
613 | * Checks to make sure the uploaded file is html |
614 | * | |
a6c01b45 CW |
615 | * @return bool |
616 | * true if file has been uploaded, false otherwise | |
6a488035 | 617 | */ |
00be9182 | 618 | public static function htmlFile($elementValue) { |
6a488035 TO |
619 | if ((isset($elementValue['error']) && $elementValue['error'] == 0) || |
620 | (!empty($elementValue['tmp_name']) && $elementValue['tmp_name'] != 'none') | |
621 | ) { | |
622 | return CRM_Utils_File::isHtmlFile($elementValue['tmp_name']); | |
623 | } | |
624 | return FALSE; | |
625 | } | |
626 | ||
627 | /** | |
fe482240 | 628 | * Check if there is a record with the same name in the db. |
6a488035 | 629 | * |
77855840 TO |
630 | * @param string $value |
631 | * The value of the field we are checking. | |
632 | * @param array $options | |
633 | * The daoName and fieldName (optional ). | |
6a488035 | 634 | * |
408b79bf | 635 | * @return bool |
a6c01b45 | 636 | * true if object exists |
6a488035 | 637 | */ |
00be9182 | 638 | public static function objectExists($value, $options) { |
6a488035 TO |
639 | $name = 'name'; |
640 | if (isset($options[2])) { | |
641 | $name = $options[2]; | |
642 | } | |
643 | ||
644 | return CRM_Core_DAO::objectExists($value, CRM_Utils_Array::value(0, $options), CRM_Utils_Array::value(1, $options), CRM_Utils_Array::value(2, $options, $name)); | |
645 | } | |
646 | ||
5bc392e6 EM |
647 | /** |
648 | * @param $value | |
649 | * @param $options | |
650 | * | |
651 | * @return bool | |
652 | */ | |
00be9182 | 653 | public static function optionExists($value, $options) { |
6a488035 TO |
654 | return CRM_Core_OptionValue::optionExists($value, $options[0], $options[1], $options[2], CRM_Utils_Array::value(3, $options, 'name')); |
655 | } | |
656 | ||
5bc392e6 EM |
657 | /** |
658 | * @param $value | |
659 | * @param $type | |
660 | * | |
661 | * @return bool | |
662 | */ | |
00be9182 | 663 | public static function creditCardNumber($value, $type) { |
6a488035 TO |
664 | require_once 'Validate/Finance/CreditCard.php'; |
665 | return Validate_Finance_CreditCard::number($value, $type); | |
666 | } | |
667 | ||
5bc392e6 EM |
668 | /** |
669 | * @param $value | |
670 | * @param $type | |
671 | * | |
672 | * @return bool | |
673 | */ | |
00be9182 | 674 | public static function cvv($value, $type) { |
6a488035 TO |
675 | require_once 'Validate/Finance/CreditCard.php'; |
676 | ||
677 | return Validate_Finance_CreditCard::cvv($value, $type); | |
678 | } | |
679 | ||
5bc392e6 EM |
680 | /** |
681 | * @param $value | |
682 | * | |
683 | * @return bool | |
684 | */ | |
00be9182 | 685 | public static function currencyCode($value) { |
6a488035 TO |
686 | static $currencyCodes = NULL; |
687 | if (!$currencyCodes) { | |
688 | $currencyCodes = CRM_Core_PseudoConstant::currencyCode(); | |
689 | } | |
690 | if (in_array($value, $currencyCodes)) { | |
691 | return TRUE; | |
692 | } | |
693 | return FALSE; | |
694 | } | |
695 | ||
5bc392e6 EM |
696 | /** |
697 | * @param $value | |
698 | * | |
699 | * @return bool | |
700 | */ | |
00be9182 | 701 | public static function xssString($value) { |
6a488035 TO |
702 | if (is_string($value)) { |
703 | return preg_match('!<(vb)?script[^>]*>.*</(vb)?script.*>!ims', | |
704 | $value | |
705 | ) ? FALSE : TRUE; | |
706 | } | |
707 | else { | |
708 | return TRUE; | |
709 | } | |
710 | } | |
711 | ||
5bc392e6 EM |
712 | /** |
713 | * @param $path | |
714 | * | |
715 | * @return bool | |
716 | */ | |
00be9182 | 717 | public static function fileExists($path) { |
6a488035 TO |
718 | return file_exists($path); |
719 | } | |
720 | ||
d9d7e7dd TO |
721 | /** |
722 | * Determine whether the value contains a valid reference to a directory. | |
723 | * | |
724 | * Paths stored in the setting system may be absolute -- or may be | |
725 | * relative to the default data directory. | |
726 | * | |
727 | * @param string $path | |
728 | * @return bool | |
729 | */ | |
730 | public static function settingPath($path) { | |
e3d28c74 | 731 | return is_dir(Civi::paths()->getPath($path)); |
d9d7e7dd TO |
732 | } |
733 | ||
5bc392e6 EM |
734 | /** |
735 | * @param $value | |
736 | * @param $options | |
737 | * | |
738 | * @return bool | |
739 | */ | |
00be9182 | 740 | public static function autocomplete($value, $options) { |
6a488035 TO |
741 | if ($value) { |
742 | $selectOption = CRM_Core_BAO_CustomOption::valuesByID($options['fieldID'], $options['optionGroupID']); | |
743 | ||
744 | if (!in_array($value, $selectOption)) { | |
745 | return FALSE; | |
746 | } | |
747 | } | |
748 | return TRUE; | |
749 | } | |
750 | ||
5bc392e6 EM |
751 | /** |
752 | * @param $value | |
753 | * @param null $actualElementValue | |
754 | * | |
755 | * @return bool | |
756 | */ | |
00be9182 | 757 | public static function validContact($value, $actualElementValue = NULL) { |
6a488035 TO |
758 | if ($actualElementValue) { |
759 | $value = $actualElementValue; | |
760 | } | |
761 | ||
258570f7 | 762 | return CRM_Utils_Rule::positiveInteger($value); |
6a488035 TO |
763 | } |
764 | ||
765 | /** | |
100fef9d | 766 | * Check the validity of the date (in qf format) |
6a488035 TO |
767 | * note that only a year is valid, or a mon-year is |
768 | * also valid in addition to day-mon-year | |
769 | * | |
770 | * @param array $date | |
771 | * | |
a6c01b45 CW |
772 | * @return bool |
773 | * true if valid date | |
6a488035 | 774 | */ |
00be9182 | 775 | public static function qfDate($date) { |
6a488035 TO |
776 | $config = CRM_Core_Config::singleton(); |
777 | ||
778 | $d = CRM_Utils_Array::value('d', $date); | |
779 | $m = CRM_Utils_Array::value('M', $date); | |
780 | $y = CRM_Utils_Array::value('Y', $date); | |
781 | if (isset($date['h']) || | |
782 | isset($date['g']) | |
783 | ) { | |
784 | $m = CRM_Utils_Array::value('M', $date); | |
785 | } | |
786 | ||
787 | if (!$d && !$m && !$y) { | |
788 | return TRUE; | |
789 | } | |
790 | ||
791 | $day = $mon = 1; | |
792 | $year = 0; | |
793 | if ($d) { | |
794 | $day = $d; | |
795 | } | |
796 | if ($m) { | |
797 | $mon = $m; | |
798 | } | |
799 | if ($y) { | |
800 | $year = $y; | |
801 | } | |
802 | ||
803 | // if we have day we need mon, and if we have mon we need year | |
804 | if (($d && !$m) || | |
805 | ($d && !$y) || | |
806 | ($m && !$y) | |
807 | ) { | |
808 | return FALSE; | |
809 | } | |
810 | ||
811 | if (!empty($day) || !empty($mon) || !empty($year)) { | |
812 | return checkdate($mon, $day, $year); | |
813 | } | |
814 | return FALSE; | |
815 | } | |
816 | ||
5bc392e6 EM |
817 | /** |
818 | * @param $key | |
819 | * | |
820 | * @return bool | |
821 | */ | |
00be9182 | 822 | public static function qfKey($key) { |
6a488035 TO |
823 | return ($key) ? CRM_Core_Key::valid($key) : FALSE; |
824 | } | |
96025800 | 825 | |
6a488035 | 826 | } |