blob: b490a34ca49e7932e8647df9723cd87bf2b586aa [file] [log] [blame]
Andrey Andreev8dc532d2011-12-24 17:57:54 +02001<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
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
Andrey Andreevb998f3e2012-01-24 15:31:26 +020012 * bundled with this package in the files license.txt / license.rst. It is
Derek Jonesf4a4bd82011-10-20 12:18:42 -050013 * 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
Greg Aker0defe5d2012-01-01 18:46:41 -060021 * @copyright Copyright (c) 2008 - 2012, 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 */
27
Derek Allard2067d1a2008-11-13 22:59:24 +000028/**
29 * Form Validation Class
30 *
31 * @package CodeIgniter
32 * @subpackage Libraries
33 * @category Validation
Derek Jonesf4a4bd82011-10-20 12:18:42 -050034 * @author EllisLab Dev Team
Derek Allard2067d1a2008-11-13 22:59:24 +000035 * @link http://codeigniter.com/user_guide/libraries/form_validation.html
36 */
37class CI_Form_validation {
Barry Mienydd671972010-10-04 16:33:58 +020038
Timothy Warren0688ac92012-04-20 10:25:04 -040039 /**
40 * Reference to the CodeIgniter instance
41 *
42 * @var object
43 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +010044 protected $CI;
Andrey Andreev56454792012-05-17 14:32:19 +030045
Timothy Warren0688ac92012-04-20 10:25:04 -040046 /**
47 * Validation data for the current form submission
48 *
49 * @var array
50 */
Andrey Andreev56454792012-05-17 14:32:19 +030051 protected $_field_data = array();
52
Timothy Warren0688ac92012-04-20 10:25:04 -040053 /**
54 * Validation rules for the current form
55 *
56 * @var array
57 */
Andrey Andreev56454792012-05-17 14:32:19 +030058 protected $_config_rules = array();
59
Timothy Warren0688ac92012-04-20 10:25:04 -040060 /**
61 * Array of validation errors
62 *
63 * @var array
64 */
Andrey Andreev78f55772012-04-03 19:59:08 +030065 protected $_error_array = array();
Andrey Andreev56454792012-05-17 14:32:19 +030066
Timothy Warren0688ac92012-04-20 10:25:04 -040067 /**
68 * Array of custom error messages
69 *
70 * @var array
71 */
Andrey Andreev78f55772012-04-03 19:59:08 +030072 protected $_error_messages = array();
Andrey Andreev56454792012-05-17 14:32:19 +030073
Timothy Warren0688ac92012-04-20 10:25:04 -040074 /**
75 * Start tag for error wrapping
76 *
77 * @var string
78 */
Andrey Andreev78f55772012-04-03 19:59:08 +030079 protected $_error_prefix = '<p>';
Andrey Andreev56454792012-05-17 14:32:19 +030080
Timothy Warren0688ac92012-04-20 10:25:04 -040081 /**
82 * End tag for error wrapping
Andrey Andreev56454792012-05-17 14:32:19 +030083 *
Timothy Warren0688ac92012-04-20 10:25:04 -040084 * @var string
85 */
Andrey Andreev78f55772012-04-03 19:59:08 +030086 protected $_error_suffix = '</p>';
Andrey Andreev56454792012-05-17 14:32:19 +030087
Timothy Warren0688ac92012-04-20 10:25:04 -040088 /**
89 * Custom error message
90 *
91 * @var string
92 */
Andrey Andreev78f55772012-04-03 19:59:08 +030093 protected $error_string = '';
Andrey Andreev56454792012-05-17 14:32:19 +030094
Timothy Warren0688ac92012-04-20 10:25:04 -040095 /**
96 * Whether the form data has been validated as safe
97 *
98 * @var bool
99 */
Andrey Andreev78f55772012-04-03 19:59:08 +0300100 protected $_safe_form_data = FALSE;
Andrey Andreev56454792012-05-17 14:32:19 +0300101
Timothy Warren0688ac92012-04-20 10:25:04 -0400102 /**
103 * Custom data to validate
104 *
105 * @var array
106 */
Andrey Andreev78f55772012-04-03 19:59:08 +0300107 protected $validation_data = array();
Derek Allard2067d1a2008-11-13 22:59:24 +0000108
Timothy Warren0688ac92012-04-20 10:25:04 -0400109 /**
110 * Initialize Form_Validation class
111 *
Andrey Andreev56454792012-05-17 14:32:19 +0300112 * @param array $rules
113 * @return void
Timothy Warren0688ac92012-04-20 10:25:04 -0400114 */
Greg Akera9263282010-11-10 15:26:43 -0600115 public function __construct($rules = array())
Barry Mienydd671972010-10-04 16:33:58 +0200116 {
Derek Allard2067d1a2008-11-13 22:59:24 +0000117 $this->CI =& get_instance();
Barry Mienydd671972010-10-04 16:33:58 +0200118
Mike Funk326a5e72012-02-24 10:06:28 -0500119 // applies delimiters set in config file.
Mike Funk7f42d062012-03-08 09:00:57 -0500120 if (isset($rules['error_prefix']))
121 {
122 $this->_error_prefix = $rules['error_prefix'];
123 unset($rules['error_prefix']);
124 }
125 if (isset($rules['error_suffix']))
126 {
127 $this->_error_suffix = $rules['error_suffix'];
128 unset($rules['error_suffix']);
129 }
Andrey Andreev31cf46e2012-03-20 15:48:00 +0200130
Derek Allard2067d1a2008-11-13 22:59:24 +0000131 // Validation rules can be stored in a config file.
132 $this->_config_rules = $rules;
Barry Mienydd671972010-10-04 16:33:58 +0200133
Derek Allard2067d1a2008-11-13 22:59:24 +0000134 // Automatically load the form helper
135 $this->CI->load->helper('form');
136
137 // Set the character encoding in MB.
tiyowan5b9fd2d2012-03-12 20:26:59 +0400138 if (MB_ENABLED === TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000139 {
140 mb_internal_encoding($this->CI->config->item('charset'));
141 }
Barry Mienydd671972010-10-04 16:33:58 +0200142
Andrey Andreev901573c2012-01-11 01:40:48 +0200143 log_message('debug', 'Form Validation Class Initialized');
Derek Allard2067d1a2008-11-13 22:59:24 +0000144 }
Barry Mienydd671972010-10-04 16:33:58 +0200145
Derek Allard2067d1a2008-11-13 22:59:24 +0000146 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200147
Derek Allard2067d1a2008-11-13 22:59:24 +0000148 /**
149 * Set Rules
150 *
151 * This function takes an array of field names and validation
152 * rules as input, validates the info, and stores it
153 *
Timothy Warren0688ac92012-04-20 10:25:04 -0400154 * @param mixed $field
155 * @param string $label
156 * @param mixed $rules
Andrey Andreev78f55772012-04-03 19:59:08 +0300157 * @return object
Derek Allard2067d1a2008-11-13 22:59:24 +0000158 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +0100159 public function set_rules($field, $label = '', $rules = '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000160 {
161 // No reason to set rules if we have no POST data
JonoB099c4782012-03-04 14:37:30 +0000162 // or a validation array has not been specified
Andrey Andreev3b2c5082012-03-07 22:49:24 +0200163 if ($this->CI->input->method() !== 'post' && empty($this->validation_data))
Derek Allard2067d1a2008-11-13 22:59:24 +0000164 {
Greg Aker9f9af602010-11-10 15:41:51 -0600165 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000166 }
Barry Mienydd671972010-10-04 16:33:58 +0200167
tiyowanc2acb232012-03-14 21:24:00 +0400168 // If an array was passed via the first parameter instead of individual string
Derek Allard2067d1a2008-11-13 22:59:24 +0000169 // values we cycle through it and recursively call this function.
170 if (is_array($field))
171 {
172 foreach ($field as $row)
173 {
174 // Houston, we have a problem...
Andrey Andreev78f55772012-04-03 19:59:08 +0300175 if ( ! isset($row['field'], $row['rules']))
Derek Allard2067d1a2008-11-13 22:59:24 +0000176 {
177 continue;
178 }
179
180 // If the field label wasn't passed we use the field name
Andrey Andreev78f55772012-04-03 19:59:08 +0300181 $label = isset($row['label']) ? $row['label'] : $row['field'];
Derek Allard2067d1a2008-11-13 22:59:24 +0000182
183 // Here we go!
184 $this->set_rules($row['field'], $label, $row['rules']);
185 }
Andrey Andreev78f55772012-04-03 19:59:08 +0300186
Greg Aker9f9af602010-11-10 15:41:51 -0600187 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000188 }
Barry Mienydd671972010-10-04 16:33:58 +0200189
Kevin Wood-Friend6a56d502012-06-12 09:54:01 -0400190 // Convert an array of rules to a string
191 if (is_array($rules))
192 {
193 $rules = implode('|', $rules);
194 }
195
Derek Allard2067d1a2008-11-13 22:59:24 +0000196 // No fields? Nothing to do...
Alex Bilbied261b1e2012-06-02 11:12:16 +0100197 if ( ! is_string($field) OR ! is_string($rules) OR $field === '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000198 {
Greg Aker9f9af602010-11-10 15:41:51 -0600199 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000200 }
201
202 // If the field label wasn't passed we use the field name
Alex Bilbied261b1e2012-06-02 11:12:16 +0100203 $label = ($label === '') ? $field : $label;
Derek Allard2067d1a2008-11-13 22:59:24 +0000204
Andrey Andreev8dc532d2011-12-24 17:57:54 +0200205 // Is the field name an array? If it is an array, we break it apart
Barry Mienydd671972010-10-04 16:33:58 +0200206 // into its components so that we can fetch the corresponding POST data later
Andrey Andreev8dc532d2011-12-24 17:57:54 +0200207 if (preg_match_all('/\[(.*?)\]/', $field, $matches))
Barry Mienydd671972010-10-04 16:33:58 +0200208 {
Derek Allard2067d1a2008-11-13 22:59:24 +0000209 // Note: Due to a bug in current() that affects some versions
210 // of PHP we can not pass function call directly into it
211 $x = explode('[', $field);
212 $indexes[] = current($x);
213
Andrey Andreev8dc532d2011-12-24 17:57:54 +0200214 for ($i = 0, $c = count($matches[0]); $i < $c; $i++)
Derek Allard2067d1a2008-11-13 22:59:24 +0000215 {
Alex Bilbied261b1e2012-06-02 11:12:16 +0100216 if ($matches[1][$i] !== '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000217 {
Andrey Andreev8dc532d2011-12-24 17:57:54 +0200218 $indexes[] = $matches[1][$i];
Derek Allard2067d1a2008-11-13 22:59:24 +0000219 }
220 }
Barry Mienydd671972010-10-04 16:33:58 +0200221
Derek Allard2067d1a2008-11-13 22:59:24 +0000222 $is_array = TRUE;
223 }
224 else
225 {
Barry Mienydd671972010-10-04 16:33:58 +0200226 $indexes = array();
227 $is_array = FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +0000228 }
Barry Mienydd671972010-10-04 16:33:58 +0200229
230 // Build our master array
Derek Allard2067d1a2008-11-13 22:59:24 +0000231 $this->_field_data[$field] = array(
Andrey Andreev56454792012-05-17 14:32:19 +0300232 'field' => $field,
233 'label' => $label,
234 'rules' => $rules,
235 'is_array' => $is_array,
236 'keys' => $indexes,
237 'postdata' => NULL,
238 'error' => ''
Phil Sturgeonef112c02011-02-07 13:01:47 +0000239 );
Greg Aker9f9af602010-11-10 15:41:51 -0600240
241 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000242 }
243
244 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200245
Derek Allard2067d1a2008-11-13 22:59:24 +0000246 /**
JonoB099c4782012-03-04 14:37:30 +0000247 * By default, form validation uses the $_POST array to validate
Andrey Andreevc8da4fe2012-03-04 19:20:33 +0200248 *
JonoB099c4782012-03-04 14:37:30 +0000249 * If an array is set through this method, then this array will
250 * be used instead of the $_POST array
Andrey Andreev3b2c5082012-03-07 22:49:24 +0200251 *
252 * Note that if you are validating multiple arrays, then the
253 * reset_validation() function should be called after validating
JonoB883f80f2012-03-05 09:51:27 +0000254 * each array due to the limitations of CI's singleton
Andrey Andreevc8da4fe2012-03-04 19:20:33 +0200255 *
256 * @param array $data
257 * @return void
JonoB099c4782012-03-04 14:37:30 +0000258 */
259 public function set_data($data = '')
260 {
261 if ( ! empty($data) && is_array($data))
262 {
Andrey Andreevc8da4fe2012-03-04 19:20:33 +0200263 $this->validation_data = $data;
JonoB099c4782012-03-04 14:37:30 +0000264 }
265 }
Andrey Andreevc8da4fe2012-03-04 19:20:33 +0200266
JonoB099c4782012-03-04 14:37:30 +0000267 // --------------------------------------------------------------------
Derek Allard2067d1a2008-11-13 22:59:24 +0000268
269 /**
270 * Set Error Message
271 *
Andrey Andreev78f55772012-04-03 19:59:08 +0300272 * Lets users set their own error messages on the fly. Note:
273 * The key name has to match the function name that it corresponds to.
Derek Allard2067d1a2008-11-13 22:59:24 +0000274 *
Andrey Andreev78f55772012-04-03 19:59:08 +0300275 * @param array
Derek Allard2067d1a2008-11-13 22:59:24 +0000276 * @param string
Andrey Andreev78f55772012-04-03 19:59:08 +0300277 * @return object
Derek Allard2067d1a2008-11-13 22:59:24 +0000278 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +0100279 public function set_message($lang, $val = '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000280 {
281 if ( ! is_array($lang))
282 {
283 $lang = array($lang => $val);
284 }
Barry Mienydd671972010-10-04 16:33:58 +0200285
Derek Allard2067d1a2008-11-13 22:59:24 +0000286 $this->_error_messages = array_merge($this->_error_messages, $lang);
Greg Aker9f9af602010-11-10 15:41:51 -0600287 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000288 }
Barry Mienydd671972010-10-04 16:33:58 +0200289
Derek Allard2067d1a2008-11-13 22:59:24 +0000290 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200291
Derek Allard2067d1a2008-11-13 22:59:24 +0000292 /**
293 * Set The Error Delimiter
294 *
295 * Permits a prefix/suffix to be added to each error message
296 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000297 * @param string
298 * @param string
Andrey Andreev78f55772012-04-03 19:59:08 +0300299 * @return object
Barry Mienydd671972010-10-04 16:33:58 +0200300 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +0100301 public function set_error_delimiters($prefix = '<p>', $suffix = '</p>')
Derek Allard2067d1a2008-11-13 22:59:24 +0000302 {
303 $this->_error_prefix = $prefix;
304 $this->_error_suffix = $suffix;
Greg Aker9f9af602010-11-10 15:41:51 -0600305 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000306 }
307
308 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200309
Derek Allard2067d1a2008-11-13 22:59:24 +0000310 /**
311 * Get Error Message
312 *
313 * Gets the error message associated with a particular field
314 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000315 * @param string the field name
Timothy Warren0688ac92012-04-20 10:25:04 -0400316 * @param string the html start tag
317 * @param strign the html end tag
Andrey Andreev78f55772012-04-03 19:59:08 +0300318 * @return string
Barry Mienydd671972010-10-04 16:33:58 +0200319 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +0100320 public function error($field = '', $prefix = '', $suffix = '')
Barry Mienydd671972010-10-04 16:33:58 +0200321 {
Andrey Andreev78f55772012-04-03 19:59:08 +0300322 if (empty($this->_field_data[$field]['error']))
Derek Allard2067d1a2008-11-13 22:59:24 +0000323 {
324 return '';
325 }
Barry Mienydd671972010-10-04 16:33:58 +0200326
Alex Bilbied261b1e2012-06-02 11:12:16 +0100327 if ($prefix === '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000328 {
329 $prefix = $this->_error_prefix;
330 }
331
Alex Bilbied261b1e2012-06-02 11:12:16 +0100332 if ($suffix === '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000333 {
334 $suffix = $this->_error_suffix;
335 }
336
337 return $prefix.$this->_field_data[$field]['error'].$suffix;
338 }
339
340 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200341
Derek Allard2067d1a2008-11-13 22:59:24 +0000342 /**
Michiel Vugteveen676a0dd2012-03-02 10:10:34 +0100343 * Get Array of Error Messages
344 *
345 * Returns the error messages as an array
346 *
347 * @return array
348 */
349 public function error_array()
350 {
351 return $this->_error_array;
352 }
353
354 // --------------------------------------------------------------------
355
356 /**
Derek Allard2067d1a2008-11-13 22:59:24 +0000357 * Error String
358 *
359 * Returns the error messages as a string, wrapped in the error delimiters
360 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000361 * @param string
362 * @param string
Andrey Andreev78f55772012-04-03 19:59:08 +0300363 * @return string
Barry Mienydd671972010-10-04 16:33:58 +0200364 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +0100365 public function error_string($prefix = '', $suffix = '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000366 {
367 // No errrors, validation passes!
368 if (count($this->_error_array) === 0)
369 {
370 return '';
371 }
Barry Mienydd671972010-10-04 16:33:58 +0200372
Alex Bilbied261b1e2012-06-02 11:12:16 +0100373 if ($prefix === '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000374 {
375 $prefix = $this->_error_prefix;
376 }
377
Alex Bilbied261b1e2012-06-02 11:12:16 +0100378 if ($suffix === '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000379 {
380 $suffix = $this->_error_suffix;
381 }
Barry Mienydd671972010-10-04 16:33:58 +0200382
Derek Allard2067d1a2008-11-13 22:59:24 +0000383 // Generate the error string
384 $str = '';
385 foreach ($this->_error_array as $val)
386 {
Alex Bilbied261b1e2012-06-02 11:12:16 +0100387 if ($val !== '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000388 {
389 $str .= $prefix.$val.$suffix."\n";
390 }
391 }
Barry Mienydd671972010-10-04 16:33:58 +0200392
Derek Allard2067d1a2008-11-13 22:59:24 +0000393 return $str;
394 }
395
396 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200397
Derek Allard2067d1a2008-11-13 22:59:24 +0000398 /**
399 * Run the Validator
400 *
401 * This function does all the work.
402 *
Timothy Warren0688ac92012-04-20 10:25:04 -0400403 * @param string $group
Derek Allard2067d1a2008-11-13 22:59:24 +0000404 * @return bool
Barry Mienydd671972010-10-04 16:33:58 +0200405 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +0100406 public function run($group = '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000407 {
Derek Jones37f4b9c2011-07-01 17:56:50 -0500408 // Do we even have any data to process? Mm?
Andrey Andreev78f55772012-04-03 19:59:08 +0300409 $validation_array = empty($this->validation_data) ? $_POST : $this->validation_data;
JonoB099c4782012-03-04 14:37:30 +0000410 if (count($validation_array) === 0)
Derek Allard2067d1a2008-11-13 22:59:24 +0000411 {
412 return FALSE;
413 }
Barry Mienydd671972010-10-04 16:33:58 +0200414
Derek Allard2067d1a2008-11-13 22:59:24 +0000415 // Does the _field_data array containing the validation rules exist?
416 // If not, we look to see if they were assigned via a config file
Andrey Andreev8dc532d2011-12-24 17:57:54 +0200417 if (count($this->_field_data) === 0)
Derek Allard2067d1a2008-11-13 22:59:24 +0000418 {
Derek Jones37f4b9c2011-07-01 17:56:50 -0500419 // No validation rules? We're done...
Andrey Andreev8dc532d2011-12-24 17:57:54 +0200420 if (count($this->_config_rules) === 0)
Derek Allard2067d1a2008-11-13 22:59:24 +0000421 {
422 return FALSE;
423 }
Barry Mienydd671972010-10-04 16:33:58 +0200424
Derek Allard2067d1a2008-11-13 22:59:24 +0000425 // Is there a validation rule for the particular URI being accessed?
Alex Bilbied261b1e2012-06-02 11:12:16 +0100426 $uri = ($group === '') ? trim($this->CI->uri->ruri_string(), '/') : $group;
Barry Mienydd671972010-10-04 16:33:58 +0200427
Alex Bilbied261b1e2012-06-02 11:12:16 +0100428 if ($uri !== '' && isset($this->_config_rules[$uri]))
Derek Allard2067d1a2008-11-13 22:59:24 +0000429 {
430 $this->set_rules($this->_config_rules[$uri]);
431 }
432 else
433 {
434 $this->set_rules($this->_config_rules);
435 }
Barry Mienydd671972010-10-04 16:33:58 +0200436
Andrey Andreev901573c2012-01-11 01:40:48 +0200437 // Were we able to set the rules correctly?
Andrey Andreev8dc532d2011-12-24 17:57:54 +0200438 if (count($this->_field_data) === 0)
Derek Allard2067d1a2008-11-13 22:59:24 +0000439 {
Andrey Andreev901573c2012-01-11 01:40:48 +0200440 log_message('debug', 'Unable to find validation rules');
Derek Allard2067d1a2008-11-13 22:59:24 +0000441 return FALSE;
442 }
443 }
Barry Mienydd671972010-10-04 16:33:58 +0200444
Derek Allard2067d1a2008-11-13 22:59:24 +0000445 // Load the language file containing error messages
446 $this->CI->lang->load('form_validation');
Barry Mienydd671972010-10-04 16:33:58 +0200447
448 // Cycle through the rules for each field, match the
Derek Allard2067d1a2008-11-13 22:59:24 +0000449 // corresponding $_POST item and test for errors
450 foreach ($this->_field_data as $field => $row)
Barry Mienydd671972010-10-04 16:33:58 +0200451 {
JonoB099c4782012-03-04 14:37:30 +0000452 // Fetch the data from the corresponding $_POST or validation array and cache it in the _field_data array.
Derek Allard2067d1a2008-11-13 22:59:24 +0000453 // 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 +0200454 if ($row['is_array'] === TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000455 {
JonoB099c4782012-03-04 14:37:30 +0000456 $this->_field_data[$field]['postdata'] = $this->_reduce_array($validation_array, $row['keys']);
Derek Allard2067d1a2008-11-13 22:59:24 +0000457 }
Andrey Andreevfff6c2a2012-05-13 22:15:23 +0300458 elseif (isset($validation_array[$field]) && $validation_array[$field] !== '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000459 {
Andrey Andreev78f55772012-04-03 19:59:08 +0300460 $this->_field_data[$field]['postdata'] = $validation_array[$field];
Derek Allard2067d1a2008-11-13 22:59:24 +0000461 }
Barry Mienydd671972010-10-04 16:33:58 +0200462
Andrey Andreev3d9cec92012-07-08 21:50:19 +0300463 // Don't try to validate if we have no rules set
464 if (empty($row['rules']))
465 {
466 continue;
467 }
468
Barry Mienydd671972010-10-04 16:33:58 +0200469 $this->_execute($row, explode('|', $row['rules']), $this->_field_data[$field]['postdata']);
Derek Allard2067d1a2008-11-13 22:59:24 +0000470 }
471
472 // Did we end up with any errors?
473 $total_errors = count($this->_error_array);
Derek Allard2067d1a2008-11-13 22:59:24 +0000474 if ($total_errors > 0)
475 {
476 $this->_safe_form_data = TRUE;
477 }
478
479 // Now we need to re-set the POST data with the new, processed data
480 $this->_reset_post_array();
Barry Mienydd671972010-10-04 16:33:58 +0200481
Andrey Andreev8dc532d2011-12-24 17:57:54 +0200482 return ($total_errors === 0);
Derek Allard2067d1a2008-11-13 22:59:24 +0000483 }
484
485 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200486
Derek Allard2067d1a2008-11-13 22:59:24 +0000487 /**
488 * Traverse a multidimensional $_POST array index until the data is found
489 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000490 * @param array
491 * @param array
Andrey Andreev78f55772012-04-03 19:59:08 +0300492 * @param int
Derek Allard2067d1a2008-11-13 22:59:24 +0000493 * @return mixed
Barry Mienydd671972010-10-04 16:33:58 +0200494 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +0100495 protected function _reduce_array($array, $keys, $i = 0)
Derek Allard2067d1a2008-11-13 22:59:24 +0000496 {
Andrey Andreev8dc532d2011-12-24 17:57:54 +0200497 if (is_array($array) && isset($keys[$i]))
Derek Allard2067d1a2008-11-13 22:59:24 +0000498 {
Andrey Andreev8dc532d2011-12-24 17:57:54 +0200499 return isset($array[$keys[$i]]) ? $this->_reduce_array($array[$keys[$i]], $keys, ($i+1)) : NULL;
Derek Allard2067d1a2008-11-13 22:59:24 +0000500 }
Barry Mienydd671972010-10-04 16:33:58 +0200501
Derek Allard2067d1a2008-11-13 22:59:24 +0000502 return $array;
503 }
504
505 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200506
Derek Allard2067d1a2008-11-13 22:59:24 +0000507 /**
508 * Re-populate the _POST array with our finalized and processed data
509 *
Andrey Andreev6de924c2012-01-20 13:18:18 +0200510 * @return void
Barry Mienydd671972010-10-04 16:33:58 +0200511 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +0100512 protected function _reset_post_array()
Derek Allard2067d1a2008-11-13 22:59:24 +0000513 {
514 foreach ($this->_field_data as $field => $row)
515 {
516 if ( ! is_null($row['postdata']))
517 {
Andrey Andreev8dc532d2011-12-24 17:57:54 +0200518 if ($row['is_array'] === FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000519 {
520 if (isset($_POST[$row['field']]))
521 {
522 $_POST[$row['field']] = $this->prep_for_form($row['postdata']);
523 }
524 }
525 else
526 {
Derek Jones63eeae32009-02-10 19:08:56 +0000527 // start with a reference
528 $post_ref =& $_POST;
Barry Mienydd671972010-10-04 16:33:58 +0200529
Derek Jones63eeae32009-02-10 19:08:56 +0000530 // before we assign values, make a reference to the right POST key
Andrey Andreev8dc532d2011-12-24 17:57:54 +0200531 if (count($row['keys']) === 1)
Derek Allard2067d1a2008-11-13 22:59:24 +0000532 {
Derek Jones63eeae32009-02-10 19:08:56 +0000533 $post_ref =& $post_ref[current($row['keys'])];
Derek Allard2067d1a2008-11-13 22:59:24 +0000534 }
535 else
536 {
Derek Allard2067d1a2008-11-13 22:59:24 +0000537 foreach ($row['keys'] as $val)
538 {
Derek Jones63eeae32009-02-10 19:08:56 +0000539 $post_ref =& $post_ref[$val];
Derek Allard2067d1a2008-11-13 22:59:24 +0000540 }
541 }
Derek Jones63eeae32009-02-10 19:08:56 +0000542
Derek Allard2067d1a2008-11-13 22:59:24 +0000543 if (is_array($row['postdata']))
Derek Jones63eeae32009-02-10 19:08:56 +0000544 {
Derek Allard2067d1a2008-11-13 22:59:24 +0000545 $array = array();
546 foreach ($row['postdata'] as $k => $v)
547 {
548 $array[$k] = $this->prep_for_form($v);
549 }
Derek Jones63eeae32009-02-10 19:08:56 +0000550
551 $post_ref = $array;
Derek Allard2067d1a2008-11-13 22:59:24 +0000552 }
553 else
Derek Jones63eeae32009-02-10 19:08:56 +0000554 {
555 $post_ref = $this->prep_for_form($row['postdata']);
Derek Allard2067d1a2008-11-13 22:59:24 +0000556 }
Derek Allard2067d1a2008-11-13 22:59:24 +0000557 }
558 }
559 }
560 }
561
562 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200563
Derek Allard2067d1a2008-11-13 22:59:24 +0000564 /**
565 * Executes the Validation routines
566 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000567 * @param array
568 * @param array
569 * @param mixed
Andrey Andreev78f55772012-04-03 19:59:08 +0300570 * @param int
Derek Allard2067d1a2008-11-13 22:59:24 +0000571 * @return mixed
Barry Mienydd671972010-10-04 16:33:58 +0200572 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +0100573 protected function _execute($row, $rules, $postdata = NULL, $cycles = 0)
Derek Allard2067d1a2008-11-13 22:59:24 +0000574 {
575 // If the $_POST data is an array we will run a recursive call
576 if (is_array($postdata))
Barry Mienydd671972010-10-04 16:33:58 +0200577 {
Derek Allard2067d1a2008-11-13 22:59:24 +0000578 foreach ($postdata as $key => $val)
579 {
Andrey Andreev8d3099d2012-06-21 16:00:20 +0300580 $this->_execute($row, $rules, $val, $key);
Derek Allard2067d1a2008-11-13 22:59:24 +0000581 }
Barry Mienydd671972010-10-04 16:33:58 +0200582
Derek Allard2067d1a2008-11-13 22:59:24 +0000583 return;
584 }
Barry Mienydd671972010-10-04 16:33:58 +0200585
Derek Allard2067d1a2008-11-13 22:59:24 +0000586 // If the field is blank, but NOT required, no further tests are necessary
587 $callback = FALSE;
Andrey Andreev6de924c2012-01-20 13:18:18 +0200588 if ( ! in_array('required', $rules) && is_null($postdata))
Derek Allard2067d1a2008-11-13 22:59:24 +0000589 {
590 // Before we bail out, does the rule contain a callback?
Andrey Andreev901573c2012-01-11 01:40:48 +0200591 if (preg_match('/(callback_\w+(\[.*?\])?)/', implode(' ', $rules), $match))
Derek Allard2067d1a2008-11-13 22:59:24 +0000592 {
593 $callback = TRUE;
Andrey Andreev78f55772012-04-03 19:59:08 +0300594 $rules = array(1 => $match[1]);
Derek Allard2067d1a2008-11-13 22:59:24 +0000595 }
596 else
597 {
598 return;
599 }
600 }
601
Derek Allard2067d1a2008-11-13 22:59:24 +0000602 // Isset Test. Typically this rule will only apply to checkboxes.
Andrey Andreev6de924c2012-01-20 13:18:18 +0200603 if (is_null($postdata) && $callback === FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000604 {
605 if (in_array('isset', $rules, TRUE) OR in_array('required', $rules))
606 {
607 // Set the message type
Andrey Andreev78f55772012-04-03 19:59:08 +0300608 $type = in_array('required', $rules) ? 'required' : 'isset';
Barry Mienydd671972010-10-04 16:33:58 +0200609
Andrey Andreev56454792012-05-17 14:32:19 +0300610 if (isset($this->_error_messages[$type]))
Derek Allard2067d1a2008-11-13 22:59:24 +0000611 {
612 $line = $this->_error_messages[$type];
613 }
Andrey Andreev56454792012-05-17 14:32:19 +0300614 elseif (FALSE === ($line = $this->CI->lang->line($type)))
615 {
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
620 $message = sprintf($line, $this->_translate_fieldname($row['label']));
621
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 {
678 $rule = $match[1];
679 $param = $match[2];
680 }
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 }
735 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 {
754 if (FALSE === ($line = $this->CI->lang->line($rule)))
755 {
756 $line = 'Unable to access an error message corresponding to your field name.';
Barry Mienydd671972010-10-04 16:33:58 +0200757 }
Derek Allard2067d1a2008-11-13 22:59:24 +0000758 }
759 else
760 {
761 $line = $this->_error_messages[$rule];
762 }
Barry Mienydd671972010-10-04 16:33:58 +0200763
Derek Allard2067d1a2008-11-13 22:59:24 +0000764 // Is the parameter we are inserting into the error message the name
Andrey Andreev901573c2012-01-11 01:40:48 +0200765 // of another field? If so we need to grab its "field label"
Andrey Andreev8dc532d2011-12-24 17:57:54 +0200766 if (isset($this->_field_data[$param], $this->_field_data[$param]['label']))
Derek Allard2067d1a2008-11-13 22:59:24 +0000767 {
Pascal Krietec1895832009-10-13 12:56:43 +0000768 $param = $this->_translate_fieldname($this->_field_data[$param]['label']);
Derek Allard2067d1a2008-11-13 22:59:24 +0000769 }
Barry Mienydd671972010-10-04 16:33:58 +0200770
Derek Allard2067d1a2008-11-13 22:59:24 +0000771 // Build the error message
772 $message = sprintf($line, $this->_translate_fieldname($row['label']), $param);
773
774 // Save the error message
775 $this->_field_data[$row['field']]['error'] = $message;
Barry Mienydd671972010-10-04 16:33:58 +0200776
Derek Allard2067d1a2008-11-13 22:59:24 +0000777 if ( ! isset($this->_error_array[$row['field']]))
778 {
779 $this->_error_array[$row['field']] = $message;
780 }
Barry Mienydd671972010-10-04 16:33:58 +0200781
Derek Allard2067d1a2008-11-13 22:59:24 +0000782 return;
783 }
784 }
785 }
786
787 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200788
Derek Allard2067d1a2008-11-13 22:59:24 +0000789 /**
790 * Translate a field name
791 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000792 * @param string the field name
793 * @return string
Barry Mienydd671972010-10-04 16:33:58 +0200794 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +0100795 protected function _translate_fieldname($fieldname)
Derek Allard2067d1a2008-11-13 22:59:24 +0000796 {
797 // Do we need to translate the field name?
798 // We look for the prefix lang: to determine this
Andrey Andreev901573c2012-01-11 01:40:48 +0200799 if (strpos($fieldname, 'lang:') === 0)
Derek Allard2067d1a2008-11-13 22:59:24 +0000800 {
801 // Grab the variable
Barry Mienydd671972010-10-04 16:33:58 +0200802 $line = substr($fieldname, 5);
803
Derek Jones37f4b9c2011-07-01 17:56:50 -0500804 // Were we able to translate the field name? If not we use $line
Derek Allard2067d1a2008-11-13 22:59:24 +0000805 if (FALSE === ($fieldname = $this->CI->lang->line($line)))
806 {
807 return $line;
808 }
809 }
810
811 return $fieldname;
812 }
813
814 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200815
Derek Allard2067d1a2008-11-13 22:59:24 +0000816 /**
817 * Get the value from a form
818 *
819 * Permits you to repopulate a form field with the value it was submitted
820 * with, or, if that value doesn't exist, with the default
821 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000822 * @param string the field name
823 * @param string
Andrey Andreev46ac8812012-02-28 14:32:54 +0200824 * @return string
Barry Mienydd671972010-10-04 16:33:58 +0200825 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +0100826 public function set_value($field = '', $default = '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000827 {
Andrey Andreev46ac8812012-02-28 14:32:54 +0200828 if ( ! isset($this->_field_data[$field], $this->_field_data[$field]['postdata']))
Derek Allard2067d1a2008-11-13 22:59:24 +0000829 {
830 return $default;
831 }
Barry Mienydd671972010-10-04 16:33:58 +0200832
Phil Sturgeon5c561802011-01-05 16:31:59 +0000833 // If the data is an array output them one at a time.
Greg Aker03abee32011-12-25 00:31:29 -0600834 // E.g: form_input('name[]', set_value('name[]');
Phil Sturgeon5c561802011-01-05 16:31:59 +0000835 if (is_array($this->_field_data[$field]['postdata']))
836 {
837 return array_shift($this->_field_data[$field]['postdata']);
838 }
Phil Sturgeonc3828712011-01-19 12:31:47 +0000839
Derek Allard2067d1a2008-11-13 22:59:24 +0000840 return $this->_field_data[$field]['postdata'];
841 }
Barry Mienydd671972010-10-04 16:33:58 +0200842
Derek Allard2067d1a2008-11-13 22:59:24 +0000843 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200844
Derek Allard2067d1a2008-11-13 22:59:24 +0000845 /**
846 * Set Select
847 *
848 * Enables pull-down lists to be set to the value the user
849 * selected in the event of an error
850 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000851 * @param string
852 * @param string
Timothy Warren0688ac92012-04-20 10:25:04 -0400853 * @param bool
Derek Allard2067d1a2008-11-13 22:59:24 +0000854 * @return string
Barry Mienydd671972010-10-04 16:33:58 +0200855 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +0100856 public function set_select($field = '', $value = '', $default = FALSE)
Barry Mienydd671972010-10-04 16:33:58 +0200857 {
Andrey Andreev46ac8812012-02-28 14:32:54 +0200858 if ( ! isset($this->_field_data[$field], $this->_field_data[$field]['postdata']))
Derek Allard2067d1a2008-11-13 22:59:24 +0000859 {
Andrey Andreev6de924c2012-01-20 13:18:18 +0200860 return ($default === TRUE && count($this->_field_data) === 0) ? ' selected="selected"' : '';
Derek Allard2067d1a2008-11-13 22:59:24 +0000861 }
Barry Mienydd671972010-10-04 16:33:58 +0200862
Derek Allard2067d1a2008-11-13 22:59:24 +0000863 $field = $this->_field_data[$field]['postdata'];
Derek Allard2067d1a2008-11-13 22:59:24 +0000864 if (is_array($field))
865 {
866 if ( ! in_array($value, $field))
867 {
868 return '';
869 }
870 }
Alex Bilbied261b1e2012-06-02 11:12:16 +0100871 elseif (($field === '' OR $value === '') OR ($field !== $value))
Derek Allard2067d1a2008-11-13 22:59:24 +0000872 {
Andrey Andreev901573c2012-01-11 01:40:48 +0200873 return '';
Derek Allard2067d1a2008-11-13 22:59:24 +0000874 }
Barry Mienydd671972010-10-04 16:33:58 +0200875
Derek Allard2067d1a2008-11-13 22:59:24 +0000876 return ' selected="selected"';
877 }
Barry Mienydd671972010-10-04 16:33:58 +0200878
Derek Allard2067d1a2008-11-13 22:59:24 +0000879 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200880
Derek Allard2067d1a2008-11-13 22:59:24 +0000881 /**
882 * Set Radio
883 *
884 * Enables radio buttons to be set to the value the user
885 * selected in the event of an error
886 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000887 * @param string
888 * @param string
Timothy Warren0688ac92012-04-20 10:25:04 -0400889 * @param bool
Derek Allard2067d1a2008-11-13 22:59:24 +0000890 * @return string
Barry Mienydd671972010-10-04 16:33:58 +0200891 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +0100892 public function set_radio($field = '', $value = '', $default = FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000893 {
Andrey Andreev46ac8812012-02-28 14:32:54 +0200894 if ( ! isset($this->_field_data[$field], $this->_field_data[$field]['postdata']))
Derek Allard2067d1a2008-11-13 22:59:24 +0000895 {
Andrey Andreev6de924c2012-01-20 13:18:18 +0200896 return ($default === TRUE && count($this->_field_data) === 0) ? ' checked="checked"' : '';
Derek Allard2067d1a2008-11-13 22:59:24 +0000897 }
Barry Mienydd671972010-10-04 16:33:58 +0200898
Derek Allard2067d1a2008-11-13 22:59:24 +0000899 $field = $this->_field_data[$field]['postdata'];
Derek Allard2067d1a2008-11-13 22:59:24 +0000900 if (is_array($field))
901 {
902 if ( ! in_array($value, $field))
903 {
904 return '';
905 }
906 }
Alex Bilbied261b1e2012-06-02 11:12:16 +0100907 elseif (($field === '' OR $value === '') OR ($field !== $value))
Derek Allard2067d1a2008-11-13 22:59:24 +0000908 {
Andrey Andreev901573c2012-01-11 01:40:48 +0200909 return '';
Derek Allard2067d1a2008-11-13 22:59:24 +0000910 }
Barry Mienydd671972010-10-04 16:33:58 +0200911
Derek Allard2067d1a2008-11-13 22:59:24 +0000912 return ' checked="checked"';
913 }
Barry Mienydd671972010-10-04 16:33:58 +0200914
Derek Allard2067d1a2008-11-13 22:59:24 +0000915 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200916
Derek Allard2067d1a2008-11-13 22:59:24 +0000917 /**
918 * Set Checkbox
919 *
920 * Enables checkboxes to be set to the value the user
921 * selected in the event of an error
922 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000923 * @param string
924 * @param string
Timothy Warren0688ac92012-04-20 10:25:04 -0400925 * @param bool
Derek Allard2067d1a2008-11-13 22:59:24 +0000926 * @return string
Barry Mienydd671972010-10-04 16:33:58 +0200927 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +0100928 public function set_checkbox($field = '', $value = '', $default = FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000929 {
Andrey Andreev8dc532d2011-12-24 17:57:54 +0200930 // Logic is exactly the same as for radio fields
931 return $this->set_radio($field, $value, $default);
Derek Allard2067d1a2008-11-13 22:59:24 +0000932 }
Barry Mienydd671972010-10-04 16:33:58 +0200933
Derek Allard2067d1a2008-11-13 22:59:24 +0000934 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200935
Derek Allard2067d1a2008-11-13 22:59:24 +0000936 /**
937 * Required
938 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000939 * @param string
940 * @return bool
941 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +0100942 public function required($str)
Derek Allard2067d1a2008-11-13 22:59:24 +0000943 {
Andrey Andreev78f55772012-04-03 19:59:08 +0300944 return is_array($str) ? (bool) count($str) : (trim($str) !== '');
Derek Allard2067d1a2008-11-13 22:59:24 +0000945 }
Barry Mienydd671972010-10-04 16:33:58 +0200946
Derek Allard2067d1a2008-11-13 22:59:24 +0000947 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200948
Derek Allard2067d1a2008-11-13 22:59:24 +0000949 /**
Dan Horrigan2280e8e2010-12-15 10:16:38 -0500950 * Performs a Regular Expression match test.
951 *
Dan Horrigan2280e8e2010-12-15 10:16:38 -0500952 * @param string
Andrey Andreev78f55772012-04-03 19:59:08 +0300953 * @param string regex
Dan Horrigan2280e8e2010-12-15 10:16:38 -0500954 * @return bool
955 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +0100956 public function regex_match($str, $regex)
Dan Horrigan2280e8e2010-12-15 10:16:38 -0500957 {
Andrey Andreev8dc532d2011-12-24 17:57:54 +0200958 return (bool) preg_match($regex, $str);
Dan Horrigan2280e8e2010-12-15 10:16:38 -0500959 }
960
961 // --------------------------------------------------------------------
962
963 /**
Derek Allard2067d1a2008-11-13 22:59:24 +0000964 * Match one field to another
965 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000966 * @param string
Andrey Andreev78f55772012-04-03 19:59:08 +0300967 * @param string field
Derek Allard2067d1a2008-11-13 22:59:24 +0000968 * @return bool
969 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +0100970 public function matches($str, $field)
Derek Allard2067d1a2008-11-13 22:59:24 +0000971 {
Andrey Andreev78f55772012-04-03 19:59:08 +0300972 $validation_array = empty($this->validation_data) ? $_POST : $this->validation_data;
Barry Mienydd671972010-10-04 16:33:58 +0200973
Andrey Andreev56454792012-05-17 14:32:19 +0300974 return isset($validation_array[$field]) ? ($str === $validation_array[$field]) : FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +0000975 }
Eric Barnescccde962011-12-04 00:01:17 -0500976
Phil Sturgeon3837ae72011-05-09 21:12:26 +0100977 // --------------------------------------------------------------------
978
979 /**
Andrey Andreevd09d6502012-01-03 06:38:33 +0200980 * Is Unique
Phil Sturgeon3837ae72011-05-09 21:12:26 +0100981 *
Andrey Andreevd09d6502012-01-03 06:38:33 +0200982 * Check if the input value doesn't already exist
983 * in the specified database field.
984 *
Phil Sturgeon3837ae72011-05-09 21:12:26 +0100985 * @param string
Andrey Andreev78f55772012-04-03 19:59:08 +0300986 * @param string field
Phil Sturgeon3837ae72011-05-09 21:12:26 +0100987 * @return bool
988 */
989 public function is_unique($str, $field)
990 {
Eric Barnescccde962011-12-04 00:01:17 -0500991 list($table, $field) = explode('.', $field);
992 if (isset($this->CI->db))
993 {
994 $query = $this->CI->db->limit(1)->get_where($table, array($field => $str));
995 return $query->num_rows() === 0;
996 }
997 return FALSE;
Greg Aker03abee32011-12-25 00:31:29 -0600998 }
Barry Mienydd671972010-10-04 16:33:58 +0200999
Derek Allard2067d1a2008-11-13 22:59:24 +00001000 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +02001001
Derek Allard2067d1a2008-11-13 22:59:24 +00001002 /**
1003 * Minimum Length
1004 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001005 * @param string
Michiel Vugteveena8221ad2012-06-14 23:26:34 +02001006 * @param string
Derek Allard2067d1a2008-11-13 22:59:24 +00001007 * @return bool
Barry Mienydd671972010-10-04 16:33:58 +02001008 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +01001009 public function min_length($str, $val)
Derek Allard2067d1a2008-11-13 22:59:24 +00001010 {
Michiel Vugteveenceaf8872012-06-15 11:56:24 +02001011 if ( ! is_numeric($val))
Derek Allard2067d1a2008-11-13 22:59:24 +00001012 {
1013 return FALSE;
1014 }
Michiel Vugteveenceaf8872012-06-15 11:56:24 +02001015 else
1016 {
1017 $val = (int) $val;
1018 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001019
Andrey Andreev78f55772012-04-03 19:59:08 +03001020 return (MB_ENABLED === TRUE)
Michiel Vugteveenceaf8872012-06-15 11:56:24 +02001021 ? ($val <= mb_strlen($str))
1022 : ($val <= strlen($str));
Derek Allard2067d1a2008-11-13 22:59:24 +00001023 }
Barry Mienydd671972010-10-04 16:33:58 +02001024
Derek Allard2067d1a2008-11-13 22:59:24 +00001025 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +02001026
Derek Allard2067d1a2008-11-13 22:59:24 +00001027 /**
1028 * Max Length
1029 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001030 * @param string
Michiel Vugteveena8221ad2012-06-14 23:26:34 +02001031 * @param string
Derek Allard2067d1a2008-11-13 22:59:24 +00001032 * @return bool
Barry Mienydd671972010-10-04 16:33:58 +02001033 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +01001034 public function max_length($str, $val)
Derek Allard2067d1a2008-11-13 22:59:24 +00001035 {
Michiel Vugteveenceaf8872012-06-15 11:56:24 +02001036 if ( ! is_numeric($val))
Derek Allard2067d1a2008-11-13 22:59:24 +00001037 {
1038 return FALSE;
1039 }
Michiel Vugteveenceaf8872012-06-15 11:56:24 +02001040 else
1041 {
1042 $val = (int) $val;
1043 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001044
Andrey Andreev78f55772012-04-03 19:59:08 +03001045 return (MB_ENABLED === TRUE)
Michiel Vugteveenceaf8872012-06-15 11:56:24 +02001046 ? ($val >= mb_strlen($str))
1047 : ($val >= strlen($str));
Derek Allard2067d1a2008-11-13 22:59:24 +00001048 }
Barry Mienydd671972010-10-04 16:33:58 +02001049
Derek Allard2067d1a2008-11-13 22:59:24 +00001050 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +02001051
Derek Allard2067d1a2008-11-13 22:59:24 +00001052 /**
1053 * Exact Length
1054 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001055 * @param string
Michiel Vugteveeneccde132012-06-14 23:22:26 +02001056 * @param string
Derek Allard2067d1a2008-11-13 22:59:24 +00001057 * @return bool
Barry Mienydd671972010-10-04 16:33:58 +02001058 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +01001059 public function exact_length($str, $val)
Derek Allard2067d1a2008-11-13 22:59:24 +00001060 {
Michiel Vugteveenceaf8872012-06-15 11:56:24 +02001061 if ( ! is_numeric($val))
Derek Allard2067d1a2008-11-13 22:59:24 +00001062 {
1063 return FALSE;
1064 }
Michiel Vugteveenceaf8872012-06-15 11:56:24 +02001065 else
1066 {
1067 $val = (int) $val;
1068 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001069
Andrey Andreev78f55772012-04-03 19:59:08 +03001070 return (MB_ENABLED === TRUE)
Michiel Vugteveenceaf8872012-06-15 11:56:24 +02001071 ? (mb_strlen($str) === $val)
1072 : (strlen($str) === $val);
Derek Allard2067d1a2008-11-13 22:59:24 +00001073 }
Barry Mienydd671972010-10-04 16:33:58 +02001074
Derek Allard2067d1a2008-11-13 22:59:24 +00001075 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +02001076
Derek Allard2067d1a2008-11-13 22:59:24 +00001077 /**
1078 * Valid Email
1079 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001080 * @param string
1081 * @return bool
Barry Mienydd671972010-10-04 16:33:58 +02001082 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +01001083 public function valid_email($str)
Derek Allard2067d1a2008-11-13 22:59:24 +00001084 {
Andrey Andreev580388b2012-06-27 15:43:46 +03001085 return (bool) filter_var($str, FILTER_VALIDATE_EMAIL);
Derek Allard2067d1a2008-11-13 22:59:24 +00001086 }
1087
1088 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +02001089
Derek Allard2067d1a2008-11-13 22:59:24 +00001090 /**
1091 * Valid Emails
1092 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001093 * @param string
1094 * @return bool
Barry Mienydd671972010-10-04 16:33:58 +02001095 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +01001096 public function valid_emails($str)
Derek Allard2067d1a2008-11-13 22:59:24 +00001097 {
1098 if (strpos($str, ',') === FALSE)
1099 {
1100 return $this->valid_email(trim($str));
1101 }
Barry Mienydd671972010-10-04 16:33:58 +02001102
Pascal Kriete14287f32011-02-14 13:39:34 -05001103 foreach (explode(',', $str) as $email)
Derek Allard2067d1a2008-11-13 22:59:24 +00001104 {
Andrey Andreev8dc532d2011-12-24 17:57:54 +02001105 if (trim($email) !== '' && $this->valid_email(trim($email)) === FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +00001106 {
1107 return FALSE;
1108 }
1109 }
Barry Mienydd671972010-10-04 16:33:58 +02001110
Derek Allard2067d1a2008-11-13 22:59:24 +00001111 return TRUE;
1112 }
1113
1114 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +02001115
Derek Allard2067d1a2008-11-13 22:59:24 +00001116 /**
1117 * Validate IP Address
1118 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001119 * @param string
Andrey Andreev5a257182012-06-10 06:18:14 +03001120 * @param string 'ipv4' or 'ipv6' to validate a specific IP format
Bo-Yi Wu013c8952011-09-12 15:03:44 +08001121 * @return bool
Derek Allard2067d1a2008-11-13 22:59:24 +00001122 */
Andrey Andreev5a257182012-06-10 06:18:14 +03001123 public function valid_ip($ip, $which = '')
Derek Allard2067d1a2008-11-13 22:59:24 +00001124 {
Andrey Andreev5a257182012-06-10 06:18:14 +03001125 return $this->CI->input->valid_ip($ip, $which);
Derek Allard2067d1a2008-11-13 22:59:24 +00001126 }
1127
1128 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +02001129
Derek Allard2067d1a2008-11-13 22:59:24 +00001130 /**
1131 * Alpha
1132 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001133 * @param string
1134 * @return bool
Barry Mienydd671972010-10-04 16:33:58 +02001135 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +01001136 public function alpha($str)
Derek Allard2067d1a2008-11-13 22:59:24 +00001137 {
Andrey Andreevacb962e2012-06-27 12:04:24 +03001138 return ctype_alpha($str);
Derek Allard2067d1a2008-11-13 22:59:24 +00001139 }
Barry Mienydd671972010-10-04 16:33:58 +02001140
Derek Allard2067d1a2008-11-13 22:59:24 +00001141 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +02001142
Derek Allard2067d1a2008-11-13 22:59:24 +00001143 /**
1144 * Alpha-numeric
1145 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001146 * @param string
1147 * @return bool
Barry Mienydd671972010-10-04 16:33:58 +02001148 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +01001149 public function alpha_numeric($str)
Derek Allard2067d1a2008-11-13 22:59:24 +00001150 {
Andrey Andreevacb962e2012-06-27 12:04:24 +03001151 return ctype_alnum((string) $str);
Derek Allard2067d1a2008-11-13 22:59:24 +00001152 }
Barry Mienydd671972010-10-04 16:33:58 +02001153
Derek Allard2067d1a2008-11-13 22:59:24 +00001154 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +02001155
Derek Allard2067d1a2008-11-13 22:59:24 +00001156 /**
1157 * Alpha-numeric with underscores and dashes
1158 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001159 * @param string
1160 * @return bool
Barry Mienydd671972010-10-04 16:33:58 +02001161 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +01001162 public function alpha_dash($str)
Derek Allard2067d1a2008-11-13 22:59:24 +00001163 {
Andrey Andreev8dc532d2011-12-24 17:57:54 +02001164 return (bool) preg_match('/^[a-z0-9_-]+$/i', $str);
Derek Allard2067d1a2008-11-13 22:59:24 +00001165 }
Barry Mienydd671972010-10-04 16:33:58 +02001166
Derek Allard2067d1a2008-11-13 22:59:24 +00001167 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +02001168
Derek Allard2067d1a2008-11-13 22:59:24 +00001169 /**
1170 * Numeric
1171 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001172 * @param string
1173 * @return bool
Barry Mienydd671972010-10-04 16:33:58 +02001174 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +01001175 public function numeric($str)
Derek Allard2067d1a2008-11-13 22:59:24 +00001176 {
Andrey Andreev8dc532d2011-12-24 17:57:54 +02001177 return (bool) preg_match('/^[\-+]?[0-9]*\.?[0-9]+$/', $str);
Derek Allard2067d1a2008-11-13 22:59:24 +00001178
1179 }
1180
1181 // --------------------------------------------------------------------
1182
Barry Mienydd671972010-10-04 16:33:58 +02001183 /**
Derek Allard2067d1a2008-11-13 22:59:24 +00001184 * Integer
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 integer($str)
Derek Allard2067d1a2008-11-13 22:59:24 +00001190 {
Phil Sturgeonef112c02011-02-07 13:01:47 +00001191 return (bool) preg_match('/^[\-+]?[0-9]+$/', $str);
1192 }
1193
1194 // --------------------------------------------------------------------
1195
1196 /**
1197 * Decimal number
1198 *
Phil Sturgeonef112c02011-02-07 13:01:47 +00001199 * @param string
1200 * @return bool
1201 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +01001202 public function decimal($str)
Phil Sturgeonef112c02011-02-07 13:01:47 +00001203 {
1204 return (bool) preg_match('/^[\-+]?[0-9]+\.[0-9]+$/', $str);
1205 }
1206
1207 // --------------------------------------------------------------------
1208
1209 /**
Andrey Andreevc68905a2012-02-02 21:41:54 +02001210 * Greater than
Phil Sturgeonef112c02011-02-07 13:01:47 +00001211 *
Phil Sturgeonef112c02011-02-07 13:01:47 +00001212 * @param string
Timothy Warren0688ac92012-04-20 10:25:04 -04001213 * @param int
Phil Sturgeonef112c02011-02-07 13:01:47 +00001214 * @return bool
1215 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +01001216 public function greater_than($str, $min)
Phil Sturgeonef112c02011-02-07 13:01:47 +00001217 {
Andrey Andreev78f55772012-04-03 19:59:08 +03001218 return is_numeric($str) ? ($str > $min) : FALSE;
Phil Sturgeonef112c02011-02-07 13:01:47 +00001219 }
1220
1221 // --------------------------------------------------------------------
1222
1223 /**
Nick Busey98c347d2012-02-02 11:07:03 -07001224 * Equal to or Greater than
1225 *
Nick Busey98c347d2012-02-02 11:07:03 -07001226 * @param string
Timothy Warren0688ac92012-04-20 10:25:04 -04001227 * @param int
Nick Busey98c347d2012-02-02 11:07:03 -07001228 * @return bool
1229 */
Andrey Andreev3b2c5082012-03-07 22:49:24 +02001230 public function greater_than_equal_to($str, $min)
Nick Busey98c347d2012-02-02 11:07:03 -07001231 {
Andrey Andreev78f55772012-04-03 19:59:08 +03001232 return is_numeric($str) ? ($str >= $min) : FALSE;
Nick Busey98c347d2012-02-02 11:07:03 -07001233 }
1234
1235 // --------------------------------------------------------------------
Phil Sturgeonef112c02011-02-07 13:01:47 +00001236
1237 /**
1238 * Less than
1239 *
Phil Sturgeonef112c02011-02-07 13:01:47 +00001240 * @param string
Timothy Warren0688ac92012-04-20 10:25:04 -04001241 * @param int
Phil Sturgeonef112c02011-02-07 13:01:47 +00001242 * @return bool
1243 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +01001244 public function less_than($str, $max)
Phil Sturgeonef112c02011-02-07 13:01:47 +00001245 {
Andrey Andreev78f55772012-04-03 19:59:08 +03001246 return is_numeric($str) ? ($str < $max) : FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +00001247 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001248
1249 // --------------------------------------------------------------------
1250
Barry Mienydd671972010-10-04 16:33:58 +02001251 /**
Nick Busey98c347d2012-02-02 11:07:03 -07001252 * Equal to or Less than
1253 *
Nick Busey98c347d2012-02-02 11:07:03 -07001254 * @param string
Timothy Warren0688ac92012-04-20 10:25:04 -04001255 * @param int
Nick Busey98c347d2012-02-02 11:07:03 -07001256 * @return bool
1257 */
Andrey Andreev3b2c5082012-03-07 22:49:24 +02001258 public function less_than_equal_to($str, $max)
Nick Busey98c347d2012-02-02 11:07:03 -07001259 {
Andrey Andreev78f55772012-04-03 19:59:08 +03001260 return is_numeric($str) ? ($str <= $max) : FALSE;
Nick Busey98c347d2012-02-02 11:07:03 -07001261 }
1262
1263 // --------------------------------------------------------------------
1264
1265 /**
Derek Jones37f4b9c2011-07-01 17:56:50 -05001266 * Is a Natural number (0,1,2,3, etc.)
Barry Mienydd671972010-10-04 16:33:58 +02001267 *
Barry Mienydd671972010-10-04 16:33:58 +02001268 * @param string
1269 * @return bool
1270 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +01001271 public function is_natural($str)
Barry Mienydd671972010-10-04 16:33:58 +02001272 {
Andrey Andreevacb962e2012-06-27 12:04:24 +03001273 return ctype_digit((string) $str);
Barry Mienydd671972010-10-04 16:33:58 +02001274 }
1275
1276 // --------------------------------------------------------------------
1277
1278 /**
Derek Jones37f4b9c2011-07-01 17:56:50 -05001279 * Is a Natural number, but not a zero (1,2,3, etc.)
Barry Mienydd671972010-10-04 16:33:58 +02001280 *
Barry Mienydd671972010-10-04 16:33:58 +02001281 * @param string
1282 * @return bool
1283 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +01001284 public function is_natural_no_zero($str)
Barry Mienydd671972010-10-04 16:33:58 +02001285 {
Andrey Andreevacb962e2012-06-27 12:04:24 +03001286 return ($str != 0 && ctype_digit((string) $str));
Barry Mienydd671972010-10-04 16:33:58 +02001287 }
1288
Derek Allard2067d1a2008-11-13 22:59:24 +00001289 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +02001290
Derek Allard2067d1a2008-11-13 22:59:24 +00001291 /**
1292 * Valid Base64
1293 *
1294 * Tests a string for characters outside of the Base64 alphabet
1295 * as defined by RFC 2045 http://www.faqs.org/rfcs/rfc2045
1296 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001297 * @param string
1298 * @return bool
1299 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +01001300 public function valid_base64($str)
Derek Allard2067d1a2008-11-13 22:59:24 +00001301 {
Andrey Andreev56454792012-05-17 14:32:19 +03001302 return ! preg_match('/[^a-zA-Z0-9\/\+=]/', $str);
Derek Allard2067d1a2008-11-13 22:59:24 +00001303 }
Barry Mienydd671972010-10-04 16:33:58 +02001304
Derek Allard2067d1a2008-11-13 22:59:24 +00001305 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +02001306
Derek Allard2067d1a2008-11-13 22:59:24 +00001307 /**
1308 * Prep data for form
1309 *
1310 * This function allows HTML to be safely shown in a form.
1311 * Special characters are converted.
1312 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001313 * @param string
1314 * @return string
1315 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +01001316 public function prep_for_form($data = '')
Derek Allard2067d1a2008-11-13 22:59:24 +00001317 {
1318 if (is_array($data))
1319 {
1320 foreach ($data as $key => $val)
1321 {
1322 $data[$key] = $this->prep_for_form($val);
1323 }
Barry Mienydd671972010-10-04 16:33:58 +02001324
Derek Allard2067d1a2008-11-13 22:59:24 +00001325 return $data;
1326 }
Barry Mienydd671972010-10-04 16:33:58 +02001327
Alex Bilbied261b1e2012-06-02 11:12:16 +01001328 if ($this->_safe_form_data === FALSE OR $data === '')
Derek Allard2067d1a2008-11-13 22:59:24 +00001329 {
1330 return $data;
1331 }
1332
Andrey Andreev901573c2012-01-11 01:40:48 +02001333 return str_replace(array("'", '"', '<', '>'), array('&#39;', '&quot;', '&lt;', '&gt;'), stripslashes($data));
Derek Allard2067d1a2008-11-13 22:59:24 +00001334 }
Barry Mienydd671972010-10-04 16:33:58 +02001335
Derek Allard2067d1a2008-11-13 22:59:24 +00001336 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +02001337
Derek Allard2067d1a2008-11-13 22:59:24 +00001338 /**
1339 * Prep URL
1340 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001341 * @param string
1342 * @return string
Barry Mienydd671972010-10-04 16:33:58 +02001343 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +01001344 public function prep_url($str = '')
Derek Allard2067d1a2008-11-13 22:59:24 +00001345 {
Alex Bilbied261b1e2012-06-02 11:12:16 +01001346 if ($str === 'http://' OR $str === '')
Derek Allard2067d1a2008-11-13 22:59:24 +00001347 {
1348 return '';
1349 }
Barry Mienydd671972010-10-04 16:33:58 +02001350
Andrey Andreev901573c2012-01-11 01:40:48 +02001351 if (strpos($str, 'http://') !== 0 && strpos($str, 'https://') !== 0)
Derek Allard2067d1a2008-11-13 22:59:24 +00001352 {
Andrey Andreev901573c2012-01-11 01:40:48 +02001353 return 'http://'.$str;
Derek Allard2067d1a2008-11-13 22:59:24 +00001354 }
Barry Mienydd671972010-10-04 16:33:58 +02001355
Derek Allard2067d1a2008-11-13 22:59:24 +00001356 return $str;
1357 }
Barry Mienydd671972010-10-04 16:33:58 +02001358
Derek Allard2067d1a2008-11-13 22:59:24 +00001359 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +02001360
Derek Allard2067d1a2008-11-13 22:59:24 +00001361 /**
1362 * Strip Image Tags
1363 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001364 * @param string
1365 * @return string
Barry Mienydd671972010-10-04 16:33:58 +02001366 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +01001367 public function strip_image_tags($str)
Derek Allard2067d1a2008-11-13 22:59:24 +00001368 {
Andrey Andreev1a24a9d2012-06-27 00:52:47 +03001369 return $this->CI->security->strip_image_tags($str);
Derek Allard2067d1a2008-11-13 22:59:24 +00001370 }
Barry Mienydd671972010-10-04 16:33:58 +02001371
Derek Allard2067d1a2008-11-13 22:59:24 +00001372 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +02001373
Derek Allard2067d1a2008-11-13 22:59:24 +00001374 /**
1375 * XSS Clean
1376 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001377 * @param string
1378 * @return string
Barry Mienydd671972010-10-04 16:33:58 +02001379 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +01001380 public function xss_clean($str)
Derek Allard2067d1a2008-11-13 22:59:24 +00001381 {
Derek Jones5640a712010-04-23 11:22:40 -05001382 return $this->CI->security->xss_clean($str);
Derek Allard2067d1a2008-11-13 22:59:24 +00001383 }
Barry Mienydd671972010-10-04 16:33:58 +02001384
Derek Allard2067d1a2008-11-13 22:59:24 +00001385 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +02001386
Derek Allard2067d1a2008-11-13 22:59:24 +00001387 /**
1388 * Convert PHP tags to entities
1389 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001390 * @param string
1391 * @return string
Barry Mienydd671972010-10-04 16:33:58 +02001392 */
Phil Sturgeon3837ae72011-05-09 21:12:26 +01001393 public function encode_php_tags($str)
Derek Allard2067d1a2008-11-13 22:59:24 +00001394 {
Andrey Andreeve446ad32012-06-15 15:23:41 +03001395 return str_replace(array('<?', '?>'), array('&lt;?', '?&gt;'), $str);
Derek Allard2067d1a2008-11-13 22:59:24 +00001396 }
1397
JonoB099c4782012-03-04 14:37:30 +00001398 // --------------------------------------------------------------------
Andrey Andreevc8da4fe2012-03-04 19:20:33 +02001399
1400 /**
1401 * Reset validation vars
1402 *
1403 * Prevents subsequent validation routines from being affected by the
JonoB099c4782012-03-04 14:37:30 +00001404 * results of any previous validation routine due to the CI singleton.
Andrey Andreevc8da4fe2012-03-04 19:20:33 +02001405 *
Andrey Andreev3b2c5082012-03-07 22:49:24 +02001406 * @return void
Andrey Andreevc8da4fe2012-03-04 19:20:33 +02001407 */
JonoB883f80f2012-03-05 09:51:27 +00001408 public function reset_validation()
Andrey Andreevc8da4fe2012-03-04 19:20:33 +02001409 {
JonoB099c4782012-03-04 14:37:30 +00001410 $this->_field_data = array();
1411 $this->_config_rules = array();
1412 $this->_error_array = array();
1413 $this->_error_messages = array();
1414 $this->error_string = '';
Andrey Andreevc8da4fe2012-03-04 19:20:33 +02001415 }
1416
Derek Allard2067d1a2008-11-13 22:59:24 +00001417}
Derek Allard2067d1a2008-11-13 22:59:24 +00001418
1419/* End of file Form_validation.php */
Andrey Andreev31cf46e2012-03-20 15:48:00 +02001420/* Location: ./system/libraries/Form_validation.php */