lin3s/wp-symfony-form

WordPress plugin to allow using Symfony form component with ease

v0.4.1 2016-07-22 09:17 UTC

Requires

• php: ^5.5 || ^7.0
• symfony/config: ^2.3 || ^3.0
• symfony/finder: ^2.3 || ^3.0
• symfony/form: ^2.8 || ^3.0
• symfony/translation: ^2.3 || ^3.0
• symfony/twig-bridge: ^2.3 || ^3.0
• symfony/validator: ^2.3 || ^3.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^1.11
• lin3s/wp-phpspec-brigde: ^0.1
• phpspec/phpspec: ^2.5

Suggests

• timber/timber: Required if you want to use the MailerAction

MIT

• LIN3S

README

#WP Symfony Form

WordPress plugin to allow using Symfony form component with ease

    

Installation

If you are using composer run the following command:

$ composer require lin3s/wp-symfony-form

If your composer.json is properly set up you should find this package in plugins folder

Usage

First of all, enable this plugin in the WordPress admin panel.

To create your first form extend as usual from the AbstractType class provided by Symfony component.

use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\Extension\Core\Type\CheckboxType;
use Symfony\Component\Form\Extension\Core\Type\EmailType;
use Symfony\Component\Form\Extension\Core\Type\TextareaType;
use Symfony\Component\Form\Extension\Core\Type\TextType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\Validator\Constraints;

class ContactType extends AbstractType
{
    public function buildForm(FormBuilderInterface $builder, array $options)
    {
        $builder
            ->add('name', TextType::class, [
                'constraints' => new Constraints\NotBlank(),
                'label'       => 'Name',
            ])
            ->add('surname', TextType::class, [
                'constraints' => new Constraints\NotBlank(),
                'label'       => 'Surname',
            ])
            ->add('phone', TextType::class, [
                'constraints' => new Constraints\NotBlank(),
                'label'       => 'Phone',
            ])
            ->add('email', EmailType::class, [
                'constraints' => new Constraints\Email(),
                'label'       => 'Email',
            ])
            ->add('message', TextareaType::class, [
                'constraints' => new Constraints\NotBlank(),
                'label'       => 'Message',
            ])
            ->add('conditions', CheckboxType::class, [
                'mapped' => false,
            ]);
    }
}

To enable the Ajax calls for this form you need to subscribe to the wp_symfony_form_wrappers WordPress hook.

add_filter('wp_symfony_form_wrappers', function($formWrappers) {
    $formWrappers->add(
        new FormWrapper(
            'contact',
            'Fully/Qualified/Namespace/ContactType'
        )
    );
});

###Rendering the form In case you want to use Twig for rendering a Bridge is provided, just run the following code line passing Twig instance

TwigBridge::addExtension($twig);

// if you want to customize the form theme
TwigBridge::addExtension($twig, 'component/form.twig');

component/form.twig is your custom form theme that will be used to render the forms. Check the docs about form customization for further info.

Timber In case you are using Timber you should use twig_apply_filters hook.
Also, you have to load the form base views inside Timber global locations variable:

\Timber\Timber::$locations = [
    (...)
    ABSPATH . '../vendor/symfony/twig-bridge/Resources/views/Form/',
];

Important Submit event is binded to every element with .form class. In case you need to change it just do the following:

WPSymfonyForm.formSelector = '.your-selector';

Also error container for each form item can be changed using WPSymfonyForm.formErrorsSelector.

###The FormWrapper The FormWrapper is a class designed to contain a form and all its related actions. As you've seen above a new instance is created for each form you want to use in your WordPress project, and need to be registered inside the FormWrapperRegistry.

As first parameter it receives the fully qualified namespace and as second parameter it receives an array of classes implementing Action interface.

###Actions on success In case you need to perform any server side actions, it's as easy as to implement execute method of Action interface. A form instance will to be used as desired. Check src/Action folder to check already implemented actions.

To bind this action to a specific form you need to add it in the FormWrapper.

For client side success actions you can add your callback using the global WPSymfonyForm namespace as follows:

    WPSymfonyForm.onSuccess(function ($form) {
      if ($form.hasClass('form--contact')) {
        // ANYTHING YOU WANT TO DO 
      }
      $form.find('.form__footer').html('<p>Form successfully submitted</p>');
    });

onSuccess() and onError() are available to hook into the form.