coroq/html-form

v3.0.0 2025-11-21 14:45 UTC

Requires

• php: ^8.0
• coroq/form: ^3.0
• coroq/html: ^0.4

Requires (Dev)

• phpunit/phpunit: ^9.6

MIT

• Ozawa Masayuki

README

Generates HTML form elements from coroq/form objects with validation attributes and error handling.

Installation

composer require coroq/html-form

Requires PHP 8.0+, coroq/form 3.0.0, and coroq/html 0.4.0.

Basic Usage

use Coroq\Form\Form;
use Coroq\Form\FormItem;
use Coroq\HtmlForm\HtmlForm;
use Coroq\Form\ErrorMessageFormatter;
use Coroq\Form\BasicErrorMessages;

// Create form
$form = new Form();
$form->username = (new FormItem\TextInput())
    ->setMinLength(3)
    ->setMaxLength(20);
$form->email = new FormItem\EmailInput();
$form->age = (new FormItem\IntegerInput())
    ->setMin(18)
    ->setMax(100);

// Create HTML form generator
$formatter = new ErrorMessageFormatter();
$formatter->setMessages(BasicErrorMessages::get());
$htmlForm = new HtmlForm($form, $formatter);

// Generate inputs
echo $htmlForm->inputText('username');
// <input type="text" name="username" required minlength="3" maxlength="20">

echo $htmlForm->inputEmail('email');
// <input type="email" name="email" required>

echo $htmlForm->inputNumber('age');
// <input type="number" name="age" required min="18" max="100">

Input Types

// Text inputs
$htmlForm->inputText('name');
$htmlForm->inputEmail('email');
$htmlForm->inputPassword('password');
$htmlForm->inputUrl('website');
$htmlForm->inputTel('phone');
$htmlForm->inputNumber('quantity');
$htmlForm->inputDate('birthdate');
$htmlForm->inputHidden('token');
$htmlForm->inputFile('upload');

// Textarea
$htmlForm->textarea('bio');

// Boolean checkbox
$form->agree = new FormItem\BooleanInput();
echo $htmlForm->inputBoolean('agree');
// <input type="checkbox" name="agree" value="1">

Select and Options

$form->country = (new FormItem\Select())
    ->setOptions([
        'us' => 'United States',
        'jp' => 'Japan',
        'uk' => 'United Kingdom'
    ])
    ->setValue('jp');

echo $htmlForm->select('country');
// <select name="country" required>
//   <option value="us">United States</option>
//   <option value="jp" selected>Japan</option>
//   <option value="uk">United Kingdom</option>
// </select>

// Multi-select
$form->colors = (new FormItem\MultiSelect())
    ->setOptions(['r' => 'Red', 'g' => 'Green', 'b' => 'Blue'])
    ->setValue(['r', 'b']);

echo $htmlForm->select('colors');
// <select name="colors[]" multiple required>...</select>

Checkboxes and Radios

$form->size = (new FormItem\Select())
    ->setOptions(['s' => 'Small', 'm' => 'Medium', 'l' => 'Large'])
    ->setValue('m');

// Individual checkbox
echo $htmlForm->inputCheckbox('size', 's');
// <input type="checkbox" name="size" value="s">

// All checkboxes
foreach ($htmlForm->inputCheckboxes('size') as $value => $checkbox) {
    echo $checkbox; // Has title attribute with label
}

// Radio buttons
foreach ($htmlForm->inputRadios('size') as $value => $radio) {
    echo $radio;
}

Nested Forms

$form->address = new Form();
$form->address->city = new FormItem\TextInput();
$form->address->postal = new FormItem\TextInput();

// String path
echo $htmlForm->inputText('address/city');
// <input type="text" name="address[city]" required>

// Array path
echo $htmlForm->inputText(['address', 'postal']);
// <input type="text" name="address[postal]" required>

Displaying Values

$form->price = (new FormItem\NumberInput())->setValue('1234.56');
$form->created = (new FormItem\DateInput())->setValue('2024-01-15');

// Plain value
echo $htmlForm->value('price');
// 1234.56

// Formatted number
echo $htmlForm->number('price', 2, '.', ',');
// 1,234.56

// Formatted date
echo $htmlForm->date('created', 'F d, Y');
// January 15, 2024

// Custom format
echo $htmlForm->format('price', 'Price: $%s');
// Price: $1234.56

Error Handling

$form->email = (new FormItem\EmailInput())->setValue('invalid-email');
$form->email->validate();

// Display errors
echo $htmlForm->error('email');
// <div>Invalid email address</div>

// Multiple fields
echo $htmlForm->error(['email', 'username']);

// Check for errors
if ($htmlForm->getItemIn('email')->hasError()) {
    // ...
}

Form State Attributes

// Optional field
$form->nickname = (new FormItem\TextInput())
    ->setRequired(false);

// Disabled field
$form->locked = (new FormItem\TextInput())
    ->setDisabled(true);

// Read-only field
$form->computed = (new FormItem\TextInput())
    ->setReadOnly(true);

echo $htmlForm->inputText('optional');
// <input type="text" name="optional">

echo $htmlForm->inputText('locked');
// <input type="text" name="locked" disabled required>

Bootstrap Integration

Bootstrap 4

use Coroq\HtmlForm\Integration\Bootstrap4;

$htmlForm = new Bootstrap4($form, $formatter);

echo $htmlForm->inputText('username');
// <input type="text" name="username" class="form-control" required>

echo $htmlForm->select('country');
// <select name="country" class="form-control" required>...</select>

// With validation errors
$form->email->validate(); // Fails
echo $htmlForm->inputEmail('email');
// <input type="email" name="email" class="form-control is-invalid" required>

echo $htmlForm->error('email');
// <div class="invalid-feedback">Invalid email address</div>

Bootstrap 5

use Coroq\HtmlForm\Integration\Bootstrap5;

$htmlForm = new Bootstrap5($form, $formatter);

echo $htmlForm->select('country');
// <select name="country" class="form-select" required>...</select>
// Note: Bootstrap 5 uses form-select instead of form-control

Complete Example

// Setup form
$form = new Form();
$form->username = (new FormItem\TextInput())
    ->setMinLength(3)
    ->setMaxLength(20);
$form->email = new FormItem\EmailInput();
$form->password = (new FormItem\TextInput())
    ->setMinLength(8);
$form->country = (new FormItem\Select())
    ->setOptions(['us' => 'USA', 'jp' => 'Japan', 'uk' => 'UK']);
$form->agree = new FormItem\BooleanInput();

// Handle submission
if ($_SERVER['REQUEST_METHOD'] === 'POST') {
    $form->setValue($_POST);
    if ($form->validate()) {
        // Process form
        $data = $form->getValue();
    }
}

// Create HTML generator
$formatter = new ErrorMessageFormatter();
$formatter->setMessages(BasicErrorMessages::get());
$htmlForm = new HtmlForm($form, $formatter);
?>

<form method="post">
    <div>
        <label>Username</label>
        <?= $htmlForm->inputText('username') ?>
        <?= $htmlForm->error('username') ?>
    </div>

    <div>
        <label>Email</label>
        <?= $htmlForm->inputEmail('email') ?>
        <?= $htmlForm->error('email') ?>
    </div>

    <div>
        <label>Password</label>
        <?= $htmlForm->inputPassword('password') ?>
        <?= $htmlForm->error('password') ?>
    </div>

    <div>
        <label>Country</label>
        <?= $htmlForm->select('country') ?>
        <?= $htmlForm->error('country') ?>
    </div>

    <div>
        <?= $htmlForm->inputBoolean('agree') ?>
        <label>I agree to terms</label>
        <?= $htmlForm->error('agree') ?>
    </div>

    <button type="submit">Submit</button>
</form>

License

MIT