类 FormHelper

缺少方法处理程序 - 实现各种简单的输入类型。用于创建各种类型的输入。例如，$this->Form->text(); 将创建 <input type="text">，而 $this->Form->range(); 将创建 <input type="range">

用法

$this->Form->search('User.query', ['value' => 'test']);

将生成类似于以下内容的 input：

<input type="search" id="UserQuery" name="User[query]" value="test">

input 类型的第一个参数应始终为字段名，格式为 Model.field。第二个参数应始终为 input 的属性数组。

参数

返回值

抛出

构造小部件并绑定默认上下文提供程序

参数

返回一个可用于描述此对象内部状态的数组。

返回值

懒加载助手。

参数

返回值

清除存储的 ID 后缀。

返回值

删除单个配置键。

参数

返回值

抛出

读取配置键。

参数

返回值

写入配置键。

参数

返回值

抛出

返回一个字符串，用作确认对话框的 onclick 处理程序。

参数

返回值

如果请求数据存在，则返回 CSRF 输入。用于与 CsrfMiddleware 结合使用来保护表单。

返回值

生成适合在 ID 属性中使用的 ID。

参数

返回值

从选项数组中提取单个选项。

参数

返回值

根据选项创建表单的 URL。

参数

返回值

查找与数据匹配的上下文提供程序。

如果无法匹配类型，则将返回 NullContext。

参数

返回值

抛出

获取 FormProtector 的 Session id 必须与 FormProtectionComponent 中的相同

返回值

生成输入元素

参数

返回值

为输入生成标签

参数

返回值

生成组模板元素

参数

返回值

为元素生成 ID 属性。

确保给定字段集的 ID 是唯一的。

参数

返回值

生成 ID 后缀。

确保给定字段集的 ID 是唯一的。

参数

返回值

设置字段默认值并将字段添加到表单安全输入哈希中。如果字段包含验证错误，还将添加错误类。

选项

• secure - boolean - 字段是否应该添加到安全字段中。使用disabled选项禁用字段，也将省略该字段成为散列密钥的一部分。
• default - mixed - 如果表单上下文中没有值，要使用的值。
• disabled - mixed - 布尔值表示禁用状态，或者数字索引值中的字符串。
• id - mixed - 如果为true，它将根据字段名称自动生成。

此方法会将数字索引的“disabled”转换为关联数组值。FormHelper 的内部组件需要关联选项。

此函数的输出是更完整的输入属性集，可以传递给表单小部件以生成实际的输入。

参数

返回值

生成输入容器模板

参数

返回值

为 input() 调用生成标签。

$options 可以包含 ID 覆盖的哈希。如果存在，这些覆盖将用于代替生成的价值。

参数

返回值

返回为提供的 fieldName 推测的输入类型，基于它关联的内部类型、它的名称以及可以在视图模板中找到的变量

参数

返回值

确定字段是否被禁用。

参数

返回值

正确存储最后一个创建的表单操作 URL。

参数

返回值

神奇地设置选项类型和相应的选项

参数

返回值

如果存在，则选择包含选择字段选项的变量，并将值设置为选项数组中的 'options' 键。

参数

返回值

生成输入选项数组

参数

返回值

将给定的类添加到元素选项中

参数

返回值

添加新的上下文类型。

表单上下文类型允许 FormHelper 与来自 CakePHP 外部的提供程序交互。例如，如果您想使用像 Doctrine 这样的替代 ORM，您可以创建并连接一个新的上下文类，以允许 FormHelper 从 Doctrine 读取元数据。

参数

返回值

向 FormHelper 添加新的小部件。

允许您使用自定义代码添加或替换小部件实例。

参数

返回值

为 $fields 生成一组控件。如果 $fields 为空，将使用当前模型的字段。

您可以通过$fields自定义单个控件。

$this->Form->allControls([
  'name' => ['label' => 'custom label']
]);

您可以通过将字段指定为false来排除字段

$this->Form->allControls(['title' => false]);

在上面的示例中，不会为 title 字段生成任何字段。

参数

返回值

链接

创建 <button> 标签。

选项

• type - 按钮的“type”属性的值。默认为“submit”。
• escapeTitle - 对按钮的标题进行 HTML 实体编码。默认为 true。
• escape - 对按钮标签的属性进行 HTML 实体编码。默认为 true。
• confirm - 要显示的确认消息。只有在确认后才会继续执行表单。

参数

返回值

链接

创建复选框输入小部件。

选项

• value - 复选框的值
• checked - 布尔值表示此复选框已选中。
• hiddenField - boolean|string。设置为 false 以禁用生成隐藏输入。传递字符串将定义隐藏输入的值。
• disabled - 创建一个禁用的输入。
• default - 为复选框设置默认值。这允许您开始将复选框选中，而无需检查 POST 数据。匹配的 POST 数据值将覆盖默认值。

参数

返回值

链接

将提供的配置与现有配置合并。与 config() 对嵌套键进行递归合并不同，此方法执行简单合并。

设置特定值

$this->configShallow('key', $value);

设置嵌套值

$this->configShallow('some.nested.key', $value);

同时更新多个配置设置

$this->configShallow(['one' => 'value', 'another' => 'value']);

参数

返回值

获取当前表单集的上下文实例。

如果没有活动的表单，将返回 null。

参数

返回值

设置助手将使用的上下文工厂。

参数

返回值

生成一个表单控件元素，包括标签和包装 div。

选项

有关更多信息，请参阅每个字段类型方法。对于不同 **类型** 方法的 $attributes 或 $options 中的任何选项，都可以包含在 control() 的 $options 中。此外，任何不在下面列表中或不在所选类型的选项中的未知键都将被视为生成的输入的常规 HTML 属性。

• type - 强制您想要的部件类型，例如 type => 'select'
• label - 字符串标签或标签选项数组。请参阅 FormHelper::label()。
• options - 对于需要选项的小部件，例如单选按钮、下拉菜单。
• error - 控制产生的错误消息。设置为 false 以禁用任何形式的错误报告（字段错误和错误消息）。
• empty - 字符串或布尔值，以启用空的 select 框选项。
• nestedInput - 与复选框和单选按钮输入一起使用。设置为 false 以将输入渲染在标签元素之外。可以将任何输入设置为 true 以强制输入在标签内。如果您为单选按钮启用此选项，您还需要修改默认的 radioWrapper 模板。
• templates - 您想要用于此输入的模板。任何模板都将合并到已加载的模板之上。此选项可以是 /config 中包含要加载的模板的文件名，也可以是模板数组。
• labelOptions - false 以禁用嵌套小部件（例如单选按钮、多选框）周围的标签，或者标签标签的属性数组。selected 将添加到任何类，例如 class => 'myclass'，其中小部件已选中。

参数

返回值

链接

在 fieldset 元素中生成一组针对 $fields 的控件。

您可以通过$fields自定义单个控件。

$this->Form->controls([
  'name' => ['label' => 'custom label'],
  'email'
]);

参数

返回值

链接

返回一个 HTML 表单元素。

选项

• type 表单方法默认为根据表单上下文自动检测。如果表单上下文的 isCreate() 方法返回 false，则将执行 PUT 请求。
• method 显式设置表单的 method 属性。
• url 表单提交到的 URL。可以是字符串或 URL 数组。
• encoding 为表单设置 accept-charset 编码。默认为 Configure::read('App.encoding')
• enctype 显式设置表单编码。默认情况下，type => file 会将 enctype 设置为 multipart/form-data。
• templates 您想要用于此表单的模板。任何模板都将合并到已加载的模板之上。此选项可以是 /config 中包含要加载的模板的文件名，也可以是模板数组。
• context 上下文类的其他选项。例如，EntityContext 接受一个 'table' 选项，允许您设置表单应基于的特定 Table 类。
• idPrefix 生成的 ID 属性的前缀。
• valueSources 应从中读取值的源。请参阅 FormHelper::setValueSources()
• templateVars 为 formStart 模板提供模板变量。

参数

返回值

链接

创建 FormProtector 实例。

参数

返回值

生成一个类型为“date”的 input 标签。

选项

请参阅 dateTime() 选项。

参数

返回值

生成一个类型为“datetime-local”的 input 标签。

选项

• value | default 输入使用的默认值。如果设置为 true，则将使用当前日期时间。

参数

返回值

创建类型为 day 的 input。

参数

返回值

创建类型为 email 的 input。

参数

返回值

关闭 HTML 表单，清理 FormHelper::create() 设置的值，并在必要时写入隐藏的 input 字段。

将多个 FormHelper::create() 调用之间共享的某些状态部分重置为默认值。

参数

返回值

链接

获取用于 select/radio 选项的枚举值 => 标签映射。

参数

返回值

返回给定表单字段的格式化错误消息，如果没有错误则返回 ''。

使用 error、errorList 和 errorItem 模板。errorList 和 errorItem 模板用于格式化每个字段的多个错误消息。

选项

• escape 布尔值 - 是否对错误内容进行 HTML 转义。

参数

返回值

链接

将一组输入包装在 fieldset 中

参数

返回值

创建文件 input 小部件。

参数

返回值

链接

使用 $data 格式化模板字符串

参数

返回值

返回配置。

用法

读取整个配置

$this->getConfig();

读取特定值

$this->getConfig('key');

读取嵌套值

$this->getConfig('some.nested.key');

读取带有默认值的

$this->getConfig('some-key', 'default-value');

参数

返回值

返回此特定键的配置。

此键的配置值必须存在，不能为 null。

参数

返回值

抛出

获取表单保护器实例。

返回值

从可用来源获取单个字段值。

参数

返回值

获取要使用的模板或特定模板。

参数

返回值

获取值来源。

返回一个包含至少一项的有效源列表，例如：'context'、'data' 和 'query'。

返回值

获取此辅助函数绑定到的视图实例。

返回值

获取辅助函数当前使用的 widget 定位器。

返回值

创建隐藏的 input 字段。

参数

返回值

链接

创建类型为 hour 的 input。

参数

返回值

事件监听器。

通过定义回调方法之一，助手程序被认为对相关事件感兴趣。

如果您需要添加非传统事件监听器，或者您希望助手程序监听非标准事件，请覆盖此方法。

返回值

构造函数钩子方法。

实现此方法以避免覆盖构造函数并调用父类。

参数

返回值

如果给定字段存在错误，则返回 true，否则返回 false

参数

返回值

链接

返回 HTML 表单的格式化 LABEL 元素。

如果未提供 for 属性，则会自动生成 for 属性。

选项

• for - 设置 for 属性，如果未定义，for 属性将使用 FormHelper::_domId() 从 $fieldName 参数生成。
• escape - 设置为 false 以关闭标签文本的转义。默认为 true。

示例

文本和 for 属性根据字段名称生成

echo $this->Form->label('published');
<label for="PostPublished">Published</label>

自定义文本

echo $this->Form->label('published', 'Publish');
<label for="published">Publish</label>

自定义属性

echo $this->Form->label('published', 'Publish', [
  'for' => 'post-publish'
]);
<label for="post-publish">Publish</label>

嵌套输入标签

echo $this->Form->label('published', 'Publish', [
  'for' => 'published',
  'input' => $this->text('published'),
]);
<label for="post-publish">Publish <input type="text" name="published"></label>

如果您想在标签中嵌套输入，则需要修改默认模板。

参数

返回值

链接

创建类型为 meridian 的 input。

参数

返回值

创建类型为 minute 的 input。

参数

返回值

生成一个类型为“month”的 input 标签。

选项

请参阅 dateTime() 选项。

参数

返回值

从选项创建一组复选框。

选项

• escape - 如果为 true，则选项内容将进行 HTML 实体编码。默认为 true。
• val 输入的选择值。
• class - 当使用 multiple = checkbox 时，要应用于 div 的类名。默认为 'checkbox'。
• disabled - 控制禁用属性。当创建复选框时，true 将禁用所有复选框。您还可以将 disabled 设置为要在创建复选框时禁用的值列表。
• hiddenField - 设置为 false 以删除确保始终提交值的隐藏字段。
• label - 为 false 以禁用小部件周围的标签，或为标签标签提供属性数组。例如 'class' => 'myclass'，当小部件被选中时会添加 selected。

可以代替具有 multiple 属性的选择框使用。

参数

返回值

另请参阅

创建类型为 number 的 input。

参数

返回值

创建类型为 password 的 input。

参数

返回值

创建一个 <button> 标签，周围有一个 <form>，默认情况下通过 POST 提交。

此方法创建一个 <form> 元素。因此，不要在已打开的表单中使用此方法。而是使用 FormHelper::submit() 或 FormHelper::button() 在打开的表单中创建按钮。

选项

• data - 包含要传递给隐藏输入的键值对的数组
• method - 要使用的请求方法。设置为 'delete' 或其他值以模拟 HTTP/1.1 DELETE（或其他）请求。默认为 'post'。
• form - 包含 FormHelper::create() 可以接受的任何选项的数组
• 其他选项与 button 方法相同。
• confirm - 要显示的确认消息。只有在确认后才会继续执行表单。

参数

返回值

链接

创建一个 HTML 链接，但使用您指定的 method 访问 URL（默认为 POST）。要求浏览器启用 javascript。

此方法创建一个 <form> 元素。如果您想在现有表单中使用此方法，则必须使用 block 选项，以便将新表单设置为可以渲染在主表单之外的视图块。

如果您要寻找的是一个提交表单的按钮，那么您应该改用 FormHelper::button() 或 FormHelper::submit()。

选项

• data - 包含要传递给隐藏输入的键值对的数组
• method - 要使用的请求方法。设置为 'delete' 以模拟 HTTP/1.1 DELETE 请求。默认为 'post'。
• confirm - 要显示的确认消息。只有在确认后才会继续执行表单。
• block - 设置为 true 以将表单附加到视图块 "postLink" 或提供自定义块名称。
• 其他选项与 HtmlHelper::link() 方法相同。
• 选项 onclick 将被替换。

参数

创建一组单选按钮小部件。

属性

• value - 指示选中此单选按钮时的值。
• label - 为 false 以禁用小部件周围的标签，或为标签标签提供属性数组。例如 'class' => 'myclass'，当小部件被选中时会添加 selected。
• hiddenField - boolean|string。设置为 false 以不包含值为 '' 的隐藏输入。也可以是字符串以设置隐藏输入的值。这对于创建非连续的单选按钮集很有用。
• disabled - 设置为 true 或 disabled 以禁用所有单选按钮。使用值数组来禁用特定单选按钮。
• empty - 设置为 true 以创建一个值为 '' 的输入作为第一个选项。当为 true 时，单选按钮标签将为 'empty'。将此选项设置为字符串以控制标签值。

参数

返回值

链接

恢复 FormHelper 中内置的默认值。

此方法不会重置自定义小部件中设置的任何模板。

返回值

创建类型为 search 的 input。

参数

返回值

生成一个隐藏字段，其中包含基于表单中使用的字段的安全哈希。

如果设置了 $secureAttributes，这些 HTML 属性将被合并到为安全组件生成的隐藏输入标签中。这对于设置像 'form' 这样的 HTML5 属性特别有用。

参数

返回值

返回格式化的 SELECT 元素。

属性

• multiple - 显示一个多选框。如果设置为 'checkbox'，将创建多个复选框。
• empty - 如果为 true，则显示空选项。如果为字符串，则该字符串将显示为空元素。
• escape - 如果为 true，则选项内容将进行 HTML 实体编码。默认为 true。
• val 输入的选择值。
• disabled - 控制 disabled 属性。创建选择框时，设置为 true 将禁用选择框。设置为数组将禁用特定选项元素。

使用选项

一个简单的数组将创建普通的选项

$options = [1 => 'one', 2 => 'two'];
$this->Form->select('Model.field', $options));

而嵌套的选项数组将创建带有选项的选项组。

$options = [
 1 => 'bill',
    'fred' => [
        2 => 'fred',
        3 => 'fred jr.'
    ]
];
$this->Form->select('Model.field', $options);

如果您有多个选项需要具有相同的 value 属性，您可以使用数组的数组来表示这一点

$options = [
    ['text' => 'United states', 'value' => 'USA'],
    ['text' => 'USA', 'value' => 'USA'],
];

参数

返回值

另请参阅

链接

设置配置。

用法

设置特定值

$this->setConfig('key', $value);

设置嵌套值

$this->setConfig('some.nested.key', $value);

同时更新多个配置设置

$this->setConfig(['one' => 'value', 'another' => 'value']);

参数

返回值

抛出

设置 required 属性和自定义验证 JS。

参数

返回值

设置要使用的模板。

参数

返回值

设置值来源。

您需要提供一个或多个有效的源，作为字符串列表。顺序设置优先级。

参数

返回值

抛出

另请参阅

设置辅助函数将使用的 widget 定位器。

参数

返回值

创建提交按钮元素。此方法将生成可用于提交和重置表单的 <input> 元素，方法是使用 $options。可以通过为 $caption 提供图像路径来创建图像提交。

选项

• type - 设置为 'reset' 用于重置输入。默认为 'submit'
• templateVars - 输入元素及其容器的附加模板变量。
• 其他属性将分配给输入元素。

参数

返回值

链接

返回模板器实例。

返回值

创建类型为 text 的 input。

参数

返回值

创建一个 textarea 小部件。

选项

• escape - 文本区域的内容是否应该转义。默认为 true。

参数

返回值

链接

生成一个类型为“time”的 input 标签。

选项

请参阅 dateTime() 选项。

参数

返回值

添加到当前解锁的字段列表中。

已解锁的字段不包含在表单保护字段哈希中。如果控制器中未加载 FormProtectionComponent，则将执行无操作。

参数

返回值

验证值来源。

参数

返回值

抛出

渲染命名的小部件。

这是一个较低级别的函数。对于内置的小部件，您应该使用像 text、hidden 和 radio 这样的函数。如果您使用其他小部件，您应该使用此函数在没有标签或包装 div 的情况下渲染小部件。

参数

返回值

返回用于年份的 SELECT 元素

属性

• empty - 如果为 true，则显示空选项。如果为字符串，则该字符串将显示为空元素。
• order - 选择选项中年份值的排序。可能的值 'asc'、'desc'。默认 'desc'
• value 输入的选定值。
• max 选择元素中要显示的最大年份。
• min 选择元素中要显示的最小年份。

参数

返回值

链接