Blame - user_guide/libraries/form_validation.html - code-igniter-v3-giggi

<td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="codeigniter.com/user_guide/" />Search User Guide  <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" /> <input type="submit" class="submit" name="sa" value="Go" /></form></td>

47

</tr>

48

</table>

49

55

56

57

<h1>Form Validation</h1>

58

59

<p>CodeIgniter provides a comprehensive form validation and data prepping class that helps minimize the amount of code you'll write.</p>

60

61

<p class="important"><strong>Note:</strong>  As of CodeIgniter 1.6.4, this Form Validation class supercedes the old Validation class, which is now deprecated. We

62

have left the old class in the library so applications currently using it will not break, but you are encouraged to migrate to this new version.</p>

63

64

<ul>

65

<li><a href="#overview">Overview</a></li>

66

<li><a href="#tutorial">Form Validation Tutorial</a>

<ul>

<li><a href="#thesuccesspage">The Success Page</a></li>

71

<li><a href="#thecontroller">The Controller</a></li>

72

<li><a href="#validationrules">Setting Validation Rules</a></li>

73

<li><a href="#validationrulesasarray">Setting Validation Rules Using an Array</a></li>

74

<li><a href="#cascadingrules">Cascading Rules</a></li>

75

<li><a href="#preppingdata">Prepping Data</a></li>

76

<li><a href="#repopulatingform">Re-populating the Form</a></li>

77

<li><a href="#callbacks">Callbacks</a></li>

78

<li><a href="#settingerrors">Setting Error Messages</a></li>

79

<li><a href="#errordelimiters">Changing the Error Delimiters</a></li>

80

<li><a href="#individualerrors">Showing Errors Individually</a></li>

81

<li><a href="#savingtoconfig">Saving Sets of Validation Rules to a Config File</a></li>

Rick Ellis

66bc2ad

2008-08-26 20:18:17 +0000

[diff] [blame^]

82

<li><a href="#arraysasfields">Using Arrays as Field Names</a></li>

Rick Ellis

2594953

2008-08-26 19:48:08 +0000

[diff] [blame]

83

</ul>

84

</li>

85

<li><a href="#rulereference">Rule Reference</a></li>

86

<li><a href="#preppingreference">Prepping Reference</a></li>

87

<li><a href="#functionreference">Function Reference</a></li>

88

<li><a href="#helperreference">Helper Reference</a></li>

</ul>

<h1>Overview</h1>

<p>Before explaining CodeIgniter's approach to data validation, let's describe the ideal scenario:</p>

104

105

<ol>

106

<li>A form is displayed.</li>

107

<li>You fill it in and submit it.</li>

108

<li>If you submitted something invalid, or perhaps missed a required item, the form is redisplayed containing your data

109

along with an error message describing the problem.</li>

110

<li>This process continues until you have submitted a valid form.</li>

111

</ol>

112

113

<p>On the receiving end, the script must:</p>

114

115

<ol>

116

<li>Check for required data.</li>

117

<li>Verify that the data is of the correct type, and meets the correct criteria. For example, if a username is submitted

118

it must be validated to contain only permitted characters. It must be of a minimum length,

119

and not exceed a maximum length. The username can't be someone else's existing username, or perhaps even a reserved word. Etc.</li>

120

<li>Sanitize the data for security.</li>

121

<li>Pre-format the data if needed (Does the data need to be trimmed? HTML encoded? Etc.)</li>

122

<li>Prep the data for insertion in the database.</li>

</ol>

<p>Although there is nothing terribly complex about the above process, it usually requires a significant

127

amount of code, and to display error messages, various control structures are usually placed within the form HTML.

128

Form validation, while simple to create, is generally very messy and tedious to implement.</p>

<h1>Form Validation Tutorial</h1>

135

136

<p>What follows is a "hands on" tutorial for implementing CodeIgniters Form Validation.</p>

137

138

139

<p>In order to implement form validation you'll need three things:</p>

140

141

<ol>

142

<li>A <a href="../general/views.html">View</a> file containing a form.</li>

143

<li>A View file containing a "success" message to be displayed upon successful submission.</li>

144

<li>A <a href="../general/controllers.html">controller</a> function to receive and process the submitted data.</li>

145

</ol>

146

147

<p>Let's create those three things, using a member sign-up form as the example.</p>

<p>Using a text editor, create a form called <dfn>myform.php</dfn>. In it, place this code and save it to your <samp>applications/views/</samp>

folder:</p>

<head>

</head>

<body>

<?php echo validation_errors(); ?>

166

167

<?php echo form_open('form'); ?>

<h5>Username</h5>

<h5>Password</h5>

<h5>Password Confirm</h5>

176

177

178

<h5>Email Address</h5>

</form>

</body>

</html>

</textarea>

<h2>The Success Page</h2>

194

195

196

<p>Using a text editor, create a form called <dfn>formsuccess.php</dfn>. In it, place this code and save it to your <samp>applications/views/</samp>

folder:</p>

<html>

<head>

</head>

<body>

<h3>Your form was successfully submitted!</h3>

</body>

</html>

</textarea>

<h2>The Controller</h2>

219

220

<p>Using a text editor, create a controller called <dfn>form.php</dfn>. In it, place this code and save it to your <samp>applications/controllers/</samp>

folder:</p>

<textarea class="textarea" style="width:100%" cols="50" rows="21"><?php

225

226

class Form extends Controller {

function index()

{

$this->load->helper(array('form', 'url'));

231

232

$this->load->library('form_validation');

233

234

if ($this->form_validation->run() == FALSE)

235

{

236

$this->load->view('myform');

}

else

{

$this->load->view('formsuccess');

}

}

}

?></textarea>

<p>To try your form, visit your site using a URL similar to this one:</p>

250

251

<code>example.com/index.php/<var>form</var>/</code>

252

253

<p><dfn>If you submit the form you should simply see the form reload. That's because you haven't set up any validation

254

rules yet.</dfn></p>

255

256

<p><strong>Since you haven't told the Form Validation class to validate anything yet, it returns <kbd>FALSE</kbd> (boolean false) by default. The <samp>run()</samp>

257

function only returns <kbd>TRUE</kbd> if it has successfully applied your rules without any of them failing.</strong></p>

<h2>Explanation</h2>

<p>You'll notice several things about the above pages:</p>

263

264

<p>The <dfn>form</dfn> (myform.php) is a standard web form with a couple exceptions:</p>

265

266

<ol>

267

<li>It uses a <dfn>form helper</dfn> to create the form opening.

268

Technically, this isn't necessary. You could create the form using standard HTML. However, the benefit of using the helper

269

is that it generates the action URL for you, based on the URL in your config file. This makes your application more portable in the event your URLs change.</li>

270

271

<li>At the top of the form you'll notice the following function call:

272

273

274

<p>This function will return any error messages sent back by the validator. If there are no messages it returns an empty string.</p>

</li>

</ol>

<p>The <dfn>controller</dfn> (form.php) has one function: <dfn>index()</dfn>. This function initializes the validation class and

279

loads the <var>form helper</var> and <var>URL helper</var> used by your view files. It also <samp>runs</samp>

280

the validation routine. Based on

281

whether the validation was successful it either presents the form or the success page.</p>

<h2>Setting Validation Rules</h2>

289

290

<p>CodeIgniter lets you set as many validation rules as you need for a given field, cascading them in order, and it even lets you prep and pre-process the field data

291

at the same time. To set validation rules you will use the <dfn>set_rules()</dfn> function:</p>

292

293

<code>$this->form_validation->set_rules();</code>

294

295

<p>The above function takes <srong>three</strong> parameters as input:</p>

296

297

<ol>

298

<li>The field name - the exact name you've given the form field.</li>

299

<li>A "human" name for this field, which will be inserted into the error message. For example, if your field is named "user" you might give it a human name of "Username".</li>

300

<li>The validation rules for this form field.</li>

</ol>

<p><br />Here is an example. In your <dfn>controller</dfn> (form.php), add this code just below the validation initialization function:</p>

305

306

<code>

307

$this->form_validation->set_rules('username', 'Username', 'required');<br />

308

$this->form_validation->set_rules('password', 'Password', 'required');<br />

309

$this->form_validation->set_rules('passconf', 'Password Confirmation', 'required');<br />

310

$this->form_validation->set_rules('email', 'Email', 'required');<br />

311

</code>

312

313

<p>Your controller should now look like this:</p>

314

315

<textarea class="textarea" style="width:100%" cols="50" rows="28"><?php

316

317

class Form extends Controller {

function index()

{

$this->load->helper(array('form', 'url'));

322

323

$this->load->library('form_validation');

324

325

$this->form_validation->set_rules('username', 'Username', 'required');

326

$this->form_validation->set_rules('password', 'Password', 'required');

327

$this->form_validation->set_rules('passconf', 'Password Confirmation', 'required');

328

$this->form_validation->set_rules('email', 'Email', 'required');

329

330

if ($this->form_validation->run() == FALSE)

331

{

332

$this->load->view('myform');

}

else

{

$this->load->view('formsuccess');

}

}

}

?></textarea>

<p><dfn>Now submit the form with the fields blank and you should see the error messages.

343

If you submit the form with all the fields populated you'll see your success page.</dfn></p>

344

345

<p class="important"><strong>Note:</strong> The form fields are not yet being re-populated with the data when

346

there is an error. We'll get to that shortly.</p>

<h2>Setting Rules Using an Array</h2>

353

354

<p>Before moving on it should be noted that the rule setting function can be passed an array if you prefer to set all your rules in one action.

355

If you use this approach you must name your array keys as indicated:</p>

356

357

<code>

358

$config = array(<br />

359

               array(<br />

360

                     'field'   => 'username', <br />

361

                     'label'   => 'Username', <br />

362

                     'rules'   => 'required'<br />

363

                  ),<br />

364

               array(<br />

365

                     'field'   => 'password', <br />

366

                     'label'   => 'Password', <br />

367

                     'rules'   => 'required'<br />

368

                  ),<br />

369

               array(<br />

370

                     'field'   => 'passconf', <br />

371

                     'label'   => 'Password Confirmation', <br />

372

                     'rules'   => 'required'<br />

373

                  ),   <br />

374

               array(<br />

375

                     'field'   => 'email', <br />

376

                     'label'   => 'Email', <br />

377

                     'rules'   => 'required'<br />

378

                  )<br />

379

            );<br />

380

<br />

381

$this->form_validation->set_rules($config);

</code>

<h2>Cascading Rules</h2>

391

392

<p>CodeIgniter lets you pipe multiple rules together. Let's try it. Change your rules in the third parameter of rule setting function, like this:</p>

393

394

<code>

395

$this->form_validation->set_rules('username', 'Username', 'required|min_length[5]|max_length[12]');<br />

396

$this->form_validation->set_rules('password', 'Password', 'required|matches[passconf]');<br />

397

$this->form_validation->set_rules('passconf', 'Password Confirmation', 'required');<br />

398

$this->form_validation->set_rules('email', 'Email', 'required|valid_email');<br />

399

</code>

400

401

<p>The above code sets the following rules:</p>

402

403

<ol>

404

<li>The username field be no shorter than 5 characters and no longer than 12.</li>

405

<li>The password field must match the password confirmation field.</li>

406

<li>The email field must contain a valid email address.</li>

407

</ol>

408

409

<p>Give it a try! Submit your form without the proper data and you'll see new error messages that correspond to your new rules.

410

There are numerous rules available which you can read about in the validation reference.</p>

<h2>Prepping Data</h2>

416

417

<p>In addition to the validation functions like the ones we used above, you can also prep your data in various ways.

418

For example, you can set up rules like this:</p>

419

420

<code>

421

$this->form_validation->set_rules('username', 'Username', '<kbd>trim</kbd>|required|min_length[5]|max_length[12]|<kbd>xss_clean</kbd>');<br />

422

$this->form_validation->set_rules('password', 'Password', '<kbd>trim</kbd>|required|matches[passconf]|<kbd>md5</kbd>');<br />

423

$this->form_validation->set_rules('passconf', 'Password Confirmation', '<kbd>trim</kbd>|required');<br />

424

$this->form_validation->set_rules('email', 'Email', '<kbd>trim</kbd>|required|valid_email');<br />

</code>

<p>In the above example, we are "trimming" the fields, converting the password to MD5, and running the username through

429

the "xss_clean" function, which removes malicious data.</p>

430

431

<p><strong>Any native PHP function that accepts one parameter can be used as a rule, like <dfn>htmlspecialchars</dfn>,

432

433

434

<p><strong>Note:</strong> You will generally want to use the prepping functions <strong>after</strong>

435

the validation rules so if there is an error, the original data will be shown in the form.</p>

<h2>Re-populating the form</h2>

442

443

<p>Thus far we have only been dealing with errors. It's time to repopulate the form field with the submitted data. CodeIgniter offers several helper functions

444

that permit you to do this. The one you will use most commonly is:</p>

445

446

<code>set_value('field name')</code>

447

448

449

<p>Open your <dfn>myform.php</dfn> view file and update the <strong>value</strong> in each field using the <dfn>set_value()</dfn> function:</p>

450

451

<p><strong>Don't forget to include each. field name in the <dfn>set_value()</dfn> functions!</strong></p>

<html>

<head>

</head>

<body>

<?php echo validation_errors(); ?>

462

463

<?php echo form_open('form'); ?>

<h5>Username</h5>

<h5>Password</h5>

<h5>Password Confirm</h5>

472

473

474

<h5>Email Address</h5>

</form>

</body>

</html>

</textarea>

<p><dfn>Now reload your page and submit the form so that it triggers an error. Your form fields should now be re-populated</dfn></p>

487

488

<p class="important"><strong>Note:</strong> The <a href="#functionreference">Function Reference</a> section below contains functions that

489

permit you to re-populate <select> menus, radio buttons, and checkboxes.</p>

490

491

492

<p><strong>Important Note:</strong> If you use an array as the name of a form field, you must supply it as an array to the function. Example:</p>

493

494

<code><input type="text" name="<kbd>colors[]</kbd>" value="<?php echo set_value('<kbd>colors[]</kbd>'); ?>" size="50" /></code>

<h2>Callbacks: Your own Validation Functions</h2>

502

503

<p>The validation system supports callbacks to your own validation functions. This permits you to extend the validation class

504

to meet your needs. For example, if you need to run a database query to see if the user is choosing a unique username, you can

505

create a callback function that does that. Let's create a example of this.</p>

506

507

<p>In your controller, change the "username" rule to this:</p>

508

509

<code>$this->form_validation->set_rules('username', 'Username', '<kbd>callback_username_check</kbd>');</code>

510

511

512

<p>Then add a new function called <dfn>username_check</dfn> to your controller. Here's how your controller should now look:</p>

513

514

515

<textarea class="textarea" style="width:100%" cols="50" rows="44"><?php

516

517

class Form extends Controller {

function index()

{

$this->load->helper(array('form', 'url'));

522

523

$this->load->library('form_validation');

524

525

$this->form_validation->set_rules('username', 'Username', 'callback_username_check');

526

$this->form_validation->set_rules('password', 'Password', 'required');

527

$this->form_validation->set_rules('passconf', 'Password Confirmation', 'required');

528

$this->form_validation->set_rules('email', 'Email', 'required');

529

530

if ($this->form_validation->run() == FALSE)

531

{

532

$this->load->view('myform');

}

else

{

$this->load->view('formsuccess');

}

}

function username_check($str)

{

if ($str == 'test')

{

$this->form_validation->set_message('username_check', 'The %s field can not be the word "test"');

return FALSE;

}

else

{

return TRUE;

}

}

}

?></textarea>

<p><dfn>Reload your form and submit it with the word "test" as the username. You can see that the form field data was passed to your

557

callback function for you to process.</dfn></p>

558

559

<p><strong>To invoke a callback just put the function name in a rule, with "callback_" as the rule prefix.</strong></p>

560

561

<p>You can also process the form data that is passed to your callback and return it. If your callback returns anything other then a boolean TRUE/FALSE

562

it is assumed that the data is your newly processed form data.</p>

<h2>Setting Error Messages</h2>

569

570

571

<p>All of the native error messages are located in the following language file: <dfn>language/english/form_validation_lang.php</dfn></p>

572

573

<p>To set your own custom message you can either edit that file, or use the following function:</p>

574

575

<code>$this->form_validation->set_message('<var>rule</var>', '<var>Error Message</var>');</code>

576

577

<p>Where <var>rule</var> corresponds to the name of a particular rule, and <var>Error Message</var> is the text you would like displayed.</p>

578

579

<p>If you include <dfn>%s</dfn> in your error string, it will be replaced with the "human" name you used for your field when you set your rules.</p>

580

581

<p>In the "callback" example above, the error message was set by passing the name of the function:</p>

582

583

<code>$this->form_validation->set_message('username_check')</code>

584

585

<p>You can also override any error message found in the languge file. For example, to change the message for the "required" rule you will do this:</p>

586

587

<code>$this->form_validation->set_message('required', 'Your custom message here');</code>

<h2>Changing the Error Delimiters</h2>

593

594

<p>By default, the Form Validation class adds a paragraph tag (<p>) around each error message shown. You can either change these delimiters globally or

individually.</p>

<ol>

<li><strong>Changing delimiters Globally</strong>

600

601

<p>To globally change the error delimiters, in your controller function, just after loading the Form Validation class, add this:</p>

602

603

<code><?php echo $this->form_validation->set_error_delimiters('<kbd><div class="error"></kbd>', '<kbd></div></kbd>');</code>

604

605

<p>In this example, we've switched to using div tags.</p>

</li>

<li><strong>Changing delimiters Individually</strong></p>

610

611

<p>Each of the two error generating functions shown in this tutorial can be supplied their own delimiters as follows:</p>

</p>Or:</p>

</li>

</ol>

<h2>Showing Errors Individually</h2>

627

628

<p>If you prefer to show an error message next to each form field, rather than as a list, you can use the <dfn>form_error()</dfn> function.</p>

629

630

<p>Try it! Change your form so that it looks like this:</p>

<h5>Username</h5>

<?php echo form_error('username'); ?>

<h5>Password</h5>

<?php echo form_error('password'); ?>

639

640

641

<h5>Password Confirm</h5>

642

<?php echo form_error('passconf'); ?>

643

644

645

<h5>Email Address</h5>

646

<?php echo form_error('email'); ?>

</textarea>

<p>If there are no errors, nothing will be shown. If there is an error, the message will appear.</p>

651

652

<p><strong>Important Note:</strong> If you use an array as the name of a form field, you must supply it as an array to the function. Example:</p>

653

654

<code><?php echo form_error('<kbd>options[size]</kbd>'); ?><br />

655

<input type="text" name="<kbd>options[size]</kbd>" value="<?php echo set_value("<kbd>options[size]</kbd>"); ?>" size="50" />

</code>

<h1>Saving Sets of Validation Rules to a Config File</h1>

667

668

<p>A nice feature of the Form Validation class is that it permits you to store all your validation rules for your entire application in a config file. You

669

can organize these rules into "groups". These groups can either be loaded automatically when a matching controller/function is called, or

670

you can manually call each set as needed.</p>

671

672

<h3>How to save your rules</h3>

673

674

<p>To store your validation rules, simply create a file named <kbd>form_validation.php</kbd> in your <dfn>application/config/</dfn> folder.

675

In that file you will place an array named <kbd>$config</kbd> with your rules. As shown earlier, the validation array will have this prototype:</p>

676

677

<code>

678

$config = array(<br />

679

               array(<br />

680

                     'field'   => 'username', <br />

681

                     'label'   => 'Username', <br />

682

                     'rules'   => 'required'<br />

683

                  ),<br />

684

               array(<br />

685

                     'field'   => 'password', <br />

686

                     'label'   => 'Password', <br />

687

                     'rules'   => 'required'<br />

688

                  ),<br />

689

               array(<br />

690

                     'field'   => 'passconf', <br />

691

                     'label'   => 'Password Confirmation', <br />

692

                     'rules'   => 'required'<br />

693

                  ),   <br />

694

               array(<br />

695

                     'field'   => 'email', <br />

696

                     'label'   => 'Email', <br />

697

                     'rules'   => 'required'<br />

698

                  )<br />

            );<br />

</code>

<p><dfn>Your validation rule file will be loaded automatically and used when you call the run() function.</dfn></p>

703

704

<p class="important">Please note that you MUST name your array $config.</p>

705

706

<h3>Creating Sets of Rules</h3>

707

708

<p>In order to organize your rules into "sets" requires that you place them into "sub arrays". Consider the following example, showing two sets of rules.

709

We've arbitrarily called these two rules "signup" and "email". You can name your rules anything you want:</p>

710

711

712

<code>$config = array(<br />

713

                 '<kbd>signup</kbd>' = array(<br />

714

                                    array(<br />

715

                                            'field' => 'username',<br />

716

                                            'label' => 'Username',<br />

717

                                            'rules' => 'required'<br />

718

                                         ),<br />

719

                                    array(<br />

720

                                            'field' => 'password',<br />

721

                                            'label' => 'Password',<br />

722

                                            'rules' => 'required'<br />

723

                                         ),<br />

724

                                    array(<br />

725

                                            'field' => 'passconf',<br />

726

                                            'label' => 'PasswordConfirmation',<br />

727

                                            'rules' => 'required'<br />

728

                                         ),<br />

729

                                    array(<br />

730

                                            'field' => 'email',<br />

731

                                            'label' => 'Email',<br />

732

                                            'rules' => 'required'<br />

733

                                         )<br />

734

                                    ),<br />

735

                 '<kbd>email</kbd>' = array(<br />

736

                                    array(<br />

737

                                            'field' => 'emailaddress',<br />

738

                                            'label' => 'EmailAddress',<br />

739

                                            'rules' => 'required|valid_email'<br />

740

                                         ),<br />

741

                                    array(<br />

742

                                            'field' => 'name',<br />

743

                                            'label' => 'Name',<br />

744

                                            'rules' => 'required|alpha'<br />

745

                                         ),<br />

746

                                    array(<br />

747

                                            'field' => 'title',<br />

748

                                            'label' => 'Title',<br />

749

                                            'rules' => 'required'<br />

750

                                         ),<br />

751

                                    array(<br />

752

                                            'field' => 'message',<br />

753

                                            'label' => 'MessageBody',<br />

754

                                            'rules' => 'required'<br />

755

                                         )<br />

756

                                    )                          <br />

757

               );<br />

</code>

<h3>Calling a Specific Rule Group</h3>

762

763

<p>In order to call a specific group you will pass its name to the <kbd>run()</kbd> function. For example, to call the <kbd>signup</kbd> rule you will do this:</p>

764

765

<code>

766

if ($this->form_validation->run('<kbd>signup</kbd>') == FALSE)<br />

767

{<br />

768

   $this->load->view('myform');<br />

}<br />

else<br />

{<br />

   $this->load->view('formsuccess');<br />

}<br />

</code>

<h3>Associating a Controller Function with a Rule Group</h3>

779

780

<p>An alternate (and more automatic) method of calling a rule group is to name it according to the controller class/function you intend to use it with. For example, let's say you

781

have a controller named <kbd>Member</kbd> and a function named <kbd>signup</kbd>. Here's what your class might look like:</p>

<code>

<?php<br /><br />

class <kbd>Member</kbd> extends Controller {<br />

786

<br />

787

   function <kbd>signup</kbd>()<br />

788

   {      <br />

789

      $this->load->library('form_validation');<br />

790

            <br />

791

      if ($this->form_validation->run() == FALSE)<br />

792

      {<br />

793

         $this->load->view('myform');<br />

      }<br />

      else<br />

      {<br />

         $this->load->view('formsuccess');<br />

      }<br />

   }<br />

}<br />

?></code>

<p>In your validation config file, you will name your rule group <kbd>member/signup</kbd>:

804

805

806

<code>$config = array(<br />

807

           '<kbd>member/signup</kbd>' = array(<br />

808

                                    array(<br />

809

                                            'field' => 'username',<br />

810

                                            'label' => 'Username',<br />

811

                                            'rules' => 'required'<br />

812

                                         ),<br />

813

                                    array(<br />

814

                                            'field' => 'password',<br />

815

                                            'label' => 'Password',<br />

816

                                            'rules' => 'required'<br />

817

                                         ),<br />

818

                                    array(<br />

819

                                            'field' => 'passconf',<br />

820

                                            'label' => 'PasswordConfirmation',<br />

821

                                            'rules' => 'required'<br />

822

                                         ),<br />

823

                                    array(<br />

824

                                            'field' => 'email',<br />

825

                                            'label' => 'Email',<br />

826

                                            'rules' => 'required'<br />

827

                                         )<br />

828

                                    )<br />

829

               );<br />

830

</code>

831

832

<p><dfn>When a rule group is named identically to a controller class/function it will be used automatically when the run() function is invoked from that class/function.</dfn></p>

833

Rick Ellis

66bc2ad

2008-08-26 20:18:17 +0000

[diff] [blame^]

834

Rick Ellis

2594953

2008-08-26 19:48:08 +0000

[diff] [blame]

835

836

Rick Ellis

66bc2ad

2008-08-26 20:18:17 +0000

[diff] [blame^]

837

838

<h1>Using Arrays as Field Names</h1>

Rick Ellis

2594953

2008-08-26 19:48:08 +0000

[diff] [blame]

839

Rick Ellis

66bc2ad

2008-08-26 20:18:17 +0000

[diff] [blame^]

840

<p>The Form Validation class supports the use of arrays as field names. Consider this example:</p>

841

842

<code><input type="text" name="<kbd>options[]</kbd>" value="" size="50" /></code>

843

844

<p>If you do use an array as a field name, you must use the EXACT array name in the <a href="#helperreference">Helper Functions</a> that require the field name,

845

and as your Validation Rule field name.</p>

846

847

<p>For example, to set a rule for the above field you would use:</p>

848

849

<code>$this->form_validation->set_rules('<kbd>options[]</kbd>', 'Options', 'required');</code>

850

851

<p>Or, to show an error for the above field you would use:</p>

852

853

<code><?php echo form_error('<kbd>options[]</kbd>'); ?></code>

854

855

<p>Or to re-populate the field you would use:</p>

856

857

<code><input type="text" name="<kbd>options[]</kbd>" value="<kbd><?php echo set_value('<kbd>options[]</kbd>'); ?></kbd>" size="50" /></code>

858

859

<p>You can use multidimensional arrays as field names as well. For example:</p>

860

861

<code><input type="text" name="<kbd>options[size]</kbd>" value="" size="50" /></code>

<code><input type="text" name="<kbd>sports[nba][basketball]</kbd>" value="" size="50" /></code>

866

867

<p>As with our first example, you must use the exact array name in the helper functions:</p>

868

869

<code><?php echo form_error('<kbd>sports[nba][basketball]</kbd>'); ?></code>

870

871

<p>If you are using checkboxes (or other fields) that have multiple options, don't forget to leave an empty bracket after each option, so that all selections will be added to the

POST array:</p>

<code>

<input type="checkbox" name="<kbd>options[]</kbd>" value="red" /><br />

876

<input type="checkbox" name="<kbd>options[]</kbd>" value="blue" /><br />

877

<input type="checkbox" name="<kbd>options[]</kbd>" value="green" />

878

</code>

879

880

<p>Or if you use a multidimensional array:</p>

881

882

<code>

883

<input type="checkbox" name="<kbd>options[color][]</kbd>" value="red" /><br />

884

<input type="checkbox" name="<kbd>options[color][]</kbd>" value="blue" /><br />

885

<input type="checkbox" name="<kbd>options[color][]</kbd>" value="green" />

886

</code>

887

888

<p>When you use a helper function you'll include the bracket as well:</p>

889

890

<code><?php echo form_error('<kbd>options[color][]</kbd>'); ?></code>

Rick Ellis

2594953

2008-08-26 19:48:08 +0000

[diff] [blame]

<h1>Rule Reference</h1>

900

901

<p>The following is a list of all the native rules that are available to use:</p>

<tr>

<th>Parameter</th>

<th>Description</th>

<th>Example</th>

</tr><tr>

<td class="td"><strong>required</strong></td>

914

915

<td class="td">Returns FALSE if the form element is empty.</td>

</tr><tr>

<td class="td"><strong>matches</strong></td>

920

921

<td class="td">Returns FALSE if the form element does not match the one in the parameter.</td>

922

<td class="td">matches[form_item]</td>

923

</tr><tr>

924

925

<td class="td"><strong>min_length</strong></td>

926

927

<td class="td">Returns FALSE if the form element is shorter then the parameter value.</td>

928

<td class="td">min_length[6]</td>

929

</tr><tr>

930

931

<td class="td"><strong>max_length</strong></td>

932

933

<td class="td">Returns FALSE if the form element is longer then the parameter value.</td>

934

<td class="td">max_length[12]</td>

935

</tr><tr>

936

937

<td class="td"><strong>exact_length</strong></td>

938

939

<td class="td">Returns FALSE if the form element is not exactly the parameter value.</td>

940

<td class="td">exact_length[8]</td>

941

</tr><tr>

942

943

<td class="td"><strong>alpha</strong></td>

944

945

<td class="td">Returns FALSE if the form element contains anything other than alphabetical characters.</td>

</tr><tr>

<td class="td"><strong>alpha_numeric</strong></td>

950

951

<td class="td">Returns FALSE if the form element contains anything other than alpha-numeric characters.</td>

</tr><tr>

<td class="td"><strong>alpha_dash</strong></td>

956

957

<td class="td">Returns FALSE if the form element contains anything other than alpha-numeric characters, underscores or dashes.</td>

</tr>

<tr>

<td class="td"><strong>numeric</strong></td>

963

964

<td class="td">Returns FALSE if the form element contains anything other than numeric characters.</td>

</tr>

<tr>

<td class="td"><strong>integer</strong></td>

970

971

<td class="td">Returns FALSE if the form element contains anything other than an integer.</td>

</tr>

<tr>

<td class="td"><strong>is_natural</strong></td>

977

978

<td class="td">Returns FALSE if the form element contains anything other than a natural number: 0, 1, 2, 3, etc.</td>

</tr>

<tr>

<td class="td"><strong>is_natural_no_zero</strong></td>

984

985

<td class="td">Returns FALSE if the form element contains anything other than a natural number, but not zero: 1, 2, 3, etc.</td>

</tr>

<tr>

<td class="td"><strong>valid_email</strong></td>

991

992

<td class="td">Returns FALSE if the form element does not contain a valid email address.</td>

</tr>

<tr>

<td class="td"><strong>valid_emails</strong></td>

998

999

<td class="td">Returns FALSE if any value provided in a comma separated list is not a valid email.</td>

</tr>

<tr>

<td class="td"><strong>valid_ip</strong></td>

1005

1006

<td class="td">Returns FALSE if the supplied IP is not valid.</td>

</tr>

<tr>

<td class="td"><strong>valid_base64</strong></td>

1012

1013

<td class="td">Returns FALSE if the supplied string contains anything other than valid Base64 characters.</td>

</tr>

</table>

<p><strong>Note:</strong> These rules can also be called as discrete functions. For example:</p>

1021

1022

<code>$this->form_validation->required($string);</code>

1023

1024

<p class="important"><strong>Note:</strong> You can also use any native PHP functions that permit one parameter.</p>

<h1>Prepping Reference</h1>

1032

1033

<p>The following is a list of all the prepping functions that are available to use:</p>

<tr>

<th>Parameter</th>

<th>Description</th>

</tr><tr>

<td class="td"><strong>xss_clean</strong></td>

1045

1046

<td class="td">Runs the data through the XSS filtering function, described in the <a href="input.html">Input Class</a> page.</td>

</tr><tr>

<td class="td">Converts special characters so that HTML data can be shown in a form field without breaking it.</td>

</tr><tr>

<td class="td">Adds "http://" to URLs if missing.</td>

1057

</tr><tr>

1058

1059

<td class="td"><strong>strip_image_tags</strong></td>

1060

1061

<td class="td">Strips the HTML from image tags leaving the raw URL.</td>

1062

</tr><tr>

1063

1064

<td class="td"><strong>encode_php_tags</strong></td>

1065

1066

<td class="td">Converts PHP tags to entities.</td>

</tr>

</table>

<p class="important"><strong>Note:</strong> You can also use any native PHP functions that permit one parameter,

1072

like <kbd>trim</kbd>, <kbd>htmlspecialchars</kbd>, <kbd>urldecode</kbd>, etc.</p>

<h1>Function Reference</h1>

1084

Rick Ellis

b1eee35

2008-08-26 19:56:48 +0000

[diff] [blame]

1085

<p>The following functions are intended for use in your controller functions.</p>

1086

Rick Ellis

2594953

2008-08-26 19:48:08 +0000

[diff] [blame]

1087

<h2>$this->form_validation->set_rule();</h2>

1088

1089

<p>Permits you to set validation rules, as described in the tutorial sections above:</p>

1090

1091

<ul>

1092

<li><a href="#validationrules">Setting Validation Rules</a></li>

1093

<li><a href="#savingtoconfig">Saving Groups of Validation Rules to a Config File</a></li>

</ul>

<h2>$this->form_validation->run();</h2>

1098

1099

<p>Runs the validation routines. Returns boolean TRUE on success and FALSE on failure. You can optionally pass the name of the validation

1100

group via the function, as described in: <a href="#savingtoconfig">Saving Groups of Validation Rules to a Config File</a>.</p>

1101

1102

1103

<h2>$this->form_validation->set_message();</h2>

1104

1105

<p>Permits you to set custom error messages. See <a href="#settingerrors">Setting Error Messages</a> above.</p>

<h1>Helper Reference</h1>

1112

1113

<p>The following helper functions are available for use in the view files containing your forms. Note that these are procedural functions, so they

1114

<strong>do not</strong> require you to prepend them with $this->form_validation.</p>

1115

1116

<h2>form_error()</h2>

1117

1118

<p>Shows an individual error message associated with the field name supplied to the function. Example:</p>

<p>The error delimiters can be optionally specified. See the <a href="#errordelimiters">Changing the Error Delimiters</a> section above.</p>

<h2>validation_errors()</h2>

1127

<p>Shows all error messages as a string: Example:</p>

<p>The error delimiters can be optionally specified. See the <a href="#errordelimiters">Changing the Error Delimiters</a> section above.</p>

<h2>set_value()</h2>

<p>Permits you to set the value of an input form or textarea. You must supply the field name via the first parameter of the function.

1138

The second (optional) parameter allows you to set a default value for the form. Example:</p>

<p>The above form will show "0" when loaded for the firs time.</p>

1143

1144

<h2>set_select()</h2>

1145

1146

<p>If you use a <dfn><select></dfn> menu, this function permits you to display the menu item that was selected. The first parameter

1147

must contain the name of the select menu, the second parameter must contain the value of

1148

each item, and the third (optional) parameter lets you set an item as the default (use boolean TRUE/FALSE).</p>

<p>Example:</p>

<code>

<option value="three" <dfn><?php echo set_select('myselect', 'three'); ?></dfn> >Three</option><br />

</select>

</code>

<h2>set_checkbox()</h2>

1162

1163

<p>Permits you to display a checkbox in the state it was submitted. The first parameter

1164

must contain the name of the checkbox, the second parameter must contain its value, and the third (optional) parameter lets you set an item as the default (use boolean TRUE/FALSE). Example:</p>

1165

Rick Ellis

66bc2ad

2008-08-26 20:18:17 +0000

[diff] [blame^]

1166

1167

Rick Ellis

2594953

2008-08-26 19:48:08 +0000

[diff] [blame]

<h2>set_radio()</h2>

<p>Permits you to display radio buttons in the state they were submitted. This function is identical to the <strong>set_checkbox()</strong> function above.</p>