2017 © Pedro Peláez
 

wordpress-plugin wp-symfony-form

WordPress plugin to allow using Symfony form component with ease

image

lin3s/wp-symfony-form

WordPress plugin to allow using Symfony form component with ease

  • PHP
  • 0 Dependents
  • 1 Suggesters
  • 0 Forks
  • 3 Open issues
  • 13 Versions
  • 4 % Grown

The README.md

WP Symfony Form

WordPress plugin to allow using Symfony form component with ease, (*1)

SensioLabsInsight Build Status Scrutinizer Code Quality Total Downloads      Latest Stable Version Latest Unstable Version, (*2)

Installation

If you are using composer run the following command:, (*3)

$ composer require lin3s/wp-symfony-form

If your composer.json is properly set up you should find this package in plugins folder, (*4)

Usage

First of all, enable this plugin in the WordPress admin panel., (*5)

To create your first form extend as usual from the AbstractType class provided by Symfony component., (*6)

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., (*7)

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, (*8)


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., (*9)

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:, (*10)

\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:, (*11)

WPSymfonyForm.formSelector = '.your-selector';

Also error container for each form item can be changed using WPSymfonyForm.formErrorsSelector., (*12)

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., (*13)

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

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., (*15)

To bind this action to a specific form you need to add it in the FormWrapper., (*16)

For client side success actions you can add your callback using the global WPSymfonyForm namespace as follows:, (*17)

    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., (*18)

The Versions

06/04 2017

dev-fix/twig-bridge-deps

dev-fix/twig-bridge-deps http://lin3s.com

WordPress plugin to allow using Symfony form component with ease

  Sources   Download

MIT

The Requires

 

The Development Requires

by LIN3S

22/07 2016

dev-master

9999999-dev http://lin3s.com

WordPress plugin to allow using Symfony form component with ease

  Sources   Download

MIT

The Requires

 

The Development Requires

by LIN3S

22/07 2016

v0.4.1

0.4.1.0 http://lin3s.com

WordPress plugin to allow using Symfony form component with ease

  Sources   Download

MIT

The Requires

 

The Development Requires

by LIN3S

14/07 2016

dev-feature/sql-storage

dev-feature/sql-storage http://lin3s.com

WordPress plugin to allow using Symfony form component with ease

  Sources   Download

MIT

The Requires

 

The Development Requires

by LIN3S

13/07 2016

dev-feature/local-storage

dev-feature/local-storage http://lin3s.com

WordPress plugin to allow using Symfony form component with ease

  Sources   Download

MIT

The Requires

 

The Development Requires

by LIN3S

03/06 2016

v0.4.0

0.4.0.0 http://lin3s.com

WordPress plugin to allow using Symfony form component with ease

  Sources   Download

MIT

The Requires

 

The Development Requires

by LIN3S

27/04 2016

v0.3.1

0.3.1.0 http://lin3s.com

WordPress plugin to allow using Symfony form component with ease

  Sources   Download

MIT

The Requires

 

The Development Requires

by LIN3S

28/03 2016

v0.3.0

0.3.0.0 http://lin3s.com

WordPress plugin to allow using Symfony form component with ease

  Sources   Download

MIT

The Requires

 

The Development Requires

by LIN3S

23/03 2016

v0.2.0

0.2.0.0 http://lin3s.com

WordPress plugin to allow using Symfony form component with ease

  Sources   Download

MIT

The Requires

 

The Development Requires

by LIN3S

10/07 2015

v0.1.4

0.1.4.0 http://lin3s.com

Symfony form integration for WordPress

  Sources   Download

MIT

The Requires

 

by Gorka Laucirica

30/06 2015

v0.1.2

0.1.2.0 http://lin3s.com

Symfony form integration for WordPress

  Sources   Download

MIT

The Requires

 

by Gorka Laucirica

30/06 2015

v0.1.1

0.1.1.0 http://lin3s.com

Symfony form integration for WordPress

  Sources   Download

MIT

The Requires

 

by Gorka Laucirica

30/06 2015

v0.1.0

0.1.0.0 http://lin3s.com

Symfony form integration for WordPress

  Sources   Download

MIT

The Requires

 

by Gorka Laucirica