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

2008-11-13 22:59:24 +0000

[diff] [blame]

61

<ul>

62

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

63

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

<ul>

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

68

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

69

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

70

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

71

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

72

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

73

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

74

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

75

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

76

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

77

<li><a href="#translatingfn">Translating Field Names</a></li>

78

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

79

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

80

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

81

</ul>

82

</li>

83

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

84

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

85

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

86

<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>

102

103

<ol>

104

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

105

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

Barry Mieny

2010-10-04 16:33:58 +0200

[diff] [blame]

106

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

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

107

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

108

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

109

</ol>

110

111

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

112

113

<ol>

114

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

115

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

Derek Jones

2011-07-01 17:56:50 -0500

[diff] [blame]

116

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

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

117

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

118

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

Derek Jones

2011-07-01 17:56:50 -0500

[diff] [blame]

119

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

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

120

<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

125

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

126

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

<h1>Form Validation Tutorial</h1>

133

134

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

135

136

137

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

138

139

<ol>

140

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

141

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

142

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

143

</ol>

144

145

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

Derek Jones

2011-07-01 17:56:50 -0500

[diff] [blame]

153

<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>

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

folder:</p>

<head>

</head>

<body>

<?php echo validation_errors(); ?>

164

165

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

<h5>Username</h5>

<h5>Password</h5>

<h5>Password Confirm</h5>

174

175

176

<h5>Email Address</h5>

</form>

</body>

</html>

</textarea>

<h2>The Success Page</h2>

192

193

Derek Jones

2011-07-01 17:56:50 -0500

[diff] [blame]

194

<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>

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

folder:</p>

<html>

<head>

</head>

<body>

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

</body>

</html>

</textarea>

<h2>The Controller</h2>

217

Derek Jones

2011-07-01 17:56:50 -0500

[diff] [blame]

218

<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>

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

folder:</p>

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

223

Greg Aker

2010-11-09 13:53:07 -0600

[diff] [blame]

224

class Form extends CI_Controller {

Barry Mieny

2010-10-04 16:33:58 +0200

[diff] [blame]

225

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

226

function index()

227

{

228

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

Barry Mieny

2010-10-04 16:33:58 +0200

[diff] [blame]

229

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

230

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

Barry Mieny

2010-10-04 16:33:58 +0200

[diff] [blame]

231

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

232

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

233

{

234

$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>

248

249

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

250

Derek Jones

2011-07-01 17:56:50 -0500

[diff] [blame]

251

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

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

252

rules yet.</dfn></p>

253

Derek Jones

2011-07-01 17:56:50 -0500

[diff] [blame]

254

<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>

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

255

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>

261

262

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

263

264

<ol>

265

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

Derek Jones

2011-07-01 17:56:50 -0500

[diff] [blame]

266

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

267

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>

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

268

269

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

270

271

272

<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

277

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

278

the validation routine. Based on

279

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

<h2>Setting Validation Rules</h2>

287

288

<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

289

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

290

291

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

292

293

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

294

295

<ol>

296

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

297

<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". <strong>Note:</strong> If you would like the field name to be stored in a language file, please see <a href="#translatingfn">Translating Field Names</a>.</li>

298

<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>

303

304

<code>

305

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

306

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

307

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

308

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

309

</code>

310

311

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

312

Derek Allard

4b6d493

2008-12-07 17:04:56 +0000

[diff] [blame]

313

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

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

314

Greg Aker

2010-11-09 13:53:07 -0600

[diff] [blame]

315

class Form extends CI_Controller {

Barry Mieny

2010-10-04 16:33:58 +0200

[diff] [blame]

316

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

317

function index()

318

{

319

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

Barry Mieny

2010-10-04 16:33:58 +0200

[diff] [blame]

320

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

321

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

Barry Mieny

2010-10-04 16:33:58 +0200

[diff] [blame]

322

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

323

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

324

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

325

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

326

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

Barry Mieny

2010-10-04 16:33:58 +0200

[diff] [blame]

327

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

328

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

329

{

330

$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.

341

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

342

343

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

Derek Jones

2011-07-01 17:56:50 -0500

[diff] [blame]

344

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

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

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

351

352

<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.

353

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

354

355

<code>

356

$config = array(<br />

357

               array(<br />

358

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

359

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

360

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

361

                  ),<br />

362

               array(<br />

363

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

364

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

365

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

366

                  ),<br />

367

               array(<br />

368

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

369

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

370

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

371

                  ),   <br />

372

               array(<br />

373

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

374

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

375

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

376

                  )<br />

377

            );<br />

378

<br />

379

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

</code>

<h2>Cascading Rules</h2>

389

Derek Jones

2011-07-01 17:56:50 -0500

[diff] [blame]

390

<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>

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

391

392

<code>

Phil Sturgeon

2011-05-09 21:12:26 +0100

[diff] [blame]

393

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

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

394

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

395

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

Phil Sturgeon

2011-05-09 21:12:26 +0100

[diff] [blame]

396

$this->form_validation->set_rules('email', 'Email', 'required|valid_email|is_unique[users.email]');<br />

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

397

</code>

398

399

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

400

401

<ol>

402

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

403

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

404

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

405

</ol>

406

407

<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.

408

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

<h2>Prepping Data</h2>

414

415

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

416

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

417

418

<code>

419

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

420

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

421

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

422

$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

427

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

428

429

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

Derek Jones

2011-07-01 17:56:50 -0500

[diff] [blame]

430

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

431

432

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

433

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>

440

Derek Jones

2011-07-01 17:56:50 -0500

[diff] [blame]

441

<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

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

442

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

443

444

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

445

446

447

<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>

448

Derek Allard

028cbb5

2010-01-17 08:07:49 +0000

[diff] [blame]

449

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

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

<html>

<head>

</head>

<body>

<?php echo validation_errors(); ?>

460

461

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

<h5>Username</h5>

<h5>Password</h5>

<h5>Password Confirm</h5>

470

471

472

<h5>Email Address</h5>

</form>

</body>

</html>

</textarea>

Derek Jones

2011-07-01 17:56:50 -0500

[diff] [blame]

484

<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>

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

485

486

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

487

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

488

489

Derek Jones

2011-07-01 17:56:50 -0500

[diff] [blame]

490

<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>

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

491

492

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

493

494

<p>For more info please see the <a href="#arraysasfields">Using Arrays as Field Names</a> section below.</p>

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

502

Derek Jones

2011-07-01 17:56:50 -0500

[diff] [blame]

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>

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

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

Derek Jones

2011-07-01 17:56:50 -0500

[diff] [blame]

511

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

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

512

MarcosCoelho

7dafce4

2011-07-16 02:57:47 -0300

[diff] [blame]

513

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

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

514

Greg Aker

2010-11-09 13:53:07 -0600

[diff] [blame]

515

class Form extends CI_Controller {

Barry Mieny

2010-10-04 16:33:58 +0200

[diff] [blame]

516

Phil Sturgeon

2011-05-09 21:12:26 +0100

[diff] [blame]

517

public function index()

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

518

{

519

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

Barry Mieny

2010-10-04 16:33:58 +0200

[diff] [blame]

520

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

521

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

Barry Mieny

2010-10-04 16:33:58 +0200

[diff] [blame]

522

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

523

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

524

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

525

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

Phil Sturgeon

2011-05-09 21:12:26 +0100

[diff] [blame]

526

$this->form_validation->set_rules('email', 'Email', 'required|is_unique[users.email]');

Barry Mieny

2010-10-04 16:33:58 +0200

[diff] [blame]

527

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

528

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

529

{

530

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

}

else

{

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

535

}

536

}

Barry Mieny

2010-10-04 16:33:58 +0200

[diff] [blame]

537

Phil Sturgeon

2011-05-09 21:12:26 +0100

[diff] [blame]

538

public function username_check($str)

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

{

if ($str == 'test')

{

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

return FALSE;

}

else

{

return TRUE;

}

}

Barry Mieny

2010-10-04 16:33:58 +0200

[diff] [blame]

550

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

}

?></textarea>

Derek Jones

2011-07-01 17:56:50 -0500

[diff] [blame]

554

<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

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

555

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

556

MarcosCoelho

7dafce4

2011-07-16 02:57:47 -0300

[diff] [blame]

557

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

558

to receive an extra parameter in your callback function, just add it normally after the function name between square brackets,

559

as in: "callback_foo<strong>[bar]</strong>", then it will be passed as the second argument of your callback function.</p>

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

560

MarcosCoelho

7dafce4

2011-07-16 02:57:47 -0300

[diff] [blame]

561

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

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

562

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

563

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

564

565

<h2>Setting Error Messages</h2>

566

567

Derek Jones

2011-07-01 17:56:50 -0500

[diff] [blame]

568

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

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

569

570

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

571

572

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

573

574

<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>

575

576

<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>

577

578

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

579

580

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

581

Derek Jones

2011-07-01 17:56:50 -0500

[diff] [blame]

582

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

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

583

584

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

<h2>Translating Field Names</h2>

590

591

<p>If you would like to store the "human" name you passed to the <dfn>set_rules()</dfn> function in a language file, and therefore make the name able to be translated, here's how:</p>

592

593

<p>First, prefix your "human" name with <dfn>lang:</dfn>, as in this example:</p>

594

595

<code>

596

$this->form_validation->set_rules('first_name', '<kbd>lang:</kbd>first_name', 'required');<br />

597

</code>

598

599

<p>Then, store the name in one of your language file arrays (without the prefix):</p>

600

601

<code>$lang['first_name'] = 'First Name';</code>

602

603

<p><strong>Note:</strong> If you store your array item in a language file that is not loaded automatically by CI, you'll need to remember to load it in your controller using:</p>

<p>See the <a href="language.html">Language Class</a> page for more info regarding language files.</p>

<h2>Changing the Error Delimiters</h2>

612

Barry Mieny

2010-10-04 16:33:58 +0200

[diff] [blame]

613

<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

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

individually.</p>

<ol>

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

619

620

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

621

622

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

623

624

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

</li>

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

629

630

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

</li>

</ol>

<h2>Showing Errors Individually</h2>

646

647

<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>

648

649

<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'); ?>

658

659

660

<h5>Password Confirm</h5>

661

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

662

663

664

<h5>Email Address</h5>

665

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

</textarea>

Derek Jones

2011-07-01 17:56:50 -0500

[diff] [blame]

669

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

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

670

Derek Jones

2011-07-01 17:56:50 -0500

[diff] [blame]

671

<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>

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

672

673

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

674

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

675

</code>

676

677

<p>For more info please see the <a href="#arraysasfields">Using Arrays as Field Names</a> section below.</p>

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

687

Derek Jones

2011-07-01 17:56:50 -0500

[diff] [blame]

688

<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

689

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

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

690

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

691

692

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

693

694

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

695

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>

696

697

<code>

698

$config = array(<br />

699

               array(<br />

700

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

701

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

702

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

703

                  ),<br />

704

               array(<br />

705

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

706

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

707

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

708

                  ),<br />

709

               array(<br />

710

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

711

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

712

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

713

                  ),   <br />

714

               array(<br />

715

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

716

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

717

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

718

                  )<br />

            );<br />

</code>

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

723

724

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

725

726

<h3>Creating Sets of Rules</h3>

727

Derek Jones

2011-07-01 17:56:50 -0500

[diff] [blame]

728

<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.

729

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

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

730

731

732

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

733

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

734

                                    array(<br />

735

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

736

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

737

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

738

                                         ),<br />

739

                                    array(<br />

740

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

741

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

742

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

743

                                         ),<br />

744

                                    array(<br />

745

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

746

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

747

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

748

                                         ),<br />

749

                                    array(<br />

750

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

751

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

752

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

753

                                         )<br />

754

                                    ),<br />

755

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

756

                                    array(<br />

757

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

758

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

759

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

760

                                         ),<br />

761

                                    array(<br />

762

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

763

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

764

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

765

                                         ),<br />

766

                                    array(<br />

767

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

768

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

769

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

770

                                         ),<br />

771

                                    array(<br />

772

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

773

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

774

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

775

                                         )<br />

776

                                    )                          <br />

777

               );<br />

</code>

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

782

Derek Jones

2011-07-01 17:56:50 -0500

[diff] [blame]

783

<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>

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

784

785

<code>

786

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

787

{<br />

788

   $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>

799

Derek Jones

2011-07-01 17:56:50 -0500

[diff] [blame]

800

<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

801

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

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

802

803

<code>

804

<?php<br /><br />

Greg Aker

2010-11-09 13:53:07 -0600

[diff] [blame]

805

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

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

806

<br />

807

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

808

   {      <br />

809

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

810

            <br />

811

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

812

      {<br />

813

         $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>:</p>

824

825

826

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

Derek Allard

03d783b

2009-05-03 19:45:45 +0000

[diff] [blame]

827

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

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

828

                                    array(<br />

829

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

830

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

831

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

832

                                         ),<br />

833

                                    array(<br />

834

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

835

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

836

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

837

                                         ),<br />

838

                                    array(<br />

839

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

840

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

841

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

842

                                         ),<br />

843

                                    array(<br />

844

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

845

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

846

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

847

                                         )<br />

848

                                    )<br />

849

               );<br />

850

</code>

851

852

<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>

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

859

Derek Jones

2011-07-01 17:56:50 -0500

[diff] [blame]

860

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

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

861

862

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

863

864

<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,

865

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

866

867

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

868

869

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

870

871

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

872

873

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

874

875

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

876

877

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

878

879

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

880

881

<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>

886

887

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

888

889

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

890

891

<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 />

896

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

897

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

898

</code>

899

900

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

901

902

<code>

903

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

904

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

905

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

906

</code>

907

908

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

909

910

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

<h1>Rule Reference</h1>

920

921

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

922

923

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

924

Phil Sturgeon

2011-02-07 13:01:47 +0000

[diff] [blame]

<tr>

<th>Parameter</th>

<th>Description</th>

<th>Example</th>

</tr>

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

931

Phil Sturgeon

2011-02-07 13:01:47 +0000

[diff] [blame]

932

<tr>

933

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

934

935

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

936

937

</tr>

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

938

Phil Sturgeon

2011-02-07 13:01:47 +0000

[diff] [blame]

939

<tr>

940

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

941

942

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

943

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

944

</tr>

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

945

Phil Sturgeon

2011-02-07 13:01:47 +0000

[diff] [blame]

946

<tr>

Phil Sturgeon

2011-05-09 21:12:26 +0100

[diff] [blame]

947

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

948

949

<td class="td">Returns FALSE if the form element is not unique to the table and field name in the parameter.</td>

950

<td class="td">is_unique[table.field]</td>

951

</tr>

952

953

<tr>

Phil Sturgeon

2011-02-07 13:01:47 +0000

[diff] [blame]

954

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

955

956

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

957

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

958

</tr>

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

959

Phil Sturgeon

2011-02-07 13:01:47 +0000

[diff] [blame]

960

<tr>

961

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

962

963

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

964

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

965

</tr>

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

966

Phil Sturgeon

2011-02-07 13:01:47 +0000

[diff] [blame]

967

<tr>

968

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

969

970

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

971

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

972

</tr>

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

973

Phil Sturgeon

2011-02-07 13:01:47 +0000

[diff] [blame]

974

<tr>

975

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

976

977

<td class="td">Returns FALSE if the form element is less than the parameter value or not numeric.</td>

978

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

979

</tr>

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

980

Phil Sturgeon

2011-02-07 13:01:47 +0000

[diff] [blame]

<tr>

<td class="td">Returns FALSE if the form element is greater than the parameter value or not numeric.</td>

985

986

</tr>

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

987

Phil Sturgeon

2011-02-07 13:01:47 +0000

[diff] [blame]

988

<tr>

989

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

990

991

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

992

993

</tr>

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

994

Phil Sturgeon

2011-02-07 13:01:47 +0000

[diff] [blame]

995

<tr>

996

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

997

998

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

999

1000

</tr>

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

1001

Phil Sturgeon

2011-02-07 13:01:47 +0000

[diff] [blame]

1002

<tr>

1003

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

1004

1005

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

1006

1007

</tr>

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

1008

Phil Sturgeon

2011-02-07 13:01:47 +0000

[diff] [blame]

1009

<tr>

1010

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

1011

1012

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

1013

1014

</tr>

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

1015

Phil Sturgeon

2011-02-07 13:01:47 +0000

[diff] [blame]

1016

<tr>

1017

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

1018

1019

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

1020

1021

</tr>

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

1022

Phil Sturgeon

2011-02-07 13:01:47 +0000

[diff] [blame]

1023

<tr>

1024

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

1025

1026

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

1027

1028

</tr>

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

1029

Phil Sturgeon

2011-02-07 13:01:47 +0000

[diff] [blame]

1030

<tr>

1031

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

1032

1033

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

1034

1035

</tr>

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

1036

Phil Sturgeon

2011-02-07 13:01:47 +0000

[diff] [blame]

1037

<tr>

1038

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

1039

1040

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

1041

1042

</tr>

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

1043

Phil Sturgeon

2011-02-07 13:01:47 +0000

[diff] [blame]

1044

<tr>

Kyle Farris

d9c3a6f

2011-08-21 23:08:17 -0300

[diff] [blame]

1045

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

1046

1047

<td class="td">Returns FALSE if the form element is not unique in a database table.</td>

1048

<td class="td">is_unique[table.field]</td>

1049

</tr>

1050

1051

<tr>

Phil Sturgeon

2011-02-07 13:01:47 +0000

[diff] [blame]

1052

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

1053

1054

<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>

1060

1061

<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>

1067

1068

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

</tr>

<tr>

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

1074

1075

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

1076

1077

</tr>

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

</table>

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

1083

1084

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

1085

1086

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

<h1>Prepping Reference</h1>

1094

1095

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

Phil Sturgeon

2011-02-07 13:01:47 +0000

[diff] [blame]

<tr>

<th>Parameter</th>

<th>Description</th>

</tr><tr>

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

1105

Phil Sturgeon

2011-02-07 13:01:47 +0000

[diff] [blame]

1106

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

1107

1108

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

1109

</tr><tr>

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

1110

Phil Sturgeon

2011-02-07 13:01:47 +0000

[diff] [blame]

1111

1112

1113

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

1114

</tr><tr>

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

1115

Phil Sturgeon

2011-02-07 13:01:47 +0000

[diff] [blame]

1116

1117

1118

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

1119

</tr><tr>

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

1120

Phil Sturgeon

2011-02-07 13:01:47 +0000

[diff] [blame]

1121

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

1122

1123

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

1124

</tr><tr>

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

1125

Phil Sturgeon

2011-02-07 13:01:47 +0000

[diff] [blame]

1126

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

1127

1128

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

1129

</tr>

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

</table>

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

1134

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

<h1>Function Reference</h1>

1146

1147

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

1148

Derek Allard

5115725

2009-02-04 12:34:07 +0000

[diff] [blame]

1149

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

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

1150

1151

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

1152

1153

<ul>

1154

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

1155

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

</ul>

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

1160

Derek Jones

2011-07-01 17:56:50 -0500

[diff] [blame]

1161

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

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

1162

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

1163

1164

1165

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

1166

Derek Jones

2011-07-01 17:56:50 -0500

[diff] [blame]

1167

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

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

<h1>Helper Reference</h1>

1174

Derek Jones

2011-07-01 17:56:50 -0500

[diff] [blame]

1175

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

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

1176

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

1177

1178

<h2>form_error()</h2>

1179

Derek Jones

2011-07-01 17:56:50 -0500

[diff] [blame]

1180

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

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

Derek Jones

2011-07-01 17:56:50 -0500

[diff] [blame]

1184

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

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

<h2>validation_errors()</h2>

Derek Jones

2011-07-01 17:56:50 -0500

[diff] [blame]

1189

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

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

Derek Jones

2011-07-01 17:56:50 -0500

[diff] [blame]

1193

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

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

<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.

1200

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 first time.</p>

1205

1206

<h2>set_select()</h2>

1207

Derek Jones

2011-07-01 17:56:50 -0500

[diff] [blame]

1208

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

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

1209

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

1210

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

<p>Example:</p>

<code>

Derek Jones

2011-07-01 17:56:50 -0500

[diff] [blame]

1216

1217

1218

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

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

</select>

</code>

<h2>set_checkbox()</h2>

1224

Derek Jones

2011-07-01 17:56:50 -0500

[diff] [blame]

1225

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

Derek Allard

2008-11-13 22:59:24 +0000

[diff] [blame]

1226

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>

<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>

1235

Derek Jones

2011-07-01 17:56:50 -0500

[diff] [blame]

1236

1237

Derek Allard