表单助手 | Form Helper

表格助手

表单帮助文件包含有助于使用表单的功能。

• 加载此助手

• 转义场值

• 可用职能

加载此助手

使用以下代码加载此助手：

$this->load->helper('form'

转义场值

您可能需要在表单元素中使用HTML和字符(如引号)。为了安全地完成这个任务，您需要使用公共函数html_escape()...

考虑以下示例：

$string = 'Here is a string containing "quoted" text.';

<input type="text" name="myfield" value="<?php echo $string; ?>" />

由于上面的字符串包含一组引号，它将导致表单中断。大html_escape()函数转换HTML特殊字符，以便安全地使用：

<input type="text" name="myfield" value="<?php echo html_escape($string ?>" />

注

如果使用此页面中列出的任何表单帮助函数，则表单值将自动转义，因此不需要调用此函数。只有在创建自己的表单元素时才使用它。

可用职能

现有下列职能：

form_open([$action = ''[, $attributes = ''[, $hidden = array()]]])

• $ action（string） - 表单动作/目标URI字符串

• $ attributes（array） - HTML属性

• $ hidden（array） - 一个隐藏字段的定义数组

返回：HTML表单开始标记

返回类型：字符串

使用从您的配置首选项**构建的基本URL **创建开放表单标记。它可以选择让你添加表单属性和隐藏的输入字段，并且总是添加基于配置文件中charset值的`accept-charset`属性。

使用这个标记而不是硬编码自己的HTML的主要好处是，它允许您的站点在URL更改时更易于移植。

下面是一个简单的例子：

echo form_open（'email / send'）;

上面的示例将创建一个指向基本URL和“Email/Send”URI段的表单，如下所示：

<form method="post" accept-charset="utf-8" action="http://example.com/index.php/email/send">

添加属性

可以通过向第二个参数传递关联数组来添加属性，如下所示：

$ attributes = array（'class'=>'email'，'id'=>'myform'）; echo form_open（'email / send'，$ attributes）;

或者，可以将第二个参数指定为字符串：

echo form_open（'email / send'，'class =“email”id =“myform”'）;

上述示例将创建一个类似于此的形式：

<form method="post" accept-charset="utf-8" action="http://example.com/index.php/email/send" class="email" id="myform">

添加隐藏输入字段

可以通过向第三个参数传递关联数组来添加隐藏字段，如下所示：

$ hidden = array（'username'=>'Joe'，'member_id'=>'234'）; echo form_open（'email / send'，''，$ hidden）;

您可以通过向第二个参数传递任何Falsy值来跳过第二个参数。

上面的示例将创建一个类似于此的表单：

<form method="post" accept-charset="utf-8" action="http://example.com/index.php/email/send"> <input type="hidden" name="username" value="Joe" /> <input type="hidden" name="member\_id" value="234" />

form_open_multipart([$action = ''[, $attributes = array()[, $hidden = array()]]])

• $ action（string） - 表单动作/目标URI字符串

• $ attributes（array） - HTML属性

• $ hidden（array） - 一个隐藏字段的定义数组

返回：HTML多部分表单打开标记

返回类型：字符串

这个函数与上面的``form_open（）`]（about：blank＃form_open）完全相同，除了它增加了一个_multipart_属性，如果你想使用表单来上传文件，这是必须的。

form_hidden($name[, $value = ''])

• $ name（字符串） - 字段名称

• $ value（字符串） - 字段值

返回：HTML隐藏的输入字段标记

返回类型：字符串

让您生成隐藏的输入字段。您可以提交一个名称/值字符串来创建一个字段：

form_hidden（'username'，'johndoe'）; //会产生：<input type =“hidden”name =“username”value =“johndoe”/>

...或者可以提交一个关联数组来创建多个字段：

$ data = array（'name'=>'John Doe'，'email'=>'email protected'，'url'=>' http://example.com '）; echo form_hidden（$ data）; / *会产生：<input type =“hidden”name =“name”value =“John Doe”/> <input type =“hidden”name =“email”value =“[email protected]”/> <input type =“hidden”name =“url”value =“http://example.com”/> * /

还可以将关联数组传递给Value字段：

$ data = array（'name'=>'John Doe'，'email'=>'email protected'，'url'=>' http://example.com '）; echo form_hidden（'my_array'，$ data）; / *会生成：<input type =“hidden”name =“my \ _array [name]”value =“John Doe”/> <input type =“hidden”name =“my \ _array [email]”value =“ [email protected]“/> <input type =”hidden“name =”my \ _array [url]“value =”http://example.com“/> * /

如果要创建具有额外属性的隐藏输入字段：

$ data = array（'type'=>'hidden'，'name'=>'email'，'id'=>'hiddenemail'，'value'=>'email protected'，'class'=>'hiddenemail' ）; echo form_input（$ data）; / *会产生：<input type =“hidden”name =“email”value =“[email protected]”id =“hiddenemail”class =“hiddenemail”/> * /

form_input([$data = ''[, $value = ''[, $extra = '']]])

• $ data（array） - 字段属性数据

• $ value（字符串） - 字段值

• $ extra（mixed） - 要作为数组或字符串添加到标记的额外属性

返回：HTML文本输入字段标记

返回类型：字符串

让您生成标准文本输入字段。您可以最小化地传递第一个和第二个参数中的字段名称和值：

echo form_input（'username'，'johndoe'）;

也可以传递一个关联数组，该数组包含您希望窗体包含的任何数据：

$data = array( 'name' => 'username', 'id' => 'username', 'value' => 'johndoe', 'maxlength' => '100', 'size' => '50', 'style' => 'width:50%' echo form_input($data /* Would produce: <input type="text" name="username" value="johndoe" id="username" maxlength="100" size="50" style="width:50%" /> */

如果希望表单包含一些附加数据，如JavaScript，则可以将其作为字符串传递到第三个参数中：

$ js ='onClick =“some_function（）”'; echo form_input（'username'，'johndoe'，$ js）;

也可以将其作为数组传递：

$ js = array（'onClick'=>'some_function（）;'）; echo form_input（'username'，'johndoe'，$ js）;

form_password([$data = ''[, $value = ''[, $extra = '']]])

• $ data（array） - 字段属性数据

• $ value（字符串） - 字段值

• $ extra（mixed） - 要作为数组或字符串添加到标记的额外属性

返回：HTML密码输入字段标记

返回类型：字符串

除了使用“password”输入类型外，这个函数在所有方面都与[`form_input（）`]（about：blank＃form_input）函数完全相同。

form_upload([$data = ''[, $value = ''[, $extra = '']]])

• $ data（array） - 字段属性数据

• $ value（字符串） - 字段值

• $ extra（mixed） - 要作为数组或字符串添加到标记的额外属性

返回：HTML文件上传输入字段标记

返回类型：字符串

这个函数在所有方面都与上面的[`form_input（）`]（about：blank＃form_input）函数相同，除了它使用“file”输入类型，允许它用于上传文件。

form_textarea([$data = ''[, $value = ''[, $extra = '']]])

• $ data（array） - 字段属性数据

• $ value（字符串） - 字段值

• $ extra（mixed） - 要作为数组或字符串添加到标记的额外属性

Returns:  An HTML textarea tag

Return type:  string

This function is identical in all respects to the [`form_input()`](about:blank#form_input) function above except that it generates a “textarea” type.

注

取而代之的是的最大长度和尺寸在上面的例子中的属性，你反而会指定行和COLS。

form_dropdown([$name = ''[, $options = array()[, $selected = array()[, $extra = '']]]])

• $ name（字符串） - 字段名称

• $ options（array） - 要列出的选项的关联数组

• $ selected（array） - 用选定属性标记的字段列表

• $ extra（mixed） - 要作为数组或字符串添加到标记的额外属性

Returns:  An HTML dropdown select field tag

Return type:  string

让您创建一个标准的下拉字段。第一个参数将包含字段的名称，第二个参数将包含选项的关联数组，第三个参数将包含您希望选择的值。您还可以通过第三个参数传递多个项目的数组，CodeIgniter将为您创建一个多选项。

例子：

''''''''小号衬衫'，'med'=>'中型衬衫'，'大号'=>'大号衬衫'，'xlarge'=>'超大号衬衫'，）; $ shirts_on_sale = array（'small'，'large'）; echo form_dropdown（'shirts'，$ options，'large'）; / *会产生：<select name =“shirts”> <option value =“small”> Small Shirt </ option> <option value =“med”> Medium Shirt </ option> <option value =“large”selected = “selected”> Large Shirt </ option> <option value =“xlarge”>超大衬衫</ option> </ select> * / echo form_dropdown（'shirts'，$ options，$ shirts_on_sale）; / *会产生：<select name =“shirts”multiple =“multiple”> <option value =“small”selected =“selected”>小衬衫</ option> <option value =“med”> Medium Shirt </ option > <选项值=“大”选中=“选定”>大衬衫</ option> <选项值=“xlarge”>超大衬衫</ option> </ select> * /

如果您希望打开的<select>包含其他数据（如id属性或JavaScript），则可以将它作为字符串传递给第四个参数：

$ js ='id =“shirts”onChange =“some_function（）;”'; echo form_dropdown（'shirts'，$ options，'large'，$ js）;

也可以将其作为数组传递：

$ js = array（'id'=>'shirts'，'onChange'=>'some_function（）;'）; echo form_dropdown（'shirts'，$ options，'large'，$ js）;

如果数组作为$options是多维数组，那么form_dropdown()会产生一个<optgroup>以数组键作为标签。

form_multiselect([$name = ''[, $options = array()[, $selected = array()[, $extra = '']]]])

• $ name（字符串） - 字段名称

• $ options（array） - 要列出的选项的关联数组

• $ selected（array） - 用选定属性标记的字段列表

• $ extra（mixed） - 要作为数组或字符串添加到标记的额外属性

Returns:  An HTML dropdown multiselect field tag

Return type:  string

让您创建一个标准的多选字段。第一个参数将包含字段的名称，第二个参数将包含选项的关联数组，第三个参数将包含您希望选择的一个或多个值。

参数用法与form_dropdown()上面的使用方法相同，当然除了字段的名称需要使用POST数组语法，例如foo []。

form_fieldset([$legend_text = ''[, $attributes = array()]])

• $ legend_text（string） - 放入<legend>标签的文本

• $ attributes（array） - 要在<fieldset>标签上设置的属性

Returns:  An HTML fieldset opening tag

Return type:  string

让您生成fieldset / legend字段。

例子：

echo form_fieldset（'地址信息'）; 回声“<p>此处的字段集内容</ p> \ n”; echo form_fieldset_close（）; / *生成：<fieldset> <legend>地址信息</ legend> <p>在此处填写内容</ p> </ fieldset> * /

与其他函数类似，如果您希望设置其他属性，则可以在第二个参数中提交关联数组：

$ attributes = array（'id'=>'address_info'，'class'=>'address_info'）; echo form_fieldset（'Address Information'，$ attributes）; 回声“<p>此处的字段集内容</ p> \ n”; echo form_fieldset_close（）; / *产生：<fieldset id =“地址\ _info”class =“地址\ _info”> <legend>地址信息</ legend> <p>在这里表示内容</ p> </ fieldset> * /

form_fieldset_close([$extra = ''])

• $额外（字符串） -任何给结束标记之后追加，如 返回：HTML字段集结束标记返回类型：字符串产生一个结束</字段集>标记。使用此功能的唯一好处是它允许您将数据传递给它，并将其添加到标签下方。例如$ string ='</ div> </ div>'; echo form_fieldset_close（$ string）; //产生：</ fieldset> </ div> </ div> form_checkbox([$data = ''[, $value = ''[, $checked = FALSE[, $extra = '']]]])参数：$ data（array） - 字段属性数据$ value（字符串） - 字段值$ checked（bool） - 是否将复选框标记为选中$ extra（mixed） - 要作为数组或字符串添加到标记的附加属性stringReturns：HTML复选框输入tagReturn类型：string

• $ data（array） - 字段属性数据

• $ value（字符串） - 字段值

• $ checked（bool） - 是否将复选框标记为被选中

• $ extra（mixed） - 要作为数组或字符串添加到标记的额外属性

Returns:  An HTML checkbox input tag

Return type:  string

让你生成一个复选框字段。简单的例子：

echo form_checkbox（'newsletter'，'accept'，TRUE）; //会产生：<input type =“checkbox”name =“newsletter”value =“accept”checked =“checked”/>

第三个参数包含一个布尔值true/false，以确定是否应该选中该框。

与此助手中的其他表单函数类似，您还可以将属性数组传递给该函数：

$ data = array（'name'=>'newsletter'，'id'=>'newsletter'，'value'=>'accept'，'checked'=> TRUE，'style'=>'margin：10px'） ; echo form_checkbox（$ data）; //会产生：<input type =“checkbox”name =“newsletter”id =“newsletter”value =“accept”checked =“checked”style =“margin：10px”/>

与其他函数一样，如果希望标记包含JavaScript之类的其他数据，则可以在第四个参数中将其作为字符串传递：

$ js ='onClick =“some_function（）”'; echo form_checkbox（'newsletter'，'accept'，TRUE，$ js）;

也可以将其作为数组传递：

$ js = array（'onClick'=>'some_function（）;'）; echo form_checkbox（'newsletter'，'accept'，TRUE，$ js）;

form_radio([$data = ''[, $value = ''[, $checked = FALSE[, $extra = '']]]])

• $ data（array） - 字段属性数据

• $ value（字符串） - 字段值

• $ checked（bool） - 是否将单选按钮标记为正在检查

• $ extra（mixed） - 要作为数组或字符串添加到标记的额外属性

Returns:  An HTML radio input tag

Return type:  string

除了使用“radio”输入类型之外，这个函数在所有方面与[`form_checkbox（）`]（about：blank＃form_checkbox）函数完全相同。

form_label([$label_text = ''[, $id = ''[, $attributes = array()]]])

• $ label_text（string） - 放在<label>标签中的文本

• $ id（字符串） - 我们为其制作标签的表单元素的ID

• $ attributes（mixed） - HTML属性

Returns:  An HTML field label tag

Return type:  string

让你生成一个<label>。简单的例子：

echo form_label（'你的名字是什么'，'用户名'）; //会产生：<label for =“username”>什么是您的名字</ label>

与其他函数类似，如果您喜欢设置其他属性，则可以在第三个参数中提交关联数组。

例子：

$ attributes = array（'class'=>'mycustomclass'，'style'=>'color：＃000;'）; 回声form_label（'你是什么名字'，'用户名'，$属性）; //会产生：<label for =“username”class =“mycustomclass”style =“color：＃000;”>什么是您的名字</ label>

form_submit([$data = ''[, $value = ''[, $extra = '']]])

• $ data（字符串） - 按钮名称

• $ value（字符串） - 按钮值

• $ extra（mixed） - 要作为数组或字符串添加到标记的额外属性

Returns:  An HTML input submit tag

Return type:  string

让你生成一个标准的提交按钮。简单的例子：

echo form_submit（'mysubmit'，'Submit Post！'）; //会产生：<input type =“submit”name =“mysubmit”value =“提交帖子！” />

与其他函数类似，如果您喜欢设置自己的属性，可以在第一个参数中提交关联数组。第三个参数允许您向表单中添加额外的数据，比如JavaScript。

form_reset([$data = ''[, $value = ''[, $extra = '']]])

• $ data（字符串） - 按钮名称

• $ value（字符串） - 按钮值

• $ extra（mixed） - 要作为数组或字符串添加到标记的额外属性

返回：HTML输入重置按钮标记

Return type:  string

让您生成一个标准的重置按钮。使用与`form_submit（）`相同。

form_button([$data = ''[, $content = ''[, $extra = '']]])

• $ data（字符串） - 按钮名称

• $ content（string） - 按钮标签

• $ extra（mixed） - 要作为数组或字符串添加到标记的额外属性

Returns:  An HTML button tag

Return type:  string

让你生成一个标准的按钮元素。您可以最低限度地传递第一个和第二个参数中的按钮名称和内容：

echo form_button（'name'，'content'）; //将产生：<button name =“name”type =“button”> Content </ button>

也可以传递一个关联数组，该数组包含您希望窗体包含的任何数据：

$ data = array（'name'=>'button'，'id'=>'button'，'value'=>'true'，'type'=>'reset'，'content'=>'Reset'） ; echo form_button（$ data）; //产生：<button name =“button”id =“button”value =“true”type =“reset”> Reset </ button>

如果希望表单包含一些附加数据，如JavaScript，则可以将其作为字符串传递到第三个参数中：

$ js ='onClick =“some_function（）”'; echo form_button（'mybutton'，'Click Me'，$ js）;

form_close([$extra = ''])

• $extra (string) – Anything to append after the closing tag, as is Returns: An HTML form closing tag Return type: string Produces a closing </form> tag. The only advantage to using this function is it permits you to pass data to it which will be added below the tag. For example: $string = '</div></div>'; echo form_close($string // Would produce: </form> </div></div> set_value($field[, $default = ''[, $html_escape = TRUE]])Parameters:$field (string) – Field name $default (string) – Default value $html_escape (bool) – Whether to turn off HTML escaping of the valueReturns:Field valueReturn type:string

• $ field（string） - 字段名称

• $ default（string） - 默认值

• $ html_escape（bool） - 是否关闭HTML值的转义

Returns:  Field value

Return type:  string

允许您设置输入表单或textarea的值。您必须通过函数的第一个参数提供字段名称。第二个（可选）参数允许您为表单设置默认值。第三个（可选）参数允许您关闭HTML转义值，以防需要将此函数与ie [`form_input（）`]（about：blank＃form_input）结合使用并避免双重转义。

例子：

<input type =“text”name =“quantity”value =“<？php echo set \ _value（'quantity'，'0'）;？>”size =“50”/>

当首次加载时，上述表单将显示“0”。

注

如果您已经加载了表单验证库并设置了与此助手一起使用的字段名的验证规则，然后将调用转发给表单验证库自己的set_value()方法。否则，此函数将在$_POST字段值。

set_select($field[, $value = ''[, $default = FALSE]])

• $ field（string） - 字段名称

• $ value（string） - 要检查的值

• $ default（string） - 该值是否也是默认值

Returns:  ‘selected’ attribute or an empty string

Return type:  string

如果您使用<select>菜单，则此功能允许您显示所选的菜单项。

第一个参数必须包含选择菜单的名称，第二个参数必须包含每个项目的值，第三个（可选）参数允许您将项目设置为默认值（使用布尔值TRUE / FALSE）。

例子：

<select name =“myselect”> <option value =“one”<？php echo set \ _select（'myselect'，'one'，TRUE）; ？>>一个</ option> <option value =“two”<？php echo set \ _select（'myselect'，'two'）; ？>>两个</ option> <option value =“three”<？php echo set \ _select（'myselect'，'three'）; ？>>三</ option> </ select>

set_checkbox($field[, $value = ''[, $default = FALSE]])

• $ field（string） - 字段名称

• $ value（string） - 要检查的值

• $ default（string） - 该值是否也是默认值

Returns:  ‘checked’ attribute or an empty string

Return type:  string

允许您以提交状态显示复选框。

第一个参数必须包含复选框的名称，第二个参数必须包含其值，第三个（可选）参数允许您将项目设置为默认值（使用布尔值TRUE / FALSE）。

例子：

<input type =“checkbox”name =“mycheck”value =“1”<？php echo set \ _checkbox（'mycheck'，'1'）; ？> /> <input type =“checkbox”name =“mycheck”value =“2”<？php echo set \ _checkbox（'mycheck'，'2'）; ？> />

set_radio($field[, $value = ''[, $default = FALSE]])

• $ field（string） - 字段名称

• $ value（string） - 要检查的值

• $ default（string） - 该值是否也是默认值

Returns:  ‘checked’ attribute or an empty string

Return type:  string

允许您以提交状态显示单选按钮。这个函数与上面的``set_checkbox（）`]（about：blank＃set_checkbox）函数相同。

例子：

<input type =“radio”name =“myradio”value =“1”<？php echo set \ _radio（'myradio'，'1'，TRUE）; ？> /> <input type =“radio”name =“myradio”value =“2”<？php echo set \ _radio（'myradio'，'2'）; ？> />

注

如果您使用的是表单验证类，则必须始终为您的字段指定规则，即使为空，以便set_*()功能开始工作。这是因为如果定义了表单验证对象，则set_*()传递给类的方法，而不是泛型助手函数。

form_error([$field = ''[, $prefix = ''[, $suffix = '']]])

• $ field（string） - 字段名称

• $ prefix（string） - 打开标签时出错

• $ suffix（string） - 错误结束标记

返回：HTML格式的表单验证错误消息（s）

Return type:  string

从[Form Validation Library]（../ libraries / form_validation）返回验证错误消息，与指定的字段名称关联。您可以选择指定打开和关闭标签以放置错误消息。

例子：

//假设'username'字段值不正确：echo form_error（'myfield'，'<div class =“error”>'，'</ div>'）; //将产生：<div class =“error”>与“用户名”字段相关联的错误消息。</ div>

validation_errors([$prefix = ''[, $suffix = '']])

• $ prefix（string） - 打开标签时出错

• $ suffix（string） - 错误结束标记

返回：HTML格式的表单验证错误消息（s）

Return type:  string

与[`form_error（）`]（about：blank＃form_error）函数类似，返回由[Form Validation Library]（../ libraries / form_validation）生成的所有验证错误消息，每个消息周围都有可选的开始和结束标记消息。

例子：

echo validation_errors（'<span class =“error”>'，'</ span>'）; / *会产生，例如：<span class =“error”>“email”字段不包含有效的电子邮件地址！</ span> <span class =“error”>“password”字段doesn' t匹配“repeat_password”字段！</ span> * /

form_prep($str)

• $ str（string） - 要转义的值

返回：转义值

Return type:  string

允许您安全地在表单元素中使用HTML和字符（如引号），而不会破坏表单。

注

如果您使用此页面中列出的任何表单帮助函数，则表单值将自动准备，因此不需要调用此函数。只有在创建自己的表单元素时才使用它。

注

这个函数是不推荐的，它只是一个别名。公共函数html_escape()-请用这个代替。