Skip to content

Latest commit

 

History

History
99 lines (68 loc) · 2.69 KB

README.md

File metadata and controls

99 lines (68 loc) · 2.69 KB
Raw

🌴 Palmtree Form

License Build Packagist Version npm version

PHP form builder with Bootstrap classes, validation, data binding, Google Recaptcha and hCaptcha support, plus other goodies.

Requirements

  • PHP >= 8.1

Installation

Use composer to add the package to your dependencies:

composer require palmtree/form

Optional: Install the NPM package for AJAX form submission, CAPTCHA support and form collections:

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

<div class="container">
    <?= $form->render(); ?>
</div>

<!-- Optional JS for AJAX submissions, CAPTCHA support and form collections -->
<script src="https://unpkg.com/@palmtree/[email protected]/dist/palmtree-form.pkgd.min.js"></script>

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.

Documentation

View the documentation for more advanced usage.

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.

./examples/serve.sh

License

Released under the MIT license