表单辅助函数

表单辅助函数文件包含那些帮助你使用表单的函数。

载入辅助函数

用下面的代码载入该辅助函数：

  1. $this->load->helper('form');
下列函数才可用： ## form_open() 创建一个开始form标签，相对于你的**配置文档**中的基础URL。允许你添加一些form属性和一些隐藏表单，并且他会基于你的 config.php 文件里设置的编码，自动生成 accept-charset 这个属性。 使用这个函数而不是直接硬编码HTML的主要的优势是使你的程序可以方便的转换，如果你的URL变化的话。 下面是一个例子： 
  1. echo form_open('email/send');
上面的例子会创建一个form提交至你的基础URL加上"email/send" URI片段，像这样： 
  1. <form method="post" accept-charset="utf-8" action="http://example.com/index.php/email/send" />

添加一些属性

可以在第二个参数里传递一个关联数组来达到这一目的, 像这样：

  2. $attributes = array('class' => 'email', 'id' => 'myform');
  4. echo form_open('email/send', $attributes);
上面的例子会创建一个这样的form标签： 
  1. <form method="post" accept-charset="utf-8" action="http://example.com/index.php/email/send"  class="email"  id="myform" />

增加隐藏域

隐藏域可以使用数组加在第三个参数上，就像这样:

  2. $hidden = array('username' => 'Joe', 'member_id' => '234');
  4. echo form_open('email/send', '', $hidden);
上面的例子会创建一个这样的form标签和这些隐藏域: 
  1. <form method="post" accept-charset="utf-8" action="http://example.com/index.php/email/send">
  2. <input type="hidden" name="username" value="Joe" />
  3. <input type="hidden" name="member_id" value="234" />

form_open_multipart()

这个函数和上面的form_open()函数完全一样，不同之处在于它多了一个multipart属性。如果你要制作一个上传文件的表单，这个属性是必须的。

form_hidden()

可以使你创建一个隐藏输入栏。你可以输入name和value来创建一个：

  1. echo form_hidden('username', 'johndoe');
  4. // 将产生:
  5. <input type="hidden" name="username" value="johndoe" />
或者你也可以使用数组来联合创建它们: 
  1. $data = array(
  2.               'name'  => 'John Doe',
  3.               'email' => 'john@example.com',
  4.               'url'   => 'http://example.com'
  5.             );
  7. echo form_hidden($data);
  9. // 将产生:
  10. <input type="hidden" name="name" value="John Doe" />
  11. <input type="hidden" name="email" value="john@example.com" />
  12. <input type="hidden" name="url" value="http://example.com" />

form_input()

可以使你创建一个标准输入栏。你可以在第一和第二个参数里输入name和value来创建一个：

  1. echo form_input('username', 'johndoe');
或者你也可以用关联数组来添加你想加入的内容： 
  1. $data = array(
  2.               'name'        => 'username',
  3.               'id'          => 'username',
  4.               'value'       => 'johndoe',
  5.               'maxlength'   => '100',
  6.               'size'        => '50',
  7.               'style'       => 'width:50%',
  8.             );
  10. echo form_input($data);
  12. // 将产生:
  13. <input type="text" name="username" id="username" value="johndoe" maxlength="100" size="50" style="width:50%" />
如果你想加入一些额外的内容，例如Javascript，你可以在第三个参数里输入字符串来创建它： 
  1. $js = 'onClick="some_function()"';
  3. echo form_input('username', 'johndoe', $js);

form_password()

此函数除了是设置type为“password”外和上面的 form_input() 函数完全一样。

form_upload()

此函数与上面的 form_input() 函数几乎完全相同，唯一的区别是此函数所设置的 type 为 "file"，用来上传文件。

form_textarea()

此函数与上面的 form_input() 函数几乎完全相同，唯一的区别是此函数所生成的是一个"textarea"。说明：上面的范例中所指定的 "maxlength" 和 "size" 属性在这里变成了 "rows" 和 "cols"。

form_dropdown()

创建一个标准的下拉列表字段。第一个参数是字段名，第二个参数是一个包含各个选项的关联数组，第三个参数是你想要设置为默认被选中的值。第三个参数也可以是一个包含多个项目的数组，CI 将为你创建多选下拉列表。例如：

  1. $options = array(
  2.                   'small'  => 'Small Shirt',
  3.                   'med'    => 'Medium Shirt',
  4.                   'large'   => 'Large Shirt',
  5.                   'xlarge' => 'Extra Large Shirt',
  6.                 );
  8. $shirts_on_sale = array('small', 'large');
  10. echo form_dropdown('shirts', $options, 'large');
  12. // 将会生成:
  14. <select name="shirts">
  15. <option value="small">Small Shirt</option>
  16. <option value="med">Medium  Shirt</option>
  17. <option value="large" selected="selected">Large Shirt</option>
  18. <option value="xlarge">Extra Large Shirt</option>
  19. </select>
  21. echo form_dropdown('shirts', $options, $shirts_on_sale);
  23. // 将会生成:
  25. <select name="shirts" multiple="multiple">
  26. <option value="small" selected="selected">Small Shirt</option>
  27. <option value="med">Medium  Shirt</option>
  28. <option value="large" selected="selected">Large Shirt</option>
  29. <option value="xlarge">Extra Large Shirt</option>
  30. </select>
如果你希望 <select> 开始标签包含一些额外的属性，例如 id 属性以及JavaScript，你可以将一个字符串作为第四个参数传递过去: 
  1. $js = 'id="shirts" onChange="some_function();"';
  3. echo form_dropdown('shirts', $options, 'large', $js);
如果$options参数是一个多维数组，form_dropdown() 函数将使用数组的键作为 label值生成一个 <optgroup> 标签。 ## form_multiselect() 该函数可以生成标准的复选列表。第一个参数给出表单项的名称；第二个参数用一个关联数组给出该表单项的全部可选项列表；第三个参数规定哪几项是默认已选取的。这些参数的用法跟上面的form_dropdown()完全一样。当然，由于是复选的，在处理传值的时候，我们要使用数组的语法。数组语法的例子：foo[]。 ## form_fieldset() 帮助你生成fieldset/legend标签。 
  1. echo form_fieldset('Address Information');
  2. echo "<p>fieldset content here</p>\n";
  3. echo form_fieldset_close();
  6. // 生成
  7. <fieldset> 
  9. <legend>Address Information</legend>  
  11. <p>form content here</p>  
  13. </fieldset>
与其它函数类似，在第二个参数你可以传递一个关联数组来添加你自己想要的自定义的属性。 
  1. $attributes = array('id' => 'address_info', 'class' => 'address_info');
  2.     echo form_fieldset('Address Information', $attributes);
  3. echo "<p>fieldset content here</p>\n";
  4. echo form_fieldset_close(); 
  6. // 生成
  7. <fieldset id="address_info" class="address_info"> 
  8. <legend>Address Information</legend> 
  9. <p>form content here</p> 
  10. </fieldset>

form_fieldset_close()

生成一个结束的fieldset标签。唯一的优势是，使用该函数，你可以传递数据，这些数据会附加在这个标签的后面。例如：

  1. $string = "</div></div>";
  3. echo form_fieldset_close($string);
  5. // 会生成：
  6. </fieldset>
  7. </div></div>

form_checkbox()

作用是生成一个复选框。简单范例如下:

  1. echo form_checkbox('newsletter', 'accept', TRUE);
  3. // 将会生成:
  5. <input type="checkbox" name="newsletter" value="accept" checked="checked" />
第三个参数为 TRUE/FALSE 布尔值，决定复选框是否被默认选中。 与其它表单辅助函数相似的是，你可以把包含了属性值的数组作为参数传递给本函数: 
  1. $data = array(
  2.     'name'        => 'newsletter',
  3.     'id'          => 'newsletter',
  4.     'value'       => 'accept',
  5.     'checked'     => TRUE,
  6.     'style'       => 'margin:10px',
  7.     );
  9. echo form_checkbox($data);
  11. // 将会生成:
  12. <input type="checkbox" name="newsletter" id="newsletter" value="accept" checked="checked" style="margin:10px" />
与其它函数相似的，如果你希望此标签包含额外的数据，例如JavaScript，你可以将一个字符串作为第四个参数传递过去: 
  1. $js = 'onClick="some_function()"';
  3.  echo form_checkbox('newsletter', 'accept', TRUE, $js)

form_radio()

此函数与上面的 form_checkbox() 函数几乎完全相同，唯一的区别是此函数生成的是 "radio" 单选框。

form_submit()

帮助你生成一个标准的submit按钮。示例如下：

  1. echo form_submit('mysubmit', 'Submit Post!');
  3. // 会生成：
  5. <input type="submit" name="mysubmit" value="Submit Post!" />
与其它函数类似，第一个参数你可以传递一个关联数组来设置你所需要的属性。第三个参数允许你添加一些额外的内容到生成的HTML代码里。 ## form_label() 帮助你生成一个label.示例如下： 
  1. echo form_label('你的名字是？','username');
  3. // 会生成:
  5. <label for="username">你的名字是？</label>
与其它函数类似，你可以在第三个参数传入一个关联数组来增加一些额外的属性值。 
  1. $attributes = array(
  2.       'class' => 'mycustomclass',
  3.       'style' => 'color: #000;',
  4. );
  5.     echo form_label('你的名字是？', 'username', $attributes);
  6.         
  7. // 会生成: 
  8. <label for="username" class="mycustomclass" style="color: #000;">你的名字是？</label>

form_reset()

作用是生成一个标准的 reset 按钮。此函数用法与 form_submit() 完全相同。

form_button()

作用是生成一个标准的按钮。你至少要给出两个参数，它们分别是按钮的名称和内容:

  2. echo form_button('name','content');
  4. // 将会生成
  5. <button name="name" type="button">Content</button>
或者你也可以将一个包含有任何你想要的数据的关联数组作为参数传递过去:
  2. $data = array(
  3.     'name' => 'button',
  4.     'id' => 'button',
  5.     'value' => 'true',
  6.     'type' => 'reset',
  7.     'content' => 'Reset'
  8. );
  10. echo form_button($data);
  12. // 将会生成:
  13. <button name="button" id="button" value="true" type="reset">Reset</button>
如果你希望表单包含一些额外的数据，例如JavaScript，你可以将一个字符串作为第三个参数传递过去:
  2. $js = 'onClick="some_function()"';
  3. echo form_button('mybutton', 'Click Me', $js);

form_close()

作用是生成一个关闭 </form> 标签。使用此函数的唯一好处是，你可以将这个标签之后要添加的数据也传递过去。例如：

  1. $string = "</div></div>";
  3. echo form_close($string);
  5. // 将会生成:
  7. </form>
  8. </div></div>

form_prep()

允许你放心地在表单元素中使用HTML字符(例如引号)，不必担心破坏表单。考虑一下下面这个范例:

  1. $string = 'Here is a string containing "quoted" text.';
  3. <input type="text" name="myform" value="<var<$string</var<" />
因为上面的字符串中包含了引号，因而导致表单被破坏。form_prep()函数会转换HTML，因此可以放心使用: 
  1. <input type="text" name="myform" value="<var<<?php echo form_prep($string); ?></var<" />
**说明:** 如果你使用的是表单辅助函数中的任何一个，数据都会自动的进行预处理，所以没有必要调用本函数。只有当你手动创建表单元素时，你才需要本函数。 ## set_value() 允许你设置 input 或者 textarea 字段的值。你必须在第一个参数中指定字段名称。第二个参数是可选的，允许你给字段设置一个默认值。例如: 
  1. <input type="text" name="quantity" value="<?php echo set_value('quantity', '0'); ?>" size="50" />
当上面的表单元素第一次加载时将会显示"0"。 ## set_select() 如果你使用 _<select>_ 下拉菜单，此函数允许你显示选中的菜单项。第一个参数必须包含下拉菜单的名称，第二个参数必须包含每个菜单项的值。第三个参数是可选的，作用是设置菜单项为默认选中状态(使用TRUE/FALSE布尔值)。 范例: 
  2. <select name="myselect">
  3. <option value="one" <?php echo  set_select('myselect', 'one', TRUE); ?> >One</option>
  4. <option value="two" <?php echo  set_select('myselect', 'two'); ?> >Two</option>
  5. <option value="three" <?php echo  set_select('myselect', 'three'); ?> >Three</option>
  6. </select>

set_checkbox()

允许你显示一个处于提交状态的复选框。第一个参数必须包含此复选框的名称，第二个参数必须包含它的值，第三个参数是可选的，作用是设置复选框为默认选中状态(使用TRUE/FALSE布尔值)。例如:

  1. <input type="checkbox" name="mycheck" value="1" <?php echo set_checkbox('mycheck', '1'); ?> />
  2. <input type="checkbox" name="mycheck" value="2" <?php echo set_checkbox('mycheck', '2'); ?> />

set_radio()

允许你显示那些处于提交状态的单选框。这个函数与前面的 set_checkbox() 是相同的。

  1. <input type="radio" name="myradio" value="1" <?php echo  set_radio('myradio', '1', TRUE); ?> />
  2. <input type="radio" name="myradio" value="2" <?php echo  set_radio('myradio', '2'); ?> />

翻译贡献者:billycui, Fanbin, Hex, IT不倒翁, longjianghu, pw_2012, soaringup, soyota, thankwsx, yinzhili, zehee