blob: 1ed50844cf096dd6f8a833316309a4cf1ba25bf4 [file] [log] [blame]
Andrey Andreevc5536aa2012-11-01 17:33:58 +02001<?php
Derek Allard2067d1a2008-11-13 22:59:24 +00002/**
3 * CodeIgniter
4 *
Phil Sturgeon07c1ac82012-03-09 17:03:37 +00005 * An open source application development framework for PHP 5.2.4 or newer
Derek Allard2067d1a2008-11-13 22:59:24 +00006 *
Derek Jonesf4a4bd82011-10-20 12:18:42 -05007 * NOTICE OF LICENSE
Eric Barnescccde962011-12-04 00:01:17 -05008 *
Derek Jonesf4a4bd82011-10-20 12:18:42 -05009 * Licensed under the Open Software License version 3.0
Eric Barnescccde962011-12-04 00:01:17 -050010 *
Derek Jonesf4a4bd82011-10-20 12:18:42 -050011 * This source file is subject to the Open Software License (OSL 3.0) that is
12 * bundled with this package in the files license.txt / license.rst. It is
13 * also available through the world wide web at this URL:
14 * http://opensource.org/licenses/OSL-3.0
15 * If you did not receive a copy of the license and are unable to obtain it
16 * through the world wide web, please send an email to
17 * licensing@ellislab.com so we can send you a copy immediately.
18 *
Derek Allard2067d1a2008-11-13 22:59:24 +000019 * @package CodeIgniter
Derek Jonesf4a4bd82011-10-20 12:18:42 -050020 * @author EllisLab Dev Team
Andrey Andreev80500af2013-01-01 08:16:53 +020021 * @copyright Copyright (c) 2008 - 2013, EllisLab, Inc. (http://ellislab.com/)
Derek Jonesf4a4bd82011-10-20 12:18:42 -050022 * @license http://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
Derek Allard2067d1a2008-11-13 22:59:24 +000023 * @link http://codeigniter.com
24 * @since Version 1.0
25 * @filesource
26 */
Andrey Andreevc5536aa2012-11-01 17:33:58 +020027defined('BASEPATH') OR exit('No direct script access allowed');
Derek Allard2067d1a2008-11-13 22:59:24 +000028
Derek Allard2067d1a2008-11-13 22:59:24 +000029/**
30 * Form Validation Class
31 *
32 * @package CodeIgniter
33 * @subpackage Libraries
34 * @category Validation
Derek Jonesf4a4bd82011-10-20 12:18:42 -050035 * @author EllisLab Dev Team
Derek Allard2067d1a2008-11-13 22:59:24 +000036 * @link http://codeigniter.com/user_guide/libraries/form_validation.html
37 */
38class CI_Form_validation {
Barry Mienydd671972010-10-04 16:33:58 +020039
Timothy Warren0688ac92012-04-20 10:25:04 -040040 /**
41 * Reference to the CodeIgniter instance
42 *
43 * @var object
44 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +010045 protected $CI;
Derek Allard2067d1a2008-11-13 22:59:24 +000046
Timothy Warren0688ac92012-04-20 10:25:04 -040047 /**
48 * Validation data for the current form submission
49 *
50 * @var array
51 */
Andrey Andreev56454792012-05-17 14:32:19 +030052 protected $_field_data = array();
53
Timothy Warren0688ac92012-04-20 10:25:04 -040054 /**
55 * Validation rules for the current form
56 *
57 * @var array
58 */
Andrey Andreev56454792012-05-17 14:32:19 +030059 protected $_config_rules = array();
60
Timothy Warren0688ac92012-04-20 10:25:04 -040061 /**
62 * Array of validation errors
63 *
64 * @var array
65 */
Andrey Andreev78f55772012-04-03 19:59:08 +030066 protected $_error_array = array();
Andrey Andreev56454792012-05-17 14:32:19 +030067
Timothy Warren0688ac92012-04-20 10:25:04 -040068 /**
69 * Array of custom error messages
70 *
71 * @var array
72 */
Andrey Andreev78f55772012-04-03 19:59:08 +030073 protected $_error_messages = array();
Andrey Andreev56454792012-05-17 14:32:19 +030074
Timothy Warren0688ac92012-04-20 10:25:04 -040075 /**
76 * Start tag for error wrapping
77 *
78 * @var string
79 */
Andrey Andreev78f55772012-04-03 19:59:08 +030080 protected $_error_prefix = '<p>';
Andrey Andreev56454792012-05-17 14:32:19 +030081
Timothy Warren0688ac92012-04-20 10:25:04 -040082 /**
83 * End tag for error wrapping
Andrey Andreev56454792012-05-17 14:32:19 +030084 *
Timothy Warren0688ac92012-04-20 10:25:04 -040085 * @var string
86 */
Andrey Andreev78f55772012-04-03 19:59:08 +030087 protected $_error_suffix = '</p>';
Andrey Andreev56454792012-05-17 14:32:19 +030088
Timothy Warren0688ac92012-04-20 10:25:04 -040089 /**
90 * Custom error message
91 *
92 * @var string
93 */
Andrey Andreev78f55772012-04-03 19:59:08 +030094 protected $error_string = '';
Andrey Andreev56454792012-05-17 14:32:19 +030095
Timothy Warren0688ac92012-04-20 10:25:04 -040096 /**
97 * Whether the form data has been validated as safe
98 *
99 * @var bool
100 */
Andrey Andreev78f55772012-04-03 19:59:08 +0300101 protected $_safe_form_data = FALSE;
Andrey Andreev56454792012-05-17 14:32:19 +0300102
Timothy Warren0688ac92012-04-20 10:25:04 -0400103 /**
104 * Custom data to validate
105 *
106 * @var array
107 */
Andrey Andreevcff35802012-11-26 15:49:52 +0200108 public $validation_data = array();
Derek Allard2067d1a2008-11-13 22:59:24 +0000109
Timothy Warren0688ac92012-04-20 10:25:04 -0400110 /**
111 * Initialize Form_Validation class
112 *
Andrey Andreev56454792012-05-17 14:32:19 +0300113 * @param array $rules
114 * @return void
Timothy Warren0688ac92012-04-20 10:25:04 -0400115 */
Greg Akera9263282010-11-10 15:26:43 -0600116 public function __construct($rules = array())
Barry Mienydd671972010-10-04 16:33:58 +0200117 {
Derek Allard2067d1a2008-11-13 22:59:24 +0000118 $this->CI =& get_instance();
Barry Mienydd671972010-10-04 16:33:58 +0200119
Mike Funk326a5e72012-02-24 10:06:28 -0500120 // applies delimiters set in config file.
Mike Funk7f42d062012-03-08 09:00:57 -0500121 if (isset($rules['error_prefix']))
122 {
123 $this->_error_prefix = $rules['error_prefix'];
124 unset($rules['error_prefix']);
125 }
126 if (isset($rules['error_suffix']))
127 {
128 $this->_error_suffix = $rules['error_suffix'];
129 unset($rules['error_suffix']);
130 }
Andrey Andreev31cf46e2012-03-20 15:48:00 +0200131
Derek Allard2067d1a2008-11-13 22:59:24 +0000132 // Validation rules can be stored in a config file.
133 $this->_config_rules = $rules;
Barry Mienydd671972010-10-04 16:33:58 +0200134
Derek Allard2067d1a2008-11-13 22:59:24 +0000135 // Automatically load the form helper
136 $this->CI->load->helper('form');
137
Andrey Andreev901573c2012-01-11 01:40:48 +0200138 log_message('debug', 'Form Validation Class Initialized');
Derek Allard2067d1a2008-11-13 22:59:24 +0000139 }
Barry Mienydd671972010-10-04 16:33:58 +0200140
Derek Allard2067d1a2008-11-13 22:59:24 +0000141 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200142
Derek Allard2067d1a2008-11-13 22:59:24 +0000143 /**
144 * Set Rules
145 *
146 * This function takes an array of field names and validation
147 * rules as input, validates the info, and stores it
148 *
Timothy Warren0688ac92012-04-20 10:25:04 -0400149 * @param mixed $field
150 * @param string $label
151 * @param mixed $rules
Andrew Podner4296a652012-12-17 07:51:15 -0500152 * @return CI_Form_validation
Derek Allard2067d1a2008-11-13 22:59:24 +0000153 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +0100154 public function set_rules($field, $label = '', $rules = '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000155 {
156 // No reason to set rules if we have no POST data
JonoB099c4782012-03-04 14:37:30 +0000157 // or a validation array has not been specified
Andrey Andreev3b2c5082012-03-07 22:49:24 +0200158 if ($this->CI->input->method() !== 'post' && empty($this->validation_data))
Derek Allard2067d1a2008-11-13 22:59:24 +0000159 {
Greg Aker9f9af602010-11-10 15:41:51 -0600160 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000161 }
Barry Mienydd671972010-10-04 16:33:58 +0200162
tiyowanc2acb232012-03-14 21:24:00 +0400163 // If an array was passed via the first parameter instead of individual string
Derek Allard2067d1a2008-11-13 22:59:24 +0000164 // values we cycle through it and recursively call this function.
165 if (is_array($field))
166 {
167 foreach ($field as $row)
168 {
169 // Houston, we have a problem...
Andrey Andreev78f55772012-04-03 19:59:08 +0300170 if ( ! isset($row['field'], $row['rules']))
Derek Allard2067d1a2008-11-13 22:59:24 +0000171 {
172 continue;
173 }
174
175 // If the field label wasn't passed we use the field name
Andrey Andreev78f55772012-04-03 19:59:08 +0300176 $label = isset($row['label']) ? $row['label'] : $row['field'];
Derek Allard2067d1a2008-11-13 22:59:24 +0000177
178 // Here we go!
179 $this->set_rules($row['field'], $label, $row['rules']);
180 }
Andrey Andreev78f55772012-04-03 19:59:08 +0300181
Greg Aker9f9af602010-11-10 15:41:51 -0600182 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000183 }
Barry Mienydd671972010-10-04 16:33:58 +0200184
Kevin Wood-Friend6a56d502012-06-12 09:54:01 -0400185 // Convert an array of rules to a string
186 if (is_array($rules))
187 {
188 $rules = implode('|', $rules);
189 }
190
Derek Allard2067d1a2008-11-13 22:59:24 +0000191 // No fields? Nothing to do...
Alex Bilbied261b1e2012-06-02 11:12:16 +0100192 if ( ! is_string($field) OR ! is_string($rules) OR $field === '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000193 {
Greg Aker9f9af602010-11-10 15:41:51 -0600194 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000195 }
196
197 // If the field label wasn't passed we use the field name
Alex Bilbied261b1e2012-06-02 11:12:16 +0100198 $label = ($label === '') ? $field : $label;
Derek Allard2067d1a2008-11-13 22:59:24 +0000199
Andrey Andreev8dc532d2011-12-24 17:57:54 +0200200 // Is the field name an array? If it is an array, we break it apart
Barry Mienydd671972010-10-04 16:33:58 +0200201 // into its components so that we can fetch the corresponding POST data later
Andrey Andreev7a7ad782012-11-12 17:21:01 +0200202 $indexes = array();
Andrey Andreev8dc532d2011-12-24 17:57:54 +0200203 if (preg_match_all('/\[(.*?)\]/', $field, $matches))
Barry Mienydd671972010-10-04 16:33:58 +0200204 {
Andrey Andreev7a7ad782012-11-12 17:21:01 +0200205 sscanf($field, '%[^[][', $indexes[0]);
Derek Allard2067d1a2008-11-13 22:59:24 +0000206
Andrey Andreev8dc532d2011-12-24 17:57:54 +0200207 for ($i = 0, $c = count($matches[0]); $i < $c; $i++)
Derek Allard2067d1a2008-11-13 22:59:24 +0000208 {
Alex Bilbied261b1e2012-06-02 11:12:16 +0100209 if ($matches[1][$i] !== '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000210 {
Andrey Andreev8dc532d2011-12-24 17:57:54 +0200211 $indexes[] = $matches[1][$i];
Derek Allard2067d1a2008-11-13 22:59:24 +0000212 }
213 }
Barry Mienydd671972010-10-04 16:33:58 +0200214
Derek Allard2067d1a2008-11-13 22:59:24 +0000215 $is_array = TRUE;
216 }
217 else
218 {
Barry Mienydd671972010-10-04 16:33:58 +0200219 $is_array = FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +0000220 }
Barry Mienydd671972010-10-04 16:33:58 +0200221
222 // Build our master array
Derek Allard2067d1a2008-11-13 22:59:24 +0000223 $this->_field_data[$field] = array(
Andrey Andreev56454792012-05-17 14:32:19 +0300224 'field' => $field,
225 'label' => $label,
226 'rules' => $rules,
227 'is_array' => $is_array,
228 'keys' => $indexes,
229 'postdata' => NULL,
230 'error' => ''
Phil Sturgeonef112c02011-02-07 13:01:47 +0000231 );
Greg Aker9f9af602010-11-10 15:41:51 -0600232
233 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000234 }
235
236 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200237
Derek Allard2067d1a2008-11-13 22:59:24 +0000238 /**
JonoB099c4782012-03-04 14:37:30 +0000239 * By default, form validation uses the $_POST array to validate
Andrey Andreevc8da4fe2012-03-04 19:20:33 +0200240 *
JonoB099c4782012-03-04 14:37:30 +0000241 * If an array is set through this method, then this array will
242 * be used instead of the $_POST array
Andrey Andreev3b2c5082012-03-07 22:49:24 +0200243 *
244 * Note that if you are validating multiple arrays, then the
245 * reset_validation() function should be called after validating
JonoB883f80f2012-03-05 09:51:27 +0000246 * each array due to the limitations of CI's singleton
Andrey Andreevc8da4fe2012-03-04 19:20:33 +0200247 *
248 * @param array $data
249 * @return void
JonoB099c4782012-03-04 14:37:30 +0000250 */
251 public function set_data($data = '')
252 {
253 if ( ! empty($data) && is_array($data))
254 {
Andrey Andreevc8da4fe2012-03-04 19:20:33 +0200255 $this->validation_data = $data;
JonoB099c4782012-03-04 14:37:30 +0000256 }
257 }
Andrey Andreevc8da4fe2012-03-04 19:20:33 +0200258
JonoB099c4782012-03-04 14:37:30 +0000259 // --------------------------------------------------------------------
Derek Allard2067d1a2008-11-13 22:59:24 +0000260
261 /**
262 * Set Error Message
263 *
Andrey Andreev78f55772012-04-03 19:59:08 +0300264 * Lets users set their own error messages on the fly. Note:
265 * The key name has to match the function name that it corresponds to.
Derek Allard2067d1a2008-11-13 22:59:24 +0000266 *
Andrey Andreev78f55772012-04-03 19:59:08 +0300267 * @param array
Derek Allard2067d1a2008-11-13 22:59:24 +0000268 * @param string
Andrew Podner4296a652012-12-17 07:51:15 -0500269 * @return CI_Form_validation
Derek Allard2067d1a2008-11-13 22:59:24 +0000270 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +0100271 public function set_message($lang, $val = '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000272 {
273 if ( ! is_array($lang))
274 {
275 $lang = array($lang => $val);
276 }
Barry Mienydd671972010-10-04 16:33:58 +0200277
Derek Allard2067d1a2008-11-13 22:59:24 +0000278 $this->_error_messages = array_merge($this->_error_messages, $lang);
Greg Aker9f9af602010-11-10 15:41:51 -0600279 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000280 }
Barry Mienydd671972010-10-04 16:33:58 +0200281
Derek Allard2067d1a2008-11-13 22:59:24 +0000282 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200283
Derek Allard2067d1a2008-11-13 22:59:24 +0000284 /**
285 * Set The Error Delimiter
286 *
287 * Permits a prefix/suffix to be added to each error message
288 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000289 * @param string
290 * @param string
Andrew Podner4296a652012-12-17 07:51:15 -0500291 * @return CI_Form_validation
Barry Mienydd671972010-10-04 16:33:58 +0200292 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +0100293 public function set_error_delimiters($prefix = '<p>', $suffix = '</p>')
Derek Allard2067d1a2008-11-13 22:59:24 +0000294 {
295 $this->_error_prefix = $prefix;
296 $this->_error_suffix = $suffix;
Greg Aker9f9af602010-11-10 15:41:51 -0600297 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000298 }
299
300 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200301
Derek Allard2067d1a2008-11-13 22:59:24 +0000302 /**
303 * Get Error Message
304 *
305 * Gets the error message associated with a particular field
306 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000307 * @param string the field name
Timothy Warren0688ac92012-04-20 10:25:04 -0400308 * @param string the html start tag
309 * @param strign the html end tag
Andrey Andreev78f55772012-04-03 19:59:08 +0300310 * @return string
Barry Mienydd671972010-10-04 16:33:58 +0200311 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +0100312 public function error($field = '', $prefix = '', $suffix = '')
Barry Mienydd671972010-10-04 16:33:58 +0200313 {
Andrey Andreev78f55772012-04-03 19:59:08 +0300314 if (empty($this->_field_data[$field]['error']))
Derek Allard2067d1a2008-11-13 22:59:24 +0000315 {
316 return '';
317 }
Barry Mienydd671972010-10-04 16:33:58 +0200318
Alex Bilbied261b1e2012-06-02 11:12:16 +0100319 if ($prefix === '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000320 {
321 $prefix = $this->_error_prefix;
322 }
323
Alex Bilbied261b1e2012-06-02 11:12:16 +0100324 if ($suffix === '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000325 {
326 $suffix = $this->_error_suffix;
327 }
328
329 return $prefix.$this->_field_data[$field]['error'].$suffix;
330 }
331
332 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200333
Derek Allard2067d1a2008-11-13 22:59:24 +0000334 /**
Michiel Vugteveen676a0dd2012-03-02 10:10:34 +0100335 * Get Array of Error Messages
336 *
337 * Returns the error messages as an array
338 *
339 * @return array
340 */
341 public function error_array()
342 {
343 return $this->_error_array;
344 }
345
346 // --------------------------------------------------------------------
347
348 /**
Derek Allard2067d1a2008-11-13 22:59:24 +0000349 * Error String
350 *
351 * Returns the error messages as a string, wrapped in the error delimiters
352 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000353 * @param string
354 * @param string
Andrey Andreev78f55772012-04-03 19:59:08 +0300355 * @return string
Barry Mienydd671972010-10-04 16:33:58 +0200356 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +0100357 public function error_string($prefix = '', $suffix = '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000358 {
vlakoff35672462013-02-15 01:36:04 +0100359 // No errors, validation passes!
Derek Allard2067d1a2008-11-13 22:59:24 +0000360 if (count($this->_error_array) === 0)
361 {
362 return '';
363 }
Barry Mienydd671972010-10-04 16:33:58 +0200364
Alex Bilbied261b1e2012-06-02 11:12:16 +0100365 if ($prefix === '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000366 {
367 $prefix = $this->_error_prefix;
368 }
369
Alex Bilbied261b1e2012-06-02 11:12:16 +0100370 if ($suffix === '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000371 {
372 $suffix = $this->_error_suffix;
373 }
Barry Mienydd671972010-10-04 16:33:58 +0200374
Derek Allard2067d1a2008-11-13 22:59:24 +0000375 // Generate the error string
376 $str = '';
377 foreach ($this->_error_array as $val)
378 {
Alex Bilbied261b1e2012-06-02 11:12:16 +0100379 if ($val !== '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000380 {
381 $str .= $prefix.$val.$suffix."\n";
382 }
383 }
Barry Mienydd671972010-10-04 16:33:58 +0200384
Derek Allard2067d1a2008-11-13 22:59:24 +0000385 return $str;
386 }
387
388 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200389
Derek Allard2067d1a2008-11-13 22:59:24 +0000390 /**
391 * Run the Validator
392 *
393 * This function does all the work.
394 *
Timothy Warren0688ac92012-04-20 10:25:04 -0400395 * @param string $group
Derek Allard2067d1a2008-11-13 22:59:24 +0000396 * @return bool
Barry Mienydd671972010-10-04 16:33:58 +0200397 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +0100398 public function run($group = '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000399 {
Derek Jones37f4b9c2011-07-01 17:56:50 -0500400 // Do we even have any data to process? Mm?
Andrey Andreev78f55772012-04-03 19:59:08 +0300401 $validation_array = empty($this->validation_data) ? $_POST : $this->validation_data;
JonoB099c4782012-03-04 14:37:30 +0000402 if (count($validation_array) === 0)
Derek Allard2067d1a2008-11-13 22:59:24 +0000403 {
404 return FALSE;
405 }
Barry Mienydd671972010-10-04 16:33:58 +0200406
Derek Allard2067d1a2008-11-13 22:59:24 +0000407 // Does the _field_data array containing the validation rules exist?
408 // If not, we look to see if they were assigned via a config file
Andrey Andreev8dc532d2011-12-24 17:57:54 +0200409 if (count($this->_field_data) === 0)
Derek Allard2067d1a2008-11-13 22:59:24 +0000410 {
Derek Jones37f4b9c2011-07-01 17:56:50 -0500411 // No validation rules? We're done...
Andrey Andreev8dc532d2011-12-24 17:57:54 +0200412 if (count($this->_config_rules) === 0)
Derek Allard2067d1a2008-11-13 22:59:24 +0000413 {
414 return FALSE;
415 }
Barry Mienydd671972010-10-04 16:33:58 +0200416
Derek Allard2067d1a2008-11-13 22:59:24 +0000417 // Is there a validation rule for the particular URI being accessed?
Alex Bilbied261b1e2012-06-02 11:12:16 +0100418 $uri = ($group === '') ? trim($this->CI->uri->ruri_string(), '/') : $group;
Barry Mienydd671972010-10-04 16:33:58 +0200419
Alex Bilbied261b1e2012-06-02 11:12:16 +0100420 if ($uri !== '' && isset($this->_config_rules[$uri]))
Derek Allard2067d1a2008-11-13 22:59:24 +0000421 {
422 $this->set_rules($this->_config_rules[$uri]);
423 }
424 else
425 {
426 $this->set_rules($this->_config_rules);
427 }
Barry Mienydd671972010-10-04 16:33:58 +0200428
Andrey Andreev901573c2012-01-11 01:40:48 +0200429 // Were we able to set the rules correctly?
Andrey Andreev8dc532d2011-12-24 17:57:54 +0200430 if (count($this->_field_data) === 0)
Derek Allard2067d1a2008-11-13 22:59:24 +0000431 {
Andrey Andreev901573c2012-01-11 01:40:48 +0200432 log_message('debug', 'Unable to find validation rules');
Derek Allard2067d1a2008-11-13 22:59:24 +0000433 return FALSE;
434 }
435 }
Barry Mienydd671972010-10-04 16:33:58 +0200436
Derek Allard2067d1a2008-11-13 22:59:24 +0000437 // Load the language file containing error messages
438 $this->CI->lang->load('form_validation');
Barry Mienydd671972010-10-04 16:33:58 +0200439
Andrey Andreev751f2472012-11-03 18:26:27 +0200440 // Cycle through the rules for each field and match the corresponding $validation_data item
Derek Allard2067d1a2008-11-13 22:59:24 +0000441 foreach ($this->_field_data as $field => $row)
Barry Mienydd671972010-10-04 16:33:58 +0200442 {
Andrey Andreev751f2472012-11-03 18:26:27 +0200443 // Fetch the data from the validation_data array item and cache it in the _field_data array.
Derek Allard2067d1a2008-11-13 22:59:24 +0000444 // Depending on whether the field name is an array or a string will determine where we get it from.
Andrey Andreev8dc532d2011-12-24 17:57:54 +0200445 if ($row['is_array'] === TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000446 {
JonoB099c4782012-03-04 14:37:30 +0000447 $this->_field_data[$field]['postdata'] = $this->_reduce_array($validation_array, $row['keys']);
Derek Allard2067d1a2008-11-13 22:59:24 +0000448 }
Andrey Andreevfff6c2a2012-05-13 22:15:23 +0300449 elseif (isset($validation_array[$field]) && $validation_array[$field] !== '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000450 {
Andrey Andreev78f55772012-04-03 19:59:08 +0300451 $this->_field_data[$field]['postdata'] = $validation_array[$field];
Derek Allard2067d1a2008-11-13 22:59:24 +0000452 }
Andrey Andreev751f2472012-11-03 18:26:27 +0200453 }
Barry Mienydd671972010-10-04 16:33:58 +0200454
Andrey Andreev751f2472012-11-03 18:26:27 +0200455 // Execute validation rules
456 // Note: A second foreach (for now) is required in order to avoid false-positives
457 // for rules like 'matches', which correlate to other validation fields.
458 foreach ($this->_field_data as $field => $row)
459 {
Andrey Andreev3d9cec92012-07-08 21:50:19 +0300460 // Don't try to validate if we have no rules set
461 if (empty($row['rules']))
462 {
463 continue;
464 }
Barry Mienydd671972010-10-04 16:33:58 +0200465
466 $this->_execute($row, explode('|', $row['rules']), $this->_field_data[$field]['postdata']);
Derek Allard2067d1a2008-11-13 22:59:24 +0000467 }
468
469 // Did we end up with any errors?
470 $total_errors = count($this->_error_array);
Derek Allard2067d1a2008-11-13 22:59:24 +0000471 if ($total_errors > 0)
472 {
473 $this->_safe_form_data = TRUE;
474 }
475
476 // Now we need to re-set the POST data with the new, processed data
477 $this->_reset_post_array();
Barry Mienydd671972010-10-04 16:33:58 +0200478
Andrey Andreev8dc532d2011-12-24 17:57:54 +0200479 return ($total_errors === 0);
Derek Allard2067d1a2008-11-13 22:59:24 +0000480 }
481
482 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200483
Derek Allard2067d1a2008-11-13 22:59:24 +0000484 /**
485 * Traverse a multidimensional $_POST array index until the data is found
486 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000487 * @param array
488 * @param array
Andrey Andreev78f55772012-04-03 19:59:08 +0300489 * @param int
Derek Allard2067d1a2008-11-13 22:59:24 +0000490 * @return mixed
Barry Mienydd671972010-10-04 16:33:58 +0200491 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +0100492 protected function _reduce_array($array, $keys, $i = 0)
Derek Allard2067d1a2008-11-13 22:59:24 +0000493 {
Andrey Andreev8dc532d2011-12-24 17:57:54 +0200494 if (is_array($array) && isset($keys[$i]))
Derek Allard2067d1a2008-11-13 22:59:24 +0000495 {
Andrey Andreev8dc532d2011-12-24 17:57:54 +0200496 return isset($array[$keys[$i]]) ? $this->_reduce_array($array[$keys[$i]], $keys, ($i+1)) : NULL;
Derek Allard2067d1a2008-11-13 22:59:24 +0000497 }
Barry Mienydd671972010-10-04 16:33:58 +0200498
Andrey Andreev2d48b4f2012-11-23 17:33:21 +0200499 // NULL must be returned for empty fields
Andrey Andreev44c34632012-11-23 18:46:34 +0200500 return ($array === '') ? NULL : $array;
Derek Allard2067d1a2008-11-13 22:59:24 +0000501 }
502
503 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200504
Derek Allard2067d1a2008-11-13 22:59:24 +0000505 /**
506 * Re-populate the _POST array with our finalized and processed data
507 *
Andrey Andreev6de924c2012-01-20 13:18:18 +0200508 * @return void
Barry Mienydd671972010-10-04 16:33:58 +0200509 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +0100510 protected function _reset_post_array()
Derek Allard2067d1a2008-11-13 22:59:24 +0000511 {
512 foreach ($this->_field_data as $field => $row)
513 {
vlakoff1228fe22013-01-14 01:30:09 +0100514 if ($row['postdata'] !== NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +0000515 {
Andrey Andreev8dc532d2011-12-24 17:57:54 +0200516 if ($row['is_array'] === FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000517 {
518 if (isset($_POST[$row['field']]))
519 {
Andrey Andreevc2268712013-02-08 22:10:23 +0200520 $_POST[$row['field']] = $row['postdata'];
Derek Allard2067d1a2008-11-13 22:59:24 +0000521 }
522 }
523 else
524 {
Derek Jones63eeae32009-02-10 19:08:56 +0000525 // start with a reference
526 $post_ref =& $_POST;
Barry Mienydd671972010-10-04 16:33:58 +0200527
Derek Jones63eeae32009-02-10 19:08:56 +0000528 // before we assign values, make a reference to the right POST key
Andrey Andreev8dc532d2011-12-24 17:57:54 +0200529 if (count($row['keys']) === 1)
Derek Allard2067d1a2008-11-13 22:59:24 +0000530 {
Derek Jones63eeae32009-02-10 19:08:56 +0000531 $post_ref =& $post_ref[current($row['keys'])];
Derek Allard2067d1a2008-11-13 22:59:24 +0000532 }
533 else
534 {
Derek Allard2067d1a2008-11-13 22:59:24 +0000535 foreach ($row['keys'] as $val)
536 {
Derek Jones63eeae32009-02-10 19:08:56 +0000537 $post_ref =& $post_ref[$val];
Derek Allard2067d1a2008-11-13 22:59:24 +0000538 }
539 }
Derek Jones63eeae32009-02-10 19:08:56 +0000540
Derek Allard2067d1a2008-11-13 22:59:24 +0000541 if (is_array($row['postdata']))
Derek Jones63eeae32009-02-10 19:08:56 +0000542 {
Derek Allard2067d1a2008-11-13 22:59:24 +0000543 $array = array();
544 foreach ($row['postdata'] as $k => $v)
545 {
Andrey Andreevc2268712013-02-08 22:10:23 +0200546 $array[$k] = $v;
Derek Allard2067d1a2008-11-13 22:59:24 +0000547 }
Derek Jones63eeae32009-02-10 19:08:56 +0000548
549 $post_ref = $array;
Derek Allard2067d1a2008-11-13 22:59:24 +0000550 }
551 else
Derek Jones63eeae32009-02-10 19:08:56 +0000552 {
Andrey Andreevc2268712013-02-08 22:10:23 +0200553 $post_ref = $row['postdata'];
Derek Allard2067d1a2008-11-13 22:59:24 +0000554 }
Derek Allard2067d1a2008-11-13 22:59:24 +0000555 }
556 }
557 }
558 }
559
560 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200561
Derek Allard2067d1a2008-11-13 22:59:24 +0000562 /**
563 * Executes the Validation routines
564 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000565 * @param array
566 * @param array
567 * @param mixed
Andrey Andreev78f55772012-04-03 19:59:08 +0300568 * @param int
Derek Allard2067d1a2008-11-13 22:59:24 +0000569 * @return mixed
Barry Mienydd671972010-10-04 16:33:58 +0200570 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +0100571 protected function _execute($row, $rules, $postdata = NULL, $cycles = 0)
Derek Allard2067d1a2008-11-13 22:59:24 +0000572 {
573 // If the $_POST data is an array we will run a recursive call
574 if (is_array($postdata))
Barry Mienydd671972010-10-04 16:33:58 +0200575 {
Derek Allard2067d1a2008-11-13 22:59:24 +0000576 foreach ($postdata as $key => $val)
577 {
Andrey Andreev8d3099d2012-06-21 16:00:20 +0300578 $this->_execute($row, $rules, $val, $key);
Derek Allard2067d1a2008-11-13 22:59:24 +0000579 }
Barry Mienydd671972010-10-04 16:33:58 +0200580
Derek Allard2067d1a2008-11-13 22:59:24 +0000581 return;
582 }
Barry Mienydd671972010-10-04 16:33:58 +0200583
Derek Allard2067d1a2008-11-13 22:59:24 +0000584 // If the field is blank, but NOT required, no further tests are necessary
585 $callback = FALSE;
vlakoff1228fe22013-01-14 01:30:09 +0100586 if ( ! in_array('required', $rules) && $postdata === NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +0000587 {
588 // Before we bail out, does the rule contain a callback?
Andrey Andreev901573c2012-01-11 01:40:48 +0200589 if (preg_match('/(callback_\w+(\[.*?\])?)/', implode(' ', $rules), $match))
Derek Allard2067d1a2008-11-13 22:59:24 +0000590 {
591 $callback = TRUE;
Andrey Andreev78f55772012-04-03 19:59:08 +0300592 $rules = array(1 => $match[1]);
Derek Allard2067d1a2008-11-13 22:59:24 +0000593 }
594 else
595 {
596 return;
597 }
598 }
599
Derek Allard2067d1a2008-11-13 22:59:24 +0000600 // Isset Test. Typically this rule will only apply to checkboxes.
vlakoff1228fe22013-01-14 01:30:09 +0100601 if ($postdata === NULL && $callback === FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000602 {
603 if (in_array('isset', $rules, TRUE) OR in_array('required', $rules))
604 {
605 // Set the message type
Andrey Andreev78f55772012-04-03 19:59:08 +0300606 $type = in_array('required', $rules) ? 'required' : 'isset';
Barry Mienydd671972010-10-04 16:33:58 +0200607
Andrey Andreev56454792012-05-17 14:32:19 +0300608 if (isset($this->_error_messages[$type]))
Derek Allard2067d1a2008-11-13 22:59:24 +0000609 {
610 $line = $this->_error_messages[$type];
611 }
Andrey Andreevd4eec9f2012-12-14 11:07:13 +0200612 elseif (FALSE === ($line = $this->CI->lang->line('form_validation_'.$type))
613 // DEPRECATED support for non-prefixed keys
614 && FALSE === ($line = $this->CI->lang->line($type, FALSE)))
Andrey Andreev56454792012-05-17 14:32:19 +0300615 {
616 $line = 'The field was not set';
617 }
Barry Mienydd671972010-10-04 16:33:58 +0200618
Derek Allard2067d1a2008-11-13 22:59:24 +0000619 // Build the error message
Eric Roberts41cc0902012-01-24 00:59:44 -0600620 $message = $this->_build_error_msg($line, $this->_translate_fieldname($row['label']));
Derek Allard2067d1a2008-11-13 22:59:24 +0000621
622 // Save the error message
623 $this->_field_data[$row['field']]['error'] = $message;
Barry Mienydd671972010-10-04 16:33:58 +0200624
Derek Allard2067d1a2008-11-13 22:59:24 +0000625 if ( ! isset($this->_error_array[$row['field']]))
626 {
627 $this->_error_array[$row['field']] = $message;
628 }
629 }
Barry Mienydd671972010-10-04 16:33:58 +0200630
Derek Allard2067d1a2008-11-13 22:59:24 +0000631 return;
632 }
633
634 // --------------------------------------------------------------------
635
636 // Cycle through each rule and run it
Andrey Andreev78f55772012-04-03 19:59:08 +0300637 foreach ($rules as $rule)
Derek Allard2067d1a2008-11-13 22:59:24 +0000638 {
639 $_in_array = FALSE;
Barry Mienydd671972010-10-04 16:33:58 +0200640
Derek Allard2067d1a2008-11-13 22:59:24 +0000641 // We set the $postdata variable with the current data in our master array so that
642 // each cycle of the loop is dealing with the processed data from the last cycle
Alex Bilbied261b1e2012-06-02 11:12:16 +0100643 if ($row['is_array'] === TRUE && is_array($this->_field_data[$row['field']]['postdata']))
Derek Allard2067d1a2008-11-13 22:59:24 +0000644 {
645 // We shouldn't need this safety, but just in case there isn't an array index
646 // associated with this cycle we'll bail out
647 if ( ! isset($this->_field_data[$row['field']]['postdata'][$cycles]))
648 {
649 continue;
650 }
Barry Mienydd671972010-10-04 16:33:58 +0200651
Derek Allard2067d1a2008-11-13 22:59:24 +0000652 $postdata = $this->_field_data[$row['field']]['postdata'][$cycles];
653 $_in_array = TRUE;
654 }
655 else
656 {
Andrey Andreev6ac51442012-06-18 13:05:17 +0300657 // If we get an array field, but it's not expected - then it is most likely
658 // somebody messing with the form on the client side, so we'll just consider
659 // it an empty field
660 $postdata = is_array($this->_field_data[$row['field']]['postdata'])
661 ? NULL
662 : $this->_field_data[$row['field']]['postdata'];
Derek Allard2067d1a2008-11-13 22:59:24 +0000663 }
664
Barry Mienydd671972010-10-04 16:33:58 +0200665 // Is the rule a callback?
Derek Allard2067d1a2008-11-13 22:59:24 +0000666 $callback = FALSE;
Andrey Andreev901573c2012-01-11 01:40:48 +0200667 if (strpos($rule, 'callback_') === 0)
Derek Allard2067d1a2008-11-13 22:59:24 +0000668 {
669 $rule = substr($rule, 9);
670 $callback = TRUE;
671 }
Barry Mienydd671972010-10-04 16:33:58 +0200672
Derek Allard2067d1a2008-11-13 22:59:24 +0000673 // Strip the parameter (if exists) from the rule
674 // Rules can contain a parameter: max_length[5]
675 $param = FALSE;
Andrey Andreev901573c2012-01-11 01:40:48 +0200676 if (preg_match('/(.*?)\[(.*)\]/', $rule, $match))
Derek Allard2067d1a2008-11-13 22:59:24 +0000677 {
Andrey Andreevef758bd2012-11-15 12:24:52 +0200678 $rule = $match[1];
679 $param = $match[2];
Derek Allard2067d1a2008-11-13 22:59:24 +0000680 }
Barry Mienydd671972010-10-04 16:33:58 +0200681
Derek Allard2067d1a2008-11-13 22:59:24 +0000682 // Call the function that corresponds to the rule
683 if ($callback === TRUE)
684 {
685 if ( ! method_exists($this->CI, $rule))
Barry Mienydd671972010-10-04 16:33:58 +0200686 {
Andrey Andreev901573c2012-01-11 01:40:48 +0200687 log_message('debug', 'Unable to find callback validation rule: '.$rule);
688 $result = FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +0000689 }
Andrey Andreev901573c2012-01-11 01:40:48 +0200690 else
691 {
692 // Run the function and grab the result
693 $result = $this->CI->$rule($postdata, $param);
694 }
Derek Allard2067d1a2008-11-13 22:59:24 +0000695
696 // Re-assign the result to the master data array
Andrey Andreev8dc532d2011-12-24 17:57:54 +0200697 if ($_in_array === TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000698 {
Andrey Andreev78f55772012-04-03 19:59:08 +0300699 $this->_field_data[$row['field']]['postdata'][$cycles] = is_bool($result) ? $postdata : $result;
Derek Allard2067d1a2008-11-13 22:59:24 +0000700 }
701 else
702 {
Andrey Andreev78f55772012-04-03 19:59:08 +0300703 $this->_field_data[$row['field']]['postdata'] = is_bool($result) ? $postdata : $result;
Derek Allard2067d1a2008-11-13 22:59:24 +0000704 }
Barry Mienydd671972010-10-04 16:33:58 +0200705
Derek Allard2067d1a2008-11-13 22:59:24 +0000706 // If the field isn't required and we just processed a callback we'll move on...
Andrey Andreev6de924c2012-01-20 13:18:18 +0200707 if ( ! in_array('required', $rules, TRUE) && $result !== FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000708 {
Derek Allard4e5cf1c2009-07-06 20:53:41 +0000709 continue;
Derek Allard2067d1a2008-11-13 22:59:24 +0000710 }
711 }
Andrey Andreev78f55772012-04-03 19:59:08 +0300712 elseif ( ! method_exists($this, $rule))
Barry Mienydd671972010-10-04 16:33:58 +0200713 {
Andrey Andreev78f55772012-04-03 19:59:08 +0300714 // If our own wrapper function doesn't exist we see if a native PHP function does.
715 // Users can use any native PHP function call that has one param.
716 if (function_exists($rule))
Derek Allard2067d1a2008-11-13 22:59:24 +0000717 {
Andrey Andreev320d37c2012-04-03 20:21:39 +0300718 $result = ($param !== FALSE) ? $rule($postdata, $param) : $rule($postdata);
Barry Mienydd671972010-10-04 16:33:58 +0200719
Andrey Andreev78f55772012-04-03 19:59:08 +0300720 if ($_in_array === TRUE)
721 {
722 $this->_field_data[$row['field']]['postdata'][$cycles] = is_bool($result) ? $postdata : $result;
Derek Allard2067d1a2008-11-13 22:59:24 +0000723 }
patwork02404a12011-04-08 15:45:46 +0200724 else
725 {
Andrey Andreevcec2ba52012-04-03 20:26:38 +0300726 $this->_field_data[$row['field']]['postdata'] = is_bool($result) ? $postdata : $result;
patwork02404a12011-04-08 15:45:46 +0200727 }
Derek Allard2067d1a2008-11-13 22:59:24 +0000728 }
Andrey Andreev901573c2012-01-11 01:40:48 +0200729 else
730 {
Andrey Andreevcec2ba52012-04-03 20:26:38 +0300731 log_message('debug', 'Unable to find validation rule: '.$rule);
732 $result = FALSE;
Andrey Andreev901573c2012-01-11 01:40:48 +0200733 }
Andrey Andreev78f55772012-04-03 19:59:08 +0300734 }
Derek Allard2067d1a2008-11-13 22:59:24 +0000735 else
736 {
Derek Allard2067d1a2008-11-13 22:59:24 +0000737 $result = $this->$rule($postdata, $param);
738
Andrey Andreev8dc532d2011-12-24 17:57:54 +0200739 if ($_in_array === TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000740 {
Andrey Andreev78f55772012-04-03 19:59:08 +0300741 $this->_field_data[$row['field']]['postdata'][$cycles] = is_bool($result) ? $postdata : $result;
Derek Allard2067d1a2008-11-13 22:59:24 +0000742 }
743 else
744 {
Andrey Andreev78f55772012-04-03 19:59:08 +0300745 $this->_field_data[$row['field']]['postdata'] = is_bool($result) ? $postdata : $result;
Derek Allard2067d1a2008-11-13 22:59:24 +0000746 }
747 }
Barry Mienydd671972010-10-04 16:33:58 +0200748
Andrey Andreev901573c2012-01-11 01:40:48 +0200749 // Did the rule test negatively? If so, grab the error.
Derek Allard2067d1a2008-11-13 22:59:24 +0000750 if ($result === FALSE)
Barry Mienydd671972010-10-04 16:33:58 +0200751 {
Derek Allard2067d1a2008-11-13 22:59:24 +0000752 if ( ! isset($this->_error_messages[$rule]))
753 {
Andrey Andreevd4eec9f2012-12-14 11:07:13 +0200754 if (FALSE === ($line = $this->CI->lang->line('form_validation_'.$rule))
755 // DEPRECATED support for non-prefixed keys
756 && FALSE === ($line = $this->CI->lang->line($rule, FALSE)))
Derek Allard2067d1a2008-11-13 22:59:24 +0000757 {
758 $line = 'Unable to access an error message corresponding to your field name.';
Barry Mienydd671972010-10-04 16:33:58 +0200759 }
Derek Allard2067d1a2008-11-13 22:59:24 +0000760 }
761 else
762 {
763 $line = $this->_error_messages[$rule];
764 }
Barry Mienydd671972010-10-04 16:33:58 +0200765
Derek Allard2067d1a2008-11-13 22:59:24 +0000766 // Is the parameter we are inserting into the error message the name
Andrey Andreev901573c2012-01-11 01:40:48 +0200767 // of another field? If so we need to grab its "field label"
Andrey Andreev8dc532d2011-12-24 17:57:54 +0200768 if (isset($this->_field_data[$param], $this->_field_data[$param]['label']))
Derek Allard2067d1a2008-11-13 22:59:24 +0000769 {
Pascal Krietec1895832009-10-13 12:56:43 +0000770 $param = $this->_translate_fieldname($this->_field_data[$param]['label']);
Derek Allard2067d1a2008-11-13 22:59:24 +0000771 }
Barry Mienydd671972010-10-04 16:33:58 +0200772
Derek Allard2067d1a2008-11-13 22:59:24 +0000773 // Build the error message
Eric Roberts41cc0902012-01-24 00:59:44 -0600774 $message = $this->_build_error_msg($line, $this->_translate_fieldname($row['label']), $param);
Derek Allard2067d1a2008-11-13 22:59:24 +0000775
776 // Save the error message
777 $this->_field_data[$row['field']]['error'] = $message;
Barry Mienydd671972010-10-04 16:33:58 +0200778
Derek Allard2067d1a2008-11-13 22:59:24 +0000779 if ( ! isset($this->_error_array[$row['field']]))
780 {
781 $this->_error_array[$row['field']] = $message;
782 }
Barry Mienydd671972010-10-04 16:33:58 +0200783
Derek Allard2067d1a2008-11-13 22:59:24 +0000784 return;
785 }
786 }
787 }
788
789 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200790
Derek Allard2067d1a2008-11-13 22:59:24 +0000791 /**
792 * Translate a field name
793 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000794 * @param string the field name
795 * @return string
Barry Mienydd671972010-10-04 16:33:58 +0200796 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +0100797 protected function _translate_fieldname($fieldname)
Derek Allard2067d1a2008-11-13 22:59:24 +0000798 {
799 // Do we need to translate the field name?
800 // We look for the prefix lang: to determine this
Andrey Andreev7a7ad782012-11-12 17:21:01 +0200801 if (sscanf($fieldname, 'lang:%s', $line) === 1)
Derek Allard2067d1a2008-11-13 22:59:24 +0000802 {
Derek Jones37f4b9c2011-07-01 17:56:50 -0500803 // Were we able to translate the field name? If not we use $line
Andrey Andreevd4eec9f2012-12-14 11:07:13 +0200804 if (FALSE === ($fieldname = $this->CI->lang->line('form_validation_'.$line))
805 // DEPRECATED support for non-prefixed keys
806 && FALSE === ($fieldname = $this->CI->lang->line($line, FALSE)))
Derek Allard2067d1a2008-11-13 22:59:24 +0000807 {
808 return $line;
809 }
810 }
811
812 return $fieldname;
813 }
814
815 // --------------------------------------------------------------------
Andrey Andreevd4eec9f2012-12-14 11:07:13 +0200816
Eric Roberts41cc0902012-01-24 00:59:44 -0600817 /**
818 * Build an error message using the field and param.
819 *
820 * @param string The error message line
821 * @param string A field's human name
822 * @param mixed A rule's optional parameter
823 * @return string
824 */
825 protected function _build_error_msg($line, $field = '', $param = '')
826 {
827 // Check for %s in the string for legacy support.
Eric Roberts24a13f52012-12-12 07:09:42 -0600828 if (strpos($line, '%s') !== FALSE)
Eric Roberts41cc0902012-01-24 00:59:44 -0600829 {
830 return sprintf($line, $field, $param);
831 }
Andrew Podner4296a652012-12-17 07:51:15 -0500832
Eric Roberts41cc0902012-01-24 00:59:44 -0600833 return str_replace(array('{field}', '{param}'), array($field, $param), $line);
834 }
835
836 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200837
Derek Allard2067d1a2008-11-13 22:59:24 +0000838 /**
nisheeth-barthwala7447d22013-03-21 15:48:10 +0530839 * Checks if the rule is present within the validator
840 *
841 * Permits you to check if a rule is present within the validator
842 *
843 * @param string the field name
844 * @return bool
845 */
846 public function has_rule($field)
847 {
848 return isset($this->_field_data[$field]);
849 }
850
851 // --------------------------------------------------------------------
852
853 /**
Derek Allard2067d1a2008-11-13 22:59:24 +0000854 * Get the value from a form
855 *
856 * Permits you to repopulate a form field with the value it was submitted
857 * with, or, if that value doesn't exist, with the default
858 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000859 * @param string the field name
860 * @param string
Andrey Andreev46ac8812012-02-28 14:32:54 +0200861 * @return string
Barry Mienydd671972010-10-04 16:33:58 +0200862 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +0100863 public function set_value($field = '', $default = '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000864 {
Andrey Andreev46ac8812012-02-28 14:32:54 +0200865 if ( ! isset($this->_field_data[$field], $this->_field_data[$field]['postdata']))
Derek Allard2067d1a2008-11-13 22:59:24 +0000866 {
867 return $default;
868 }
Barry Mienydd671972010-10-04 16:33:58 +0200869
Phil Sturgeon5c561802011-01-05 16:31:59 +0000870 // If the data is an array output them one at a time.
Greg Aker03abee32011-12-25 00:31:29 -0600871 // E.g: form_input('name[]', set_value('name[]');
Phil Sturgeon5c561802011-01-05 16:31:59 +0000872 if (is_array($this->_field_data[$field]['postdata']))
873 {
874 return array_shift($this->_field_data[$field]['postdata']);
875 }
Phil Sturgeonc3828712011-01-19 12:31:47 +0000876
Derek Allard2067d1a2008-11-13 22:59:24 +0000877 return $this->_field_data[$field]['postdata'];
878 }
Barry Mienydd671972010-10-04 16:33:58 +0200879
Derek Allard2067d1a2008-11-13 22:59:24 +0000880 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200881
Derek Allard2067d1a2008-11-13 22:59:24 +0000882 /**
883 * Set Select
884 *
885 * Enables pull-down lists to be set to the value the user
886 * selected in the event of an error
887 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000888 * @param string
889 * @param string
Timothy Warren0688ac92012-04-20 10:25:04 -0400890 * @param bool
Derek Allard2067d1a2008-11-13 22:59:24 +0000891 * @return string
Barry Mienydd671972010-10-04 16:33:58 +0200892 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +0100893 public function set_select($field = '', $value = '', $default = FALSE)
Barry Mienydd671972010-10-04 16:33:58 +0200894 {
Andrey Andreev46ac8812012-02-28 14:32:54 +0200895 if ( ! isset($this->_field_data[$field], $this->_field_data[$field]['postdata']))
Derek Allard2067d1a2008-11-13 22:59:24 +0000896 {
Andrey Andreev6de924c2012-01-20 13:18:18 +0200897 return ($default === TRUE && count($this->_field_data) === 0) ? ' selected="selected"' : '';
Derek Allard2067d1a2008-11-13 22:59:24 +0000898 }
Barry Mienydd671972010-10-04 16:33:58 +0200899
Derek Allard2067d1a2008-11-13 22:59:24 +0000900 $field = $this->_field_data[$field]['postdata'];
Derek Allard2067d1a2008-11-13 22:59:24 +0000901 if (is_array($field))
902 {
903 if ( ! in_array($value, $field))
904 {
905 return '';
906 }
907 }
Alex Bilbied261b1e2012-06-02 11:12:16 +0100908 elseif (($field === '' OR $value === '') OR ($field !== $value))
Derek Allard2067d1a2008-11-13 22:59:24 +0000909 {
Andrey Andreev901573c2012-01-11 01:40:48 +0200910 return '';
Derek Allard2067d1a2008-11-13 22:59:24 +0000911 }
Barry Mienydd671972010-10-04 16:33:58 +0200912
Derek Allard2067d1a2008-11-13 22:59:24 +0000913 return ' selected="selected"';
914 }
Barry Mienydd671972010-10-04 16:33:58 +0200915
Derek Allard2067d1a2008-11-13 22:59:24 +0000916 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200917
Derek Allard2067d1a2008-11-13 22:59:24 +0000918 /**
919 * Set Radio
920 *
921 * Enables radio buttons to be set to the value the user
922 * selected in the event of an error
923 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000924 * @param string
925 * @param string
Timothy Warren0688ac92012-04-20 10:25:04 -0400926 * @param bool
Derek Allard2067d1a2008-11-13 22:59:24 +0000927 * @return string
Barry Mienydd671972010-10-04 16:33:58 +0200928 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +0100929 public function set_radio($field = '', $value = '', $default = FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000930 {
Andrey Andreev46ac8812012-02-28 14:32:54 +0200931 if ( ! isset($this->_field_data[$field], $this->_field_data[$field]['postdata']))
Derek Allard2067d1a2008-11-13 22:59:24 +0000932 {
Andrey Andreev6de924c2012-01-20 13:18:18 +0200933 return ($default === TRUE && count($this->_field_data) === 0) ? ' checked="checked"' : '';
Derek Allard2067d1a2008-11-13 22:59:24 +0000934 }
Barry Mienydd671972010-10-04 16:33:58 +0200935
Derek Allard2067d1a2008-11-13 22:59:24 +0000936 $field = $this->_field_data[$field]['postdata'];
Derek Allard2067d1a2008-11-13 22:59:24 +0000937 if (is_array($field))
938 {
939 if ( ! in_array($value, $field))
940 {
941 return '';
942 }
943 }
Alex Bilbied261b1e2012-06-02 11:12:16 +0100944 elseif (($field === '' OR $value === '') OR ($field !== $value))
Derek Allard2067d1a2008-11-13 22:59:24 +0000945 {
Andrey Andreev901573c2012-01-11 01:40:48 +0200946 return '';
Derek Allard2067d1a2008-11-13 22:59:24 +0000947 }
Barry Mienydd671972010-10-04 16:33:58 +0200948
Derek Allard2067d1a2008-11-13 22:59:24 +0000949 return ' checked="checked"';
950 }
Barry Mienydd671972010-10-04 16:33:58 +0200951
Derek Allard2067d1a2008-11-13 22:59:24 +0000952 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200953
Derek Allard2067d1a2008-11-13 22:59:24 +0000954 /**
955 * Set Checkbox
956 *
957 * Enables checkboxes to be set to the value the user
958 * selected in the event of an error
959 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000960 * @param string
961 * @param string
Timothy Warren0688ac92012-04-20 10:25:04 -0400962 * @param bool
Derek Allard2067d1a2008-11-13 22:59:24 +0000963 * @return string
Barry Mienydd671972010-10-04 16:33:58 +0200964 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +0100965 public function set_checkbox($field = '', $value = '', $default = FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000966 {
Andrey Andreev8dc532d2011-12-24 17:57:54 +0200967 // Logic is exactly the same as for radio fields
968 return $this->set_radio($field, $value, $default);
Derek Allard2067d1a2008-11-13 22:59:24 +0000969 }
Barry Mienydd671972010-10-04 16:33:58 +0200970
Derek Allard2067d1a2008-11-13 22:59:24 +0000971 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200972
Derek Allard2067d1a2008-11-13 22:59:24 +0000973 /**
974 * Required
975 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000976 * @param string
977 * @return bool
978 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +0100979 public function required($str)
Derek Allard2067d1a2008-11-13 22:59:24 +0000980 {
Andrey Andreev78f55772012-04-03 19:59:08 +0300981 return is_array($str) ? (bool) count($str) : (trim($str) !== '');
Derek Allard2067d1a2008-11-13 22:59:24 +0000982 }
Barry Mienydd671972010-10-04 16:33:58 +0200983
Derek Allard2067d1a2008-11-13 22:59:24 +0000984 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200985
Derek Allard2067d1a2008-11-13 22:59:24 +0000986 /**
Dan Horrigan2280e8e2010-12-15 10:16:38 -0500987 * Performs a Regular Expression match test.
988 *
Dan Horrigan2280e8e2010-12-15 10:16:38 -0500989 * @param string
Andrey Andreev78f55772012-04-03 19:59:08 +0300990 * @param string regex
Dan Horrigan2280e8e2010-12-15 10:16:38 -0500991 * @return bool
992 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +0100993 public function regex_match($str, $regex)
Dan Horrigan2280e8e2010-12-15 10:16:38 -0500994 {
Andrey Andreev8dc532d2011-12-24 17:57:54 +0200995 return (bool) preg_match($regex, $str);
Dan Horrigan2280e8e2010-12-15 10:16:38 -0500996 }
997
998 // --------------------------------------------------------------------
999
1000 /**
Derek Allard2067d1a2008-11-13 22:59:24 +00001001 * Match one field to another
1002 *
Andrey Andreeva779b2c2012-10-26 16:25:47 +03001003 * @param string $str string to compare against
1004 * @param string $field
Derek Allard2067d1a2008-11-13 22:59:24 +00001005 * @return bool
1006 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +01001007 public function matches($str, $field)
Derek Allard2067d1a2008-11-13 22:59:24 +00001008 {
Andrey Andreeva779b2c2012-10-26 16:25:47 +03001009 return isset($this->_field_data[$field], $this->_field_data[$field]['postdata'])
1010 ? ($str === $this->_field_data[$field]['postdata'])
1011 : FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +00001012 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001013
Phil Sturgeon3837ae72011-05-09 21:12:26 +01001014 // --------------------------------------------------------------------
1015
1016 /**
Raul Baldner Juniorf38564d2012-10-11 11:32:23 -03001017 * Differs from another field
1018 *
1019 * @param string
1020 * @param string field
1021 * @return bool
1022 */
1023 public function differs($str, $field)
1024 {
1025 return ! (isset($this->_field_data[$field]) && $this->_field_data[$field]['postdata'] === $str);
Derek Allard2067d1a2008-11-13 22:59:24 +00001026 }
Phil Sturgeon3837ae72011-05-09 21:12:26 +01001027
1028 // --------------------------------------------------------------------
1029
1030 /**
Andrey Andreevd09d6502012-01-03 06:38:33 +02001031 * Is Unique
Phil Sturgeon3837ae72011-05-09 21:12:26 +01001032 *
Andrey Andreevd09d6502012-01-03 06:38:33 +02001033 * Check if the input value doesn't already exist
1034 * in the specified database field.
1035 *
Phil Sturgeon3837ae72011-05-09 21:12:26 +01001036 * @param string
Andrey Andreev78f55772012-04-03 19:59:08 +03001037 * @param string field
Phil Sturgeon3837ae72011-05-09 21:12:26 +01001038 * @return bool
1039 */
1040 public function is_unique($str, $field)
1041 {
Andrey Andreev7a7ad782012-11-12 17:21:01 +02001042 sscanf($field, '%[^.].%[^.]', $table, $field);
Eric Barnescccde962011-12-04 00:01:17 -05001043 if (isset($this->CI->db))
1044 {
1045 $query = $this->CI->db->limit(1)->get_where($table, array($field => $str));
1046 return $query->num_rows() === 0;
1047 }
1048 return FALSE;
Greg Aker03abee32011-12-25 00:31:29 -06001049 }
Barry Mienydd671972010-10-04 16:33:58 +02001050
Derek Allard2067d1a2008-11-13 22:59:24 +00001051 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +02001052
Derek Allard2067d1a2008-11-13 22:59:24 +00001053 /**
1054 * Minimum Length
1055 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001056 * @param string
Michiel Vugteveena8221ad2012-06-14 23:26:34 +02001057 * @param string
Derek Allard2067d1a2008-11-13 22:59:24 +00001058 * @return bool
Barry Mienydd671972010-10-04 16:33:58 +02001059 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +01001060 public function min_length($str, $val)
Derek Allard2067d1a2008-11-13 22:59:24 +00001061 {
Michiel Vugteveenceaf8872012-06-15 11:56:24 +02001062 if ( ! is_numeric($val))
Derek Allard2067d1a2008-11-13 22:59:24 +00001063 {
1064 return FALSE;
1065 }
Michiel Vugteveenceaf8872012-06-15 11:56:24 +02001066 else
1067 {
1068 $val = (int) $val;
1069 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001070
Andrey Andreev78f55772012-04-03 19:59:08 +03001071 return (MB_ENABLED === TRUE)
1072 ? ($val <= mb_strlen($str))
Michiel Vugteveenceaf8872012-06-15 11:56:24 +02001073 : ($val <= strlen($str));
Derek Allard2067d1a2008-11-13 22:59:24 +00001074 }
Barry Mienydd671972010-10-04 16:33:58 +02001075
Derek Allard2067d1a2008-11-13 22:59:24 +00001076 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +02001077
Derek Allard2067d1a2008-11-13 22:59:24 +00001078 /**
1079 * Max Length
1080 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001081 * @param string
Michiel Vugteveena8221ad2012-06-14 23:26:34 +02001082 * @param string
Derek Allard2067d1a2008-11-13 22:59:24 +00001083 * @return bool
Barry Mienydd671972010-10-04 16:33:58 +02001084 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +01001085 public function max_length($str, $val)
Derek Allard2067d1a2008-11-13 22:59:24 +00001086 {
Michiel Vugteveenceaf8872012-06-15 11:56:24 +02001087 if ( ! is_numeric($val))
Derek Allard2067d1a2008-11-13 22:59:24 +00001088 {
1089 return FALSE;
1090 }
Michiel Vugteveenceaf8872012-06-15 11:56:24 +02001091 else
1092 {
1093 $val = (int) $val;
1094 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001095
Andrey Andreev78f55772012-04-03 19:59:08 +03001096 return (MB_ENABLED === TRUE)
1097 ? ($val >= mb_strlen($str))
1098 : ($val >= strlen($str));
Derek Allard2067d1a2008-11-13 22:59:24 +00001099 }
Barry Mienydd671972010-10-04 16:33:58 +02001100
Derek Allard2067d1a2008-11-13 22:59:24 +00001101 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +02001102
Derek Allard2067d1a2008-11-13 22:59:24 +00001103 /**
1104 * Exact Length
1105 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001106 * @param string
Michiel Vugteveeneccde132012-06-14 23:22:26 +02001107 * @param string
Derek Allard2067d1a2008-11-13 22:59:24 +00001108 * @return bool
Barry Mienydd671972010-10-04 16:33:58 +02001109 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +01001110 public function exact_length($str, $val)
Derek Allard2067d1a2008-11-13 22:59:24 +00001111 {
Michiel Vugteveenceaf8872012-06-15 11:56:24 +02001112 if ( ! is_numeric($val))
Derek Allard2067d1a2008-11-13 22:59:24 +00001113 {
1114 return FALSE;
1115 }
Michiel Vugteveenceaf8872012-06-15 11:56:24 +02001116 else
1117 {
1118 $val = (int) $val;
1119 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001120
Andrey Andreev78f55772012-04-03 19:59:08 +03001121 return (MB_ENABLED === TRUE)
Michiel Vugteveenceaf8872012-06-15 11:56:24 +02001122 ? (mb_strlen($str) === $val)
1123 : (strlen($str) === $val);
Derek Allard2067d1a2008-11-13 22:59:24 +00001124 }
Barry Mienydd671972010-10-04 16:33:58 +02001125
Derek Allard2067d1a2008-11-13 22:59:24 +00001126 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +02001127
Derek Allard2067d1a2008-11-13 22:59:24 +00001128 /**
Andrey Andreevdaaca882012-11-26 22:16:12 +02001129 * Valid URL
1130 *
1131 * @param string $str
1132 * @return bool
1133 */
1134 public function valid_url($str)
1135 {
1136 if (empty($str))
1137 {
1138 return FALSE;
1139 }
1140 elseif (preg_match('/^(?:([^:]*)\:)?\/\/(.+)$/', $str, $matches))
1141 {
1142 if (empty($matches[2]))
1143 {
1144 return FALSE;
1145 }
1146 elseif ( ! in_array($matches[1], array('http', 'https'), TRUE))
1147 {
1148 return FALSE;
1149 }
1150
1151 $str = $matches[2];
1152 }
1153
1154 $str = 'http://'.$str;
1155
1156 // There's a bug affecting PHP 5.2.13, 5.3.2 that considers the
1157 // underscore to be a valid hostname character instead of a dash.
1158 // Reference: https://bugs.php.net/bug.php?id=51192
1159 if (version_compare(PHP_VERSION, '5.2.13', '==') === 0 OR version_compare(PHP_VERSION, '5.3.2', '==') === 0)
1160 {
1161 sscanf($str, 'http://%[^/]', $host);
1162 $str = substr_replace($str, strtr($host, array('_' => '-', '-' => '_')), 7, strlen($host));
1163 }
1164
1165 return (filter_var($str, FILTER_VALIDATE_URL) !== FALSE);
Derek Allard2067d1a2008-11-13 22:59:24 +00001166 }
1167
1168 // --------------------------------------------------------------------
1169
1170 /**
1171 * Valid Email
1172 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001173 * @param string
1174 * @return bool
Barry Mienydd671972010-10-04 16:33:58 +02001175 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +01001176 public function valid_email($str)
Derek Allard2067d1a2008-11-13 22:59:24 +00001177 {
Andrey Andreev580388b2012-06-27 15:43:46 +03001178 return (bool) filter_var($str, FILTER_VALIDATE_EMAIL);
Derek Allard2067d1a2008-11-13 22:59:24 +00001179 }
1180
1181 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +02001182
Derek Allard2067d1a2008-11-13 22:59:24 +00001183 /**
1184 * Valid Emails
1185 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001186 * @param string
1187 * @return bool
Barry Mienydd671972010-10-04 16:33:58 +02001188 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +01001189 public function valid_emails($str)
Derek Allard2067d1a2008-11-13 22:59:24 +00001190 {
1191 if (strpos($str, ',') === FALSE)
1192 {
1193 return $this->valid_email(trim($str));
1194 }
Barry Mienydd671972010-10-04 16:33:58 +02001195
Pascal Kriete14287f32011-02-14 13:39:34 -05001196 foreach (explode(',', $str) as $email)
Derek Allard2067d1a2008-11-13 22:59:24 +00001197 {
Andrey Andreev8dc532d2011-12-24 17:57:54 +02001198 if (trim($email) !== '' && $this->valid_email(trim($email)) === FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +00001199 {
1200 return FALSE;
1201 }
1202 }
Barry Mienydd671972010-10-04 16:33:58 +02001203
Derek Allard2067d1a2008-11-13 22:59:24 +00001204 return TRUE;
1205 }
1206
1207 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +02001208
Derek Allard2067d1a2008-11-13 22:59:24 +00001209 /**
1210 * Validate IP Address
1211 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001212 * @param string
Andrey Andreev5a257182012-06-10 06:18:14 +03001213 * @param string 'ipv4' or 'ipv6' to validate a specific IP format
Bo-Yi Wu013c8952011-09-12 15:03:44 +08001214 * @return bool
Derek Allard2067d1a2008-11-13 22:59:24 +00001215 */
Andrey Andreev5a257182012-06-10 06:18:14 +03001216 public function valid_ip($ip, $which = '')
Derek Allard2067d1a2008-11-13 22:59:24 +00001217 {
Andrey Andreev5a257182012-06-10 06:18:14 +03001218 return $this->CI->input->valid_ip($ip, $which);
Derek Allard2067d1a2008-11-13 22:59:24 +00001219 }
1220
1221 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +02001222
Derek Allard2067d1a2008-11-13 22:59:24 +00001223 /**
1224 * Alpha
1225 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001226 * @param string
1227 * @return bool
Barry Mienydd671972010-10-04 16:33:58 +02001228 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +01001229 public function alpha($str)
Derek Allard2067d1a2008-11-13 22:59:24 +00001230 {
Andrey Andreevacb962e2012-06-27 12:04:24 +03001231 return ctype_alpha($str);
Derek Allard2067d1a2008-11-13 22:59:24 +00001232 }
Barry Mienydd671972010-10-04 16:33:58 +02001233
Derek Allard2067d1a2008-11-13 22:59:24 +00001234 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +02001235
Derek Allard2067d1a2008-11-13 22:59:24 +00001236 /**
1237 * Alpha-numeric
1238 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001239 * @param string
1240 * @return bool
Barry Mienydd671972010-10-04 16:33:58 +02001241 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +01001242 public function alpha_numeric($str)
Derek Allard2067d1a2008-11-13 22:59:24 +00001243 {
Andrey Andreevacb962e2012-06-27 12:04:24 +03001244 return ctype_alnum((string) $str);
Derek Allard2067d1a2008-11-13 22:59:24 +00001245 }
Barry Mienydd671972010-10-04 16:33:58 +02001246
Derek Allard2067d1a2008-11-13 22:59:24 +00001247 // --------------------------------------------------------------------
Sajan Parikh2d1608a2013-02-02 08:00:39 -06001248
1249 /**
1250 * Alpha-numeric w/ spaces
1251 *
1252 * @param string
1253 * @return bool
1254 */
1255 public function alpha_numeric_spaces($str)
1256 {
Sajan Parikhdf3bfed2013-02-04 12:25:49 -06001257 return (bool) preg_match('/^[A-Z0-9 ]+$/i', $str);
Sajan Parikh2d1608a2013-02-02 08:00:39 -06001258 }
1259
1260 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +02001261
Derek Allard2067d1a2008-11-13 22:59:24 +00001262 /**
1263 * Alpha-numeric with underscores and dashes
1264 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001265 * @param string
1266 * @return bool
Barry Mienydd671972010-10-04 16:33:58 +02001267 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +01001268 public function alpha_dash($str)
Derek Allard2067d1a2008-11-13 22:59:24 +00001269 {
Andrey Andreev8dc532d2011-12-24 17:57:54 +02001270 return (bool) preg_match('/^[a-z0-9_-]+$/i', $str);
Derek Allard2067d1a2008-11-13 22:59:24 +00001271 }
Barry Mienydd671972010-10-04 16:33:58 +02001272
Derek Allard2067d1a2008-11-13 22:59:24 +00001273 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +02001274
Derek Allard2067d1a2008-11-13 22:59:24 +00001275 /**
1276 * Numeric
1277 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001278 * @param string
1279 * @return bool
Barry Mienydd671972010-10-04 16:33:58 +02001280 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +01001281 public function numeric($str)
Derek Allard2067d1a2008-11-13 22:59:24 +00001282 {
Andrey Andreev8dc532d2011-12-24 17:57:54 +02001283 return (bool) preg_match('/^[\-+]?[0-9]*\.?[0-9]+$/', $str);
Derek Allard2067d1a2008-11-13 22:59:24 +00001284
1285 }
1286
1287 // --------------------------------------------------------------------
1288
Barry Mienydd671972010-10-04 16:33:58 +02001289 /**
Derek Allard2067d1a2008-11-13 22:59:24 +00001290 * Integer
1291 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001292 * @param string
1293 * @return bool
Barry Mienydd671972010-10-04 16:33:58 +02001294 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +01001295 public function integer($str)
Derek Allard2067d1a2008-11-13 22:59:24 +00001296 {
Phil Sturgeonef112c02011-02-07 13:01:47 +00001297 return (bool) preg_match('/^[\-+]?[0-9]+$/', $str);
1298 }
1299
1300 // --------------------------------------------------------------------
1301
1302 /**
1303 * Decimal number
1304 *
Phil Sturgeonef112c02011-02-07 13:01:47 +00001305 * @param string
1306 * @return bool
1307 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +01001308 public function decimal($str)
Phil Sturgeonef112c02011-02-07 13:01:47 +00001309 {
1310 return (bool) preg_match('/^[\-+]?[0-9]+\.[0-9]+$/', $str);
1311 }
1312
1313 // --------------------------------------------------------------------
1314
1315 /**
Andrey Andreevc68905a2012-02-02 21:41:54 +02001316 * Greater than
Phil Sturgeonef112c02011-02-07 13:01:47 +00001317 *
Phil Sturgeonef112c02011-02-07 13:01:47 +00001318 * @param string
Timothy Warren0688ac92012-04-20 10:25:04 -04001319 * @param int
Phil Sturgeonef112c02011-02-07 13:01:47 +00001320 * @return bool
1321 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +01001322 public function greater_than($str, $min)
Phil Sturgeonef112c02011-02-07 13:01:47 +00001323 {
Andrey Andreev78f55772012-04-03 19:59:08 +03001324 return is_numeric($str) ? ($str > $min) : FALSE;
Phil Sturgeonef112c02011-02-07 13:01:47 +00001325 }
1326
1327 // --------------------------------------------------------------------
1328
1329 /**
Nick Busey98c347d2012-02-02 11:07:03 -07001330 * Equal to or Greater than
1331 *
Nick Busey98c347d2012-02-02 11:07:03 -07001332 * @param string
Timothy Warren0688ac92012-04-20 10:25:04 -04001333 * @param int
Nick Busey98c347d2012-02-02 11:07:03 -07001334 * @return bool
1335 */
Andrey Andreev3b2c5082012-03-07 22:49:24 +02001336 public function greater_than_equal_to($str, $min)
Nick Busey98c347d2012-02-02 11:07:03 -07001337 {
Andrey Andreev78f55772012-04-03 19:59:08 +03001338 return is_numeric($str) ? ($str >= $min) : FALSE;
Phil Sturgeonef112c02011-02-07 13:01:47 +00001339 }
1340
1341 // --------------------------------------------------------------------
1342
1343 /**
1344 * Less than
1345 *
Phil Sturgeonef112c02011-02-07 13:01:47 +00001346 * @param string
Timothy Warren0688ac92012-04-20 10:25:04 -04001347 * @param int
Phil Sturgeonef112c02011-02-07 13:01:47 +00001348 * @return bool
1349 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +01001350 public function less_than($str, $max)
Phil Sturgeonef112c02011-02-07 13:01:47 +00001351 {
Andrey Andreev78f55772012-04-03 19:59:08 +03001352 return is_numeric($str) ? ($str < $max) : FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +00001353 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001354
1355 // --------------------------------------------------------------------
1356
Barry Mienydd671972010-10-04 16:33:58 +02001357 /**
Nick Busey98c347d2012-02-02 11:07:03 -07001358 * Equal to or Less than
1359 *
Nick Busey98c347d2012-02-02 11:07:03 -07001360 * @param string
Timothy Warren0688ac92012-04-20 10:25:04 -04001361 * @param int
Nick Busey98c347d2012-02-02 11:07:03 -07001362 * @return bool
1363 */
Andrey Andreev3b2c5082012-03-07 22:49:24 +02001364 public function less_than_equal_to($str, $max)
Nick Busey98c347d2012-02-02 11:07:03 -07001365 {
Andrey Andreev78f55772012-04-03 19:59:08 +03001366 return is_numeric($str) ? ($str <= $max) : FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +00001367 }
1368
1369 // --------------------------------------------------------------------
1370
Barry Mienydd671972010-10-04 16:33:58 +02001371 /**
Derek Jones37f4b9c2011-07-01 17:56:50 -05001372 * Is a Natural number (0,1,2,3, etc.)
Barry Mienydd671972010-10-04 16:33:58 +02001373 *
Barry Mienydd671972010-10-04 16:33:58 +02001374 * @param string
1375 * @return bool
1376 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +01001377 public function is_natural($str)
Barry Mienydd671972010-10-04 16:33:58 +02001378 {
Andrey Andreevacb962e2012-06-27 12:04:24 +03001379 return ctype_digit((string) $str);
Barry Mienydd671972010-10-04 16:33:58 +02001380 }
1381
1382 // --------------------------------------------------------------------
1383
1384 /**
Derek Jones37f4b9c2011-07-01 17:56:50 -05001385 * Is a Natural number, but not a zero (1,2,3, etc.)
Barry Mienydd671972010-10-04 16:33:58 +02001386 *
Barry Mienydd671972010-10-04 16:33:58 +02001387 * @param string
1388 * @return bool
1389 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +01001390 public function is_natural_no_zero($str)
Barry Mienydd671972010-10-04 16:33:58 +02001391 {
Andrey Andreevacb962e2012-06-27 12:04:24 +03001392 return ($str != 0 && ctype_digit((string) $str));
Barry Mienydd671972010-10-04 16:33:58 +02001393 }
1394
Derek Allard2067d1a2008-11-13 22:59:24 +00001395 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +02001396
Derek Allard2067d1a2008-11-13 22:59:24 +00001397 /**
1398 * Valid Base64
1399 *
1400 * Tests a string for characters outside of the Base64 alphabet
1401 * as defined by RFC 2045 http://www.faqs.org/rfcs/rfc2045
1402 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001403 * @param string
1404 * @return bool
1405 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +01001406 public function valid_base64($str)
Derek Allard2067d1a2008-11-13 22:59:24 +00001407 {
Andrey Andreev56454792012-05-17 14:32:19 +03001408 return ! preg_match('/[^a-zA-Z0-9\/\+=]/', $str);
Derek Allard2067d1a2008-11-13 22:59:24 +00001409 }
Barry Mienydd671972010-10-04 16:33:58 +02001410
Derek Allard2067d1a2008-11-13 22:59:24 +00001411 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +02001412
Derek Allard2067d1a2008-11-13 22:59:24 +00001413 /**
1414 * Prep data for form
1415 *
1416 * This function allows HTML to be safely shown in a form.
1417 * Special characters are converted.
1418 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001419 * @param string
1420 * @return string
1421 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +01001422 public function prep_for_form($data = '')
Derek Allard2067d1a2008-11-13 22:59:24 +00001423 {
Andrey Andreev7c4d1062012-11-01 15:14:34 +02001424 if ($this->_safe_form_data === FALSE OR empty($data))
1425 {
1426 return $data;
1427 }
1428
Derek Allard2067d1a2008-11-13 22:59:24 +00001429 if (is_array($data))
1430 {
1431 foreach ($data as $key => $val)
1432 {
1433 $data[$key] = $this->prep_for_form($val);
1434 }
Barry Mienydd671972010-10-04 16:33:58 +02001435
Derek Allard2067d1a2008-11-13 22:59:24 +00001436 return $data;
1437 }
Barry Mienydd671972010-10-04 16:33:58 +02001438
Andrey Andreev901573c2012-01-11 01:40:48 +02001439 return str_replace(array("'", '"', '<', '>'), array('&#39;', '&quot;', '&lt;', '&gt;'), stripslashes($data));
Derek Allard2067d1a2008-11-13 22:59:24 +00001440 }
Barry Mienydd671972010-10-04 16:33:58 +02001441
Derek Allard2067d1a2008-11-13 22:59:24 +00001442 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +02001443
Derek Allard2067d1a2008-11-13 22:59:24 +00001444 /**
1445 * Prep URL
1446 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001447 * @param string
1448 * @return string
Barry Mienydd671972010-10-04 16:33:58 +02001449 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +01001450 public function prep_url($str = '')
Derek Allard2067d1a2008-11-13 22:59:24 +00001451 {
Alex Bilbied261b1e2012-06-02 11:12:16 +01001452 if ($str === 'http://' OR $str === '')
Derek Allard2067d1a2008-11-13 22:59:24 +00001453 {
1454 return '';
1455 }
Barry Mienydd671972010-10-04 16:33:58 +02001456
Andrey Andreev901573c2012-01-11 01:40:48 +02001457 if (strpos($str, 'http://') !== 0 && strpos($str, 'https://') !== 0)
Derek Allard2067d1a2008-11-13 22:59:24 +00001458 {
Andrey Andreev901573c2012-01-11 01:40:48 +02001459 return 'http://'.$str;
Derek Allard2067d1a2008-11-13 22:59:24 +00001460 }
Barry Mienydd671972010-10-04 16:33:58 +02001461
Derek Allard2067d1a2008-11-13 22:59:24 +00001462 return $str;
1463 }
Barry Mienydd671972010-10-04 16:33:58 +02001464
Derek Allard2067d1a2008-11-13 22:59:24 +00001465 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +02001466
Derek Allard2067d1a2008-11-13 22:59:24 +00001467 /**
1468 * Strip Image Tags
1469 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001470 * @param string
1471 * @return string
Barry Mienydd671972010-10-04 16:33:58 +02001472 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +01001473 public function strip_image_tags($str)
Derek Allard2067d1a2008-11-13 22:59:24 +00001474 {
Andrey Andreev1a24a9d2012-06-27 00:52:47 +03001475 return $this->CI->security->strip_image_tags($str);
Derek Allard2067d1a2008-11-13 22:59:24 +00001476 }
Barry Mienydd671972010-10-04 16:33:58 +02001477
Derek Allard2067d1a2008-11-13 22:59:24 +00001478 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +02001479
Derek Allard2067d1a2008-11-13 22:59:24 +00001480 /**
1481 * XSS Clean
1482 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001483 * @param string
1484 * @return string
Barry Mienydd671972010-10-04 16:33:58 +02001485 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +01001486 public function xss_clean($str)
Derek Allard2067d1a2008-11-13 22:59:24 +00001487 {
Derek Jones5640a712010-04-23 11:22:40 -05001488 return $this->CI->security->xss_clean($str);
Derek Allard2067d1a2008-11-13 22:59:24 +00001489 }
Barry Mienydd671972010-10-04 16:33:58 +02001490
Derek Allard2067d1a2008-11-13 22:59:24 +00001491 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +02001492
Derek Allard2067d1a2008-11-13 22:59:24 +00001493 /**
1494 * Convert PHP tags to entities
1495 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001496 * @param string
1497 * @return string
Barry Mienydd671972010-10-04 16:33:58 +02001498 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +01001499 public function encode_php_tags($str)
Derek Allard2067d1a2008-11-13 22:59:24 +00001500 {
Andrey Andreev838a9d62012-12-03 14:37:47 +02001501 return str_replace(array('<?', '?>'), array('&lt;?', '?&gt;'), $str);
Derek Allard2067d1a2008-11-13 22:59:24 +00001502 }
1503
JonoB099c4782012-03-04 14:37:30 +00001504 // --------------------------------------------------------------------
Andrey Andreevc8da4fe2012-03-04 19:20:33 +02001505
1506 /**
1507 * Reset validation vars
1508 *
1509 * Prevents subsequent validation routines from being affected by the
JonoB099c4782012-03-04 14:37:30 +00001510 * results of any previous validation routine due to the CI singleton.
Andrey Andreevc8da4fe2012-03-04 19:20:33 +02001511 *
Andrey Andreev3b2c5082012-03-07 22:49:24 +02001512 * @return void
Andrey Andreevc8da4fe2012-03-04 19:20:33 +02001513 */
JonoB883f80f2012-03-05 09:51:27 +00001514 public function reset_validation()
Andrey Andreevc8da4fe2012-03-04 19:20:33 +02001515 {
JonoB099c4782012-03-04 14:37:30 +00001516 $this->_field_data = array();
1517 $this->_config_rules = array();
1518 $this->_error_array = array();
1519 $this->_error_messages = array();
1520 $this->error_string = '';
Andrey Andreevc8da4fe2012-03-04 19:20:33 +02001521 }
1522
Derek Allard2067d1a2008-11-13 22:59:24 +00001523}
Derek Allard2067d1a2008-11-13 22:59:24 +00001524
1525/* End of file Form_validation.php */
Eric Roberts24a13f52012-12-12 07:09:42 -06001526/* Location: ./system/libraries/Form_validation.php */