Cakephp FormHelper表单输入

最新推荐文章于 2021-03-13 02:11:02 发布

小毛杨

最新推荐文章于 2021-03-13 02:11:02 发布

阅读量2.6k

点赞数

分类专栏： php 文章标签： cakephp FormHelper

php 专栏收录该内容

1 篇文章

订阅专栏

本文详细介绍了CakePHP框架中的FormHelper组件，包括快速创建表单、表单元素的生成、自定义表单样式和行为，以及如何处理表单提交后的逻辑。重点覆盖了表单的创建、输入元素的配置、结束表单的方法、特定类型输入的使用，以及高级选项的设置，旨在帮助开发者高效地构建动态交互式的表单。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

class FormHelper(View $view, array $settings = array())

FormHelper注重于快速创建表单，完成表单创建大部分工作。FormHelper较灵活，可以完成几乎所有你想要的表单格式创建，只需通过自带的简单方法。

1. 创建Form

首先，创建表单时，调用FormHelper第一个方法create()，输出一个开放的表单标记：

FormHelper::create(string $model = null, array $options = array())，注意事项：

l 所有的参数都是可选的，如果调用时无参数输入，表单默认提交到当前Controller和当前action。

l 表单默认创建提交格式为“POST”。

l 表单元素依旧存在Dom id值，id内容包括当前Controller和action值。

假如在UserController界面中调用create()函数，则在界面中导入如下内容：

注：也可以设置model = false。这将会表单数据提交到数组：$this->request->data（而不是$this->request->data['Model'])。这种方便的简写形式，可能无法代表数据库中的任何字段。

通过设置Create()参数，可以得到各式各样的表单格式。首先，通过设置$model参数，及创建了一个Form区。所有的字段被假定为属于该Model（除非另行规定）。如果不设定Model，默认为与当前Controller相关的model。

//在 /recipes/add中输入

echo $this->Form->create('Recipe');

则，输入HTML内容为：

上述代码标明，Form以Post方式提交数据到RecipeController中add action。当然，我们也可以以相同的方式创建用于编辑的Form。FormHelper使用$this->request->data属性可判断是否创建了一个add或edit表单。如果$this->request->data包含以当前Model命名的数组或数据主键非空值，FormHelper将会创建一个编辑表单。比如，浏览http://localhost/recipes/edit/5, 得到:

// Controller/RecipesController.php:

public function edit($id = null) {

if (empty($this->request->data)) {

$this->request->data = $this->Recipe->findById($id);

} else {

// Save logic goes here

}

// View/Recipes/edit.ctp:

// Since $this->request->data['Recipe']['id'] = 5,

// we will get an edit form

<?php echo $this->Form->create('Recipe'); ?>

输出HTML内容：

由于这是一个编辑表单，一个隐藏的输入字段覆盖默认的HTTP方法。

当创建的plugins中Model时，要使用正确的插件语法。比如：

echo $this->Form->create('ContactManager.Contact');

1.1 Options参数

$ options数组包含多个不同的键 - 值影响生成的form格式。

注：Form默认的提交Url是当前Url路劲，在2.0版本以后，可通过设置$options['url']参数进行自定义更改。

$options参数有很多，下面将一一介绍。

l $options['type']：设置Form提交方式。有效值包括“‘post’, ‘get’, ‘file’, ‘put’ and ‘delete’”。

echo $this->Form->create('User', array('type' => 'get'));

输出HTML内容：

指定type = ‘file’时，表单提交方式为post，在表单标签中包含属性enctype="multipart/form-data"，用于文件的提交，确保文件上传成功。

echo $this->Form->create('User', array('type' => 'file'));

输出HTML内容：

<form id="UserAddForm" enctype="multipart/form-data"

method="post" action="/users/add">

当type=’put’或‘delete’时，表格格式与post格式相同，只是在提交的时候HTTP请求方法将“PUT”或“DELETE”，使得CakePHP实现模仿正确的REST支持的Web浏览器。

l $options['action']：From提交之后指向当前Controller下action路径。

echo $this->Form->create('User', array('action' => 'login'));

输出HTML内容:

l $options['url']：当需要设置Form提交后不指向当前Controller下action，就需要设置该参数来实现。比如：、

echo $this->Form->create(null, array(

'url' => array('controller' => 'recipes', 'action' => 'add')

));

输出HTML内容（指向RecipeController下的add action）:

或者指向远程域：

echo $this->Form->create(null, array(

'url' => 'http://www.google.com/search',

'type' => 'get'

));

输出HTML内容（指向远程域）:

更多url格式设置请参考HtmlHelper：：url内容。

l $options['default']：当设置此参数为false时，点击表单提交按钮，不提交表单到Controller。而是通过AJAX方式提交数据。

l $options['inputDefaults']：设置表单输入属性。

echo $this->Form->create('User', array(

'inputDefaults' => array(

'label' => false,

'div' => false

)

));

在'inputDefaults' 设置之后的所有input将继承其为默认属性。我们也可以通过在input（）设置option参数来覆盖默认设置：

echo $this->Form->input('password'); // div = false; label = false ;No div, no label

// has a label element

echo $this->Form->input(

'username',

array('label' => 'Username') //override

);

2. Form结尾

方法：FormHelper::end($options = null, $secureAttributes = array())

<?php echo $this->Form->create(); ?>

<?php echo $this->Form->end(); ?>

表单通过end()方法结束，通常end()只输出一个结束标签，但是，通过设置end()中参数，end()可以插入SecurityComponent要求的隐藏表单元素。

如果一个字符串作为end（）的第一个参数，则输出提交按钮，值为该字符串，并包含Form结束标签，如下：

<?php echo $this->Form->end('Finish'); ?>

输出HTML内容：

</div>

</form>

我们也可以传递字符串到end()参数：

$options = array(

'label' => 'Update',

'div' => array(

'class' => 'glass-pill',

)

);

echo $this->Form->end($options);

输出HTML内容：

</div>

注：如果在表单应用中使用SecurityComponent，表单必须以end()结尾。

3. 创建表单元素

有多种方法创建表单元素，先从input()开始介绍。方法自动检测输入field，创建field对应表单元素。

3.1 方法input（）

方法：FormHelper::input(string $fieldName, array $options = array())

通过设置fieldName参数，设置如下表单元素和属性：

l Div

l Label属性

l Input 属性

l Error 属性（如果适用）

Input输入类型需通过设置列的输入类型来实现：

输入类型	Form输入域类型
string (char, varchar, etc.)	text
boolean, tinyint(1)	checkbox
text	textarea
text, with name of password, passwd, or psword	password
text, with name of email	email
text, with name of tel, telephone, or phone	tel
date	day, month, and year selects
datetime, timestamp	day, month, year, hour, minute, and meridian selects
time	hour, minute, and meridian selects
binary	file

$options参数允许自定义如何input（）属性。Div包含所添加的input元素，自动导入(除设置allowEmpty => true)该Model中由required设置的输入参数属性，并直接关联到create()。

2.3版本以后，HTML5中required设置增加到input()的输入有效性验证。可以在$option中设置并覆盖Model中的设置。如果要跳过浏览器验证输入合法性，需通过FormHelper::submit() $option设置'formnovalidate' => true或在Create() $option中设置'novalidate' => true实现。

比如，用户模型包括'username'（数据类型为varchar）字段，'password'（VARCHAR），'approved'（日期时间）和'quote'（文本）。使用FromHelper的input（）为字段创建合适的输入：

echo $this->Form->create();

echo $this->Form->input('username'); //text

echo $this->Form->input('password'); //password

echo $this->Form->input('approved'); //day, month, year, hour, minute,

//meridian

echo $this->Form->input('quote'); //textarea

echo $this->Form->end('Add');

更详细的日期输入设置：

echo $this->Form->input('birth_dt', array(

'label' => 'Date of birth',

'dateFormat' => 'DMY',

'minYear' => date('Y') - 70, //70 years ago

'maxYear' => date('Y') - 18,//18 years ago

));

除了部分下面介绍的$option属性外，可以给input()设置任何HTMl属性（例如onfocus事件）。更多信息请查看HtmlHelper中$htmlAttributes。

假设User Model与Group Model关系为HABTM，在Controller中设置多级变量。比如：

$this->set('groups', $this->User->Group->find('list'));

在View文件中，通过以下方式可自动创建select多项选择：

echo $this->Form->input('Group');

假如，数据表之间关系为hasOne或belongTO关系，需要为其创建select多项选择form。在Controller中使用如下代码（User belongTo group）

$this->set('groups', $this->User->Group->find('list'));

然后, 在view文件Form内:

echo $this->Form->input('group_id');

如果Model名称包含多个单词，Model名称则必须首字母大写，set时，变量第一个单词小写，后续单词首字母大写。如下：

$this->set('userGroups', $this->UserGroup->find('list'));

// or

$this->set(

'reallyInappropriateModelNames',

$this->ReallyInappropriateModelName->find('list')

);

注：尽量避免使用input()创建submit提交按钮，使用submit()代替。

3.2 方法inputs（）

方法：FormHelper::inputs（）(mixed $fields = null, array $blacklist = null, $options = array())

为$fields内容创建input表格输入，如果$fields和$blacklist都为空，默认创建当前Model包含的所有字段input。

除了包含字段input，$fields通过 fieldset 和 legend属性设置界面fieldset 和 legend属性$this->Form->inputs(array('legend' => 'My legend')); 将产生默认的'legend' 属性。可通过$fields设置自定义的个性输入。

echo $this->Form->inputs(array(

'name' => array('label' => 'custom label')

));

除了这些字段控制，inputs（）允许你使用一些额外的选项。

l fieldset设置为false禁用字段集。如果设置为字符串，则为该字段元素名称。

l legend设置为false来禁用输入图例。设置为字符串提供一个字符串自定义图例文本。

3.3 域名约定

FormHelper非常智能，当你使用它创建一个表单输入，其就会根据当前Model创建表单输入，格式如下：

如果创建相同的字段名，创建Model表单数组，Controller保存时使用saveAll()，创建格式如下：

echo $this->Form->input('Modelname.0.fieldname');

echo $this->Form->input('Modelname.1.fieldname');

输出HTML内容:

<input type="text" id="Modelname0Fieldname"

name="data[Modelname][0][fieldname]">

<input type="text" id="Modelname1Fieldname"

name="data[Modelname][1][fieldname]">

FormHelper可使用多种Model内部后缀的方式实现日期输入，如果使用year, month, day, hour, minute, or meridian时出现内容获取问题，请设置name属性覆盖其默认状态，如下：

echo $this->Form->input('Model.year', array(

'type' => 'text',

'name' => 'data[Model][year]'

));

3.4 Options设置

FormHelper::input()支持很多输入选项设置，除了input()选项支持设置输入type外，支持HTML表格输入的所有选项设置。下面将一一介绍。

l $options['type']：设置输入类型，除了创建表单中类型，还包括‘file’，‘password’，以及HTML5包含的所有类型。

echo $this->Form->input('field', array('type' => 'file'));

echo $this->Form->input('email', array('type' => 'email'));

输出HTML内容:

<label for="UserField">Field</label>

</div>

<label for="UserEmail">Email</label>

</div>

l $options['div']：设置包含输入表单的div属性，字符串将设置div类名，数组将设置div属性，键-值属性。或设置为false，禁用div。

设置类名，如下：

echo $this->Form->input('User.name', array(

'div' => 'class_name'

));

输出HTML内容：

</div>

设置很多div属性格式：

echo $this->Form->input('User.name', array(

'div' => array(

'id' => 'mainDiv',

'title' => 'Div Title',

'style' => 'display:block'

)

));

输出HTML内容：

<div class="input text" id="mainDiv" title="Div Title"

style="display:block">

</div>

禁用div输出：

echo $this->Form->input('User.name', array('div' => false)); ?>

输出HTML内容：

l $options['label']：设置输入表格显示的字符串标签。

echo $this->Form->input('User.name', array(

'label' => 'The User Alias'

));

输出HTML内容：

<label for="UserName">The User Alias</label>

</div>

设置为false，禁用输入标签。

echo $this->Form->input('User.name', array('label' => false));

输出HTML内容：

</div>

设置为数组，自定义标签的附加选项：

echo $this->Form->input('User.name', array(

'label' => array(

'class' => 'thingy',

'text' => 'The User Alias'

)

));

输出HTML内容：

<label for="UserName" class="thingy">The User Alias</label>

</div>

l $options['error']：设置输入内容格式不正确显示信息。设置为false时，禁用错误信息显示。

$this->Form->input('Model.field', array('error' => false));

如只禁用错误信息，保存字段，设置errorMessage键为false。

$this->Form->input('Model.field', array('errorMessage' => false));

注：2.3版本之后，才包含'errorMessage' 属性设置。

如设置其他包含的属性或class，使用如下格式：

$this->Form->input('Model.field', array(

'error' => array(

'attributes' => array('wrap' => 'span', 'class' => 'bzzz')

)

));

为了防止HTML中的错误信息输出被自动转义，设置子选项escape为false：

$this->Form->input('Model.field', array(

'error' => array(

'attributes' => array('escape' => false)

)

));

覆盖Model错误消息，使用相匹配验证规则名称的键-值：

$this->Form->input('Model.field', array(

'error' => array('tooShort' => __('This is not long enough'))

));

通过上述内容，可以为Model中validation规则设置错误信息。此外，也可以设置国际规则信息。

l $options['before'], $options['between'], $options['separator'], and $options['after']

输入表单中如果需要添加标记（在界面中显示），请使用这些方法。

echo $this->Form->input('field', array(

'before' => '--before--',

'after' => '--after--',

'between' => '--between---'

));

输出HTML内容：

--before--

<label for="UserField">Field</label>

--between---

--after--

</div>

对于radio输入表单，设置separator属性标记分隔每个input/label对：

echo $this->Form->input('field', array(

'before' => '--before--',

'after' => '--after--',

'between' => '--between---',

'separator' => '--separator--',

'options' => array('1', '2')

));

输出HTNL内容：

--before--

--separator--

--between---

--after--

</div>

对于date 和datetime 类型，设置“separator”改变元素之间的字符串。默认为' - '。

l $options['format']：控制Formhelper生成的HTML格式。‘format’支持描述模板。支持的数组有：array('before', 'input', 'between', 'label', 'after','error').

l $options['inputDefaults']：设置表单输入的默认格式。

echo $this->Form->create('User', array(

'inputDefaults' => array(

'label' => false,

'div' => false

)

));

从设置之后的所有输入表单继承'inputDefaults' 声明的属性。后续也可单独设置覆盖其默认属性。

// No div, no label

echo $this->Form->input('password');

// has a label element

echo $this->Form->input('username', array('label' => 'Username'));

如果需要更改默认设置，使用FormHelper:: inputDefaults（）方法。

4. 特定类型input

除input（）外，FormHelper 可产生多个不同类型input方法。这些可以是input自身，也可以结合其他方法，如label（）和error（），产生完全定制的表单格式。

4.1 常用选项

许多不同的input元素支持一组通用的选项设置。所有这些选项都被input（）支持。为减少重复介绍，这里只介绍一次，所有元素共有的选项如下：

l $options['class']：设置class属性。

echo $this->Form->input('title', array('class' => 'custom-class'));

l $options['id']：设置DOM id属性。

l $options['default']：设置默认值。

echo $this->Form->input('ingredient', array('default' => 'Sugar'));

例如在select中，设置默认值为Medium：

$sizes = array('s' => 'Small', 'm' => 'Medium', 'l' => 'Large');

echo $this->Form->input(

'size',

array('options' => $sizes, 'default' => 'm')

);

注：不可以通过'default'设置checkbox默认值。可通过在Controller中设置$this->request->data或设置器checked选项为true和false实现。

日期和日期时间通过设置“selected”选项来设置默认值。请勿设置'default' => false， false值用来禁止输入字段的选择，所以“default”=> false无意义。使用“default'”=>0。

除了上述选项设置，还可以设置任何HTML中包含的属性。

4.2 select, checkbox 和 radio选项设置

l $options['selected']：选择型输入表单中（select, date, time, datetime），设置选中默认值。

echo $this->Form->input('close_time', array(

'type' => 'time',

'selected' => '13:30:00'

));

l $options['empty']：设置为true，默认输入为空

在select中，设置为true，默认输入为空，当设置为字符串值时，默认显示为字符串内容。

echo $this->Form->input('field', array(

'options' => array(1, 2, 3, 4, 5),

'empty' => '(choose one)'

));

输出HTNL内容:

<label for="UserField">Field</label>

<option value="">(choose one)</option>

</select>

</div>

如果需要在password字段中设置默认值空白，使用'value'=>''代替。

l $options['hiddenField']：某些输入类型（checkboxes, radios），隐藏的input即使没有值，在Controller中调用 $this->request->data方法，内容还是存在的。

<input type="hidden" name="data[Post][Published]" id="PostPublished_"

value="0" />

<input type="checkbox" name="data[Post][Published]" value="1"

id="PostPublished" />

取消设置 $options['hiddenField'] = false:

echo $this->Form->checkbox('published', array('hiddenField' => false));

输出HTML内容：

<input type="checkbox" name="data[Post][Published]" value="1"

id="PostPublished" />

如果在表单中创建一个组合形式的input。除了第一个input不需设置该选项外，其他input都请设置该选项。如果hidden input在表单中出现了多次，则只有最后一组内容才被保存提交。

下面例子中，只有第三个颜色值会被传递过去，而原色值将被覆盖：

<h2>Primary Colors</h2>