How to Use the submit() Function to Handle Form Submissions

2.6 version

Unmaintained

2.3 2.4 2.5 2.6

How to Use the submit() Function to Handle Form Submissions
- Calling Form::submit() manually
- Passing a Request to Form::submit() (Deprecated)

How to Use the submit() Function to Handle Form Submissions¶

New in version 2.3: The handleRequest() method was introduced in Symfony 2.3.

With the handleRequest() method, it is really easy to handle form submissions:

use Symfony\Component\HttpFoundation\Request;
// ...

public function newAction(Request $request)
{
    $form = $this->createFormBuilder()
        // ...
        ->getForm();

    $form->handleRequest($request);

    if ($form->isValid()) {
        // perform some action...

        return $this->redirectToRoute('task_success');
    }

    return $this->render('AcmeTaskBundle:Default:new.html.twig', array(
        'form' => $form->createView(),
    ));
}

Tip

To see more about this method, read Handling Form Submissions.

Calling Form::submit() manually¶

New in version 2.3: Before Symfony 2.3, the submit() method was known as bind().

In some cases, you want better control over when exactly your form is submitted and what data is passed to it. Instead of using the handleRequest() method, pass the submitted data directly to submit():

use Symfony\Component\HttpFoundation\Request;
// ...

public function newAction(Request $request)
{
    $form = $this->createFormBuilder()
        // ...
        ->getForm();

    if ($request->isMethod('POST')) {
        $form->submit($request->request->get($form->getName()));

        if ($form->isValid()) {
            // perform some action...

            return $this->redirectToRoute('task_success');
        }
    }

    return $this->render('AcmeTaskBundle:Default:new.html.twig', array(
        'form' => $form->createView(),
    ));
}

Tip

Forms consisting of nested fields expect an array in submit(). You can also submit individual fields by calling submit() directly on the field:

$form->get('firstName')->submit('Fabien');

Passing a Request to Form::submit() (Deprecated)¶

New in version 2.3: Before Symfony 2.3, the submit method was known as bind.

Before Symfony 2.3, the submit() method accepted a Symfony\Component\HttpFoundation\Request object as a convenient shortcut to the previous example:

use Symfony\Component\HttpFoundation\Request;
// ...

public function newAction(Request $request)
{
    $form = $this->createFormBuilder()
        // ...
        ->getForm();

    if ($request->isMethod('POST')) {
        $form->submit($request);

        if ($form->isValid()) {
            // perform some action...

            return $this->redirectToRoute('task_success');
        }
    }

    return $this->render('AcmeTaskBundle:Default:new.html.twig', array(
        'form' => $form->createView(),
    ));
}

Passing the Symfony\Component\HttpFoundation\Request directly to submit() still works, but is deprecated and will be removed in Symfony 3.0. You should use the method handleRequest() instead.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.