palmtree/form

Form component for Palmtree PHP

:palm_tree: Palmtree Form

, _(*1)

PHP form builder with Bootstrap classes, validation, data binding, Google Recaptcha and hCaptcha support, plus other goodies., _(*2)

Requirements

• PHP >= 8.1

Installation

Use composer to add the package to your dependencies:, _(*3)

composer require palmtree/form

Optional: Install the NPM package for AJAX form submission, CAPTCHA support and form collections:, _(*4)

npm install @palmtree/form

Usage Example

Build

use Palmtree\Form\FormBuilder;
use Palmtree\Form\Captcha\GoogleRecaptcha;
use Palmtree\Form\Captcha\HCaptcha;

$builder = (new FormBuilder('my_form'))
    ->add('name', 'text', ['error_message' => 'Please enter your name'])
    ->add('email_address', 'email', [
        'help' => 'We will never share your email with anyone',
    ])
    ->add('message', 'textarea', [
        'required' => false,
        'label' => 'Enter your message',
    ])
    ->add('recaptcha', 'captcha', [
        'captcha' => new GoogleRecaptcha('<site_key>', '<secret>'),
        //'captcha' => new HCaptcha('<site_key>', '<secret>'),
    ]);

$builder->add('send_message', 'submit');

$form = $builder->getForm();
// Set $form to some variable accessible in a view

Render

    = $form->render(); ?>

Process

$form->handleRequest();

if ($form->isSubmitted() && $form->isValid()) {
    // Send an email/save to database etc
    $name = $form->get('name')->getData();
}

See the examples directory for examples using AJAX, file uploads, collections and more., _(*5)

Documentation

View the documentation for more advanced usage., _(*6)

Examples

The simplest way to run the examples is run the serve.sh script. This script starts a small PHP Docker container and serves the examples using PHP's built-in web server., _(*7)

./examples/serve.sh

License

Released under the MIT license, _(*8)