mcfedr/json-form

A couple of helper files for handling json with symfony forms

Installs: 77 197

Dependents: 3

Suggesters: 0

Security: 0

Stars: 12

Watchers: 3

Forks: 5

Open Issues: 0

Type:symfony-bundle

4.6.0 2019-05-28 11:57 UTC

This package is auto-updated.

Last update: 2020-06-28 14:22:14 UTC


README

Simply use the JsonControllerTrait and then use forms as you would normally, but they now expect to receive JSON.

Latest Stable Version License Build Status

Install

Composer

php composer.phar require mcfedr/json-form

AppKernel

Include the bundle in your AppKernel

public function registerBundles()
{
    $bundles = array(
        ...
        new Mcfedr\JsonFormBundle\McfedrJsonFormBundle()

JSON

The expected JSON will be just like that form values that would be sent.

Suppose you have the following form type

class AccountType extends AbstractType
{
    public function buildForm(FormBuilderInterface $builder, array $options)
    {
        $builder
            ->add('name');
    }

    public function getBlockPrefix()
    {
        return 'account';
    }
}

Then the JSON should be

{
    "account": {
        "name": "Fred"
    }
}

Example

class AccountController extends AbstractController
    use JsonControllerTrait;

    /**
     * @Route("/accounts", methods={"POST"})
     */
    public function accountCreateAction(Request $request, $uuid) {
        $account = new Account();
        $form = $this->createJsonForm(AccountType::class, $account);
        $this->handleJsonForm($form, $request);

        $em = $this->getDoctrine()->getManager();
        $em->persist($account);
        $em->flush();

        return $this->json([
            'account' => $account
        ]);
    }
}

For Symfony 3.x you will need to extend Controller because the trait needs access to getParameter method.

Contributing

To run the tests

./vendor/bin/php-cs-fixer fix
./vendor/bin/phpunit
./vendor/bin/phpstan analyse