bupy7/php-html-form

一个基本的、框架无关的表单构建包，包含一些额外的便利功能，例如记住旧输入和检索错误消息。

维护者

详细信息

github.com/bupy7/php-html-form

源代码

问题

安装次数: 16,407

依赖者: 2

建议者: 0

安全性: 0

星标: 5

关注者: 3

分支: 117

开放问题: 0

2.0.3 2023-12-30 13:22 UTC

Requires

  • php: >=5.6

Requires (Dev)

MIT 3d9ce9123574bf049b77fce273ad68bc6b6efe92

  • Adam Wathan <adam.wathan.woop@gmail.com>
  • Vasily Velosloodcev <vasily.belosloodcev.woop@gmail.com>

This package is auto-updated.

Last update: 2024-08-30 01:14:23 UTC

README

这是adamwathan/form的分支。它只包含HTML元素构建器，没有框架支持。扩展支持PHP 5.6到8.x！

Stable Version Build status Coverage Status Total Downloads License

对于一个无聊的包来说，名字太无聊了。使用流畅的、希望直观的语法构建表单HTML。

安装

您可以通过在项目的根目录中终端运行以下命令来使用Composer安装此包

$ composer require bupy7/php-html-form

基本用法

入门

首先，实例化一个表单构建器...

$builder = new AdamWathan\Form\FormBuilder;

然后，使用表单构建器构建一个元素。例如

// <input type="text" name="email" value="example@example.com" required="required">
<?= $builder->text('email')->value('example@example.com')->required(); ?>
  • 所有元素都支持方法链，因此您可以向元素添加所需的所有选项。
  • 所有元素都实现了__toString()，因此无需手动渲染。

打开表单

// <form method="POST">
<?= $builder->open(); ?>

// <form method="GET">
<?= $builder->open()->get(); ?>

// <form method="POST">
// <input type="hidden" name="_method" value="PUT">
<?= $builder->open()->put(); ?>

// <form method="POST">
// <input type="hidden" name="_method" value="DELETE">
<?= $builder->open()->delete(); ?>

// <form method="POST" action="/test">
<?= $builder->open()->action('/test'); ?>

// <form method="POST" action="" enctype="multipart/form-data">
<?= $builder->open()->multipart() ?>

// <form method="POST" action="" enctype="custom">
<?= $builder->open()->encodingType("custom") ?>

文本和密码字段

文本和密码字段共享相同的接口。

// <input type="text" name="email">
<?= $builder->text('email'); ?>

// <input type="text" name="email" id="email_field">
<?= $builder->text('email')->id('email_field'); ?>

// <input type="password" name="password" class="required">
<?= $builder->password('password')->addClass('required'); ?>

// <input type="text" name="email" value="example@example.com" required="required">
<?= $builder->text('email')->value('example@example.com')->required(); ?>

其他可用方法

  • placeholder($string)
  • optional()
  • defaultValue($string)
  • disable()
  • enable()

文本区域

文本区域与常规文本字段具有相同的接口，但有一些额外的有用方法。

// <textarea name="bio" rows="5" cols="50"></textarea>
<?= $builder->textarea('bio')->rows(5); ?>

// <textarea name="bio" rows="10" cols="20"></textarea>
<?= $builder->textarea('bio')->cols(20); ?>

// <textarea name="bio" rows="5" cols="20" class="important">My biography</textarea>
<?= $builder->textarea('bio')->rows(5)->cols(20)->addClass('important')->value('My biography'); ?>

复选框和单选按钮

// <input type="checkbox" name="terms" value="1">
<?= $builder->checkbox('terms'); ?>

// <input type="checkbox" name="terms" value="1" checked="checked">
<?= $builder->checkbox('terms')->check(); ?>

// <input type="checkbox" name="terms" value="1">
<?= $builder->checkbox('terms')->uncheck(); ?>

// <input type="checkbox" name="terms" value="1" checked="checked">
<?= $builder->checkbox('terms')->defaultToChecked(); ?>

// <input type="checkbox" name="terms" value="agree">
<?= $builder->checkbox('terms')->value('agree'); ?>

// <input type="radio" name="color" value="red">
<?= $builder->radio('color', 'red'); ?>

下拉菜单

// <select name="birth_year"></select>
<?= $builder->select('birth_year'); ?>

// <select name="birth_year">
//   <option value="0">1990</option>
//   <option value="1">1991</option>
//   <option value="2">1992</option>
// </select>
<?= $builder->select('birth_year', [1990, 1991, 1992]); ?>

// <select name="birth_year">
//   <option value="1990">1990</option>
//   <option value="1991">1991</option>
//   <option value="1992">1992</option>
// </select>
<?= $builder->select('birth_year', ['1990' => 1990, '1991' => 1991, '1992' => 1992]); ?>

// <select name="birth_year">
//   <optgroup label="Ontario">
//     <option value="toronto">Toronto</option>
//     <option value="ottawa">Ottawa</option>
//   </optgroup>
//   <optgroup label="Quebec">
//     <option value="montreal">Montreal</option>
//     <option value="quebec_city">Quebec City</option>
//   </optgroup>
// </select>
$options = [
	'Ontario' => [
		'toronto' => 'Toronto',
		'ottawa' => 'Ottawa',
	],
	'Quebec' => [
		'montreal' => 'Montreal',
		'quebec_city' => 'Quebec City',
	]
];

<?= $builder->select('birth_year', $options); ?>

// <select name="birth_year">
//   <option value="1">1990</option>
// </select>
<?= $builder->select('birth_year')->addOption('1', 1990); ?>

// <select name="birth_year">
//   <option value="1">1990</option>
//   <option value="2">1991</option>
//   <option value="3" selected>1992</option>
// </select>
<?= $builder->select('birth_year', ['1' => 1990, '2' => 1991, '3' => 1992])->select('3'); ?>

按钮

// <button type="button">Click Me</button>
<?= $builder->button('Click Me'); ?>

// <button type="submit">Sign Up</button>
<?= $builder->submit('Sign Up'); ?>

// <button type="reset">Reset Form</button>
<?= $builder->reset('Reset Form'); ?>

// <button type="submit" class="js-submit">Sign Up</button>
<?= $builder->submit('Sign Up')->addClass('js-submit'); ?>

隐藏输入

// <input type="hidden" name="secret" value="my-secret-value">
<?= $builder->hidden('secret')->value('my-secret-value'); ?>

标签

基本标签

// <label>Email</label>
<?= $builder->label('Email'); ?>

// <label for="email">Email</label>
<?= $builder->label('Email')->forId('email'); ?>

包装另一个元素

// <label>Email<input type="text" name="email"></label>
<?= $builder->label('Email')->before($emailElement); ?>

// <label><input type="text" name="email">Email</label>
<?= $builder->label('Email')->after($emailElement); ?>

设置属性

// Attributes can be set with attribute(...)
// <input type="text" name="foobar" min="4">
<?= $builder->text('foobar')->attribute('min', 4); ?>

// Or by calling the attribute name as a method
// <input type="text" name="foobar" min="4">
<?= $builder->text('foobar')->min(4); ?>

// Setting data-* attributes
// <input type="text" data-foo="bar" name="foobar">
<?= $builder->text('foobar')->data('foo', 'bar'); ?>

// Multiple data-* attributes can be set at once
// <input type="text" data-foo="bar" data-bar="foo" name="foobar">
<?= $builder->text('foobar')->data(['foo' => 'bar', 'bar' => 'foo']); ?>

错误消息

表单构建器还允许您轻松检索表单元素的错误消息。为此，只需实现ErrorStoreInterface并将其传递给表单构建器即可

$builder->setErrorStore($myErrorStore);

// Check if the form has an error for an element
$builder->hasError('email');

// Retrieve the error message for an element
$builder->getError('email');

您还可以向getError()提供format参数，以清理您的标记。而不是这样做

<?php if ($builder->hasError('email')): ?>
	<span class="error"><?= $builder->getError('email'); ?></span>
<?php endif; ?>

...您可以直接这样做，如果存在格式化消息，则会显示它，否则不显示。

<?= $builder->getError('email', '<span class="error">:message</span'); ?>

CSRF保护

假设您在实例化表单构建器时设置了CSRF令牌，可以像这样轻松地将CSRF令牌添加到您的表单中

<?= $builder->token(); ?>

数据绑定

有时您可能有一个表单，其中所有字段都匹配系统中的某种对象或数组上的属性，并且您希望用户能够编辑这些数据。数据绑定通过允许您将对象或数组绑定到表单来使此操作变得非常简单，该表单将用于自动提供所有字段的默认值。

$model->first_name = "John";
$model->last_name = "Doe";
$model->email = "john@example.com";

<?= $builder->open(); ?>
<?= $builder->bind($model); ?>
<?= $builder->text('first_name'); ?>
<?= $builder->text('last_name'); ?>
<?= $builder->email('email'); ?>
<?= $builder->close(); ?>

注意：务必在创建任何其他表单元素之前bind。

测试

运行测试

$ ./vendor/bin/phpunit --no-coverage

带有覆盖率的测试

$ XDEBUG_MODE=coverage ./vendor/bin/phpunit

HTML覆盖率路径：build/coverage/index.html

代码风格

要修复代码风格，请运行

~/.composer/vendor/bin/php-cs-fixer fix --config=./phpcs.php --verbose

如果您不使用内置的Docker映像，您必须首先安装PHP CS Fixer

composer global require friendsofphp/php-cs-fixer

许可证

php-html-form在MIT许可证下发布。