CraueFormFlowBundle

To create a form flow, you must implement a class that extends Craue\FormFlowBundle\Form\FormFlow. The core of your configuration happens in the loadStepsConfig() method, where you define an array of steps. Each step can have a label, a form_type, and an optional skip callback.

Step Configuration Options

• label: A string label for the step.
• form_type: The class name of the Symfony Form Type to use for this step.
• skip: A callback function function($estimatedCurrentStepNumber, FormFlowInterface $flow): bool that returns true if the step should be skipped.

use Craue\FormFlowBundle\Form\FormFlow;
use Craue\FormFlowBundle\Form\FormFlowInterface;

class CreateVehicleFlow extends FormFlow {
	protected function loadStepsConfig() {
		return [
			[
				'label' => 'wheels',
				'form_type' => CreateVehicleForm::class,
			],
			[
				'label' => 'engine',
				'form_type' => CreateVehicleForm::class,
				'skip' => function($estimatedCurrentStepNumber, FormFlowInterface $flow) {
					return $estimatedCurrentStepNumber > 1 && !$flow->getFormData()->canHaveEngine();
				},
			],
			[
				'label' => 'confirmation',
			],
		];
	}
}

You can pass options to the form types used in your flow at different levels of granularity.

Generic Options (All Steps)

Use setGenericFormOptions on the flow instance (usually in your controller) to apply options to every step's form type.

$flow->setGenericFormOptions(['action' => 'targetUrl']);

Step-Specific Options

Define options for a specific step within the loadStepsConfig method using the form_options key.

'form_options' => ['validation_groups' => ['Default']],

Dynamic Step Options

To pass options based on data submitted in previous steps, override the getFormOptions method in your flow class.

public function getFormOptions($step, array $options = []) {
    $options = parent::getFormOptions($step, $options);
    $formData = $this->getFormData();

    if ($step === 2) {
        $options['numberOfWheels'] = $formData->getNumberOfWheels();
    }

    return $options;
}

// In your Controller
$flow->setGenericFormOptions(['action' => 'targetUrl']);

// In your Flow class
protected function loadStepsConfig() {
    return [
        [
            'label' => 'wheels',
            'form_type' => CreateVehicleStep1Form::class,
            'form_options' => [
                'validation_groups' => ['Default'],
            ],
        ],
    ];
}

The way steps are defined in a Flow class has changed. Instead of using a maxSteps property and loadStepDescriptions(), you now define a form type and a configuration array that maps labels to form types.

1. Implement getName() to return the same value as your form type (this ensures validation groups continue to work).
2. Use setFormType(FormTypeInterface $formType) to set the primary form type.
3. Implement loadStepsConfig() to return an array of arrays, where each sub-array contains a label and a type (the form type for that step).

use Symfony//Component/Form/FormTypeInterface;

public function getName() {
    return 'createVehicle';
}

protected $formType;

public function setFormType(FormTypeInterface $formType) {
    $this->formType = $formType;
}

protected function loadStepsConfig() {
    return array(
        array('label' => 'wheels', 'type' => $this->formType),
        array('label' => 'engine', 'type' => $this->formType),
        array('label' => 'confirmation', 'type' => $this->formType),
    );
}

To process a flow in a controller action:

1. Instantiate your data object (must be an object, not an array).
2. Retrieve the flow service and call $flow->bind($formData).
3. Create the form using $flow->createForm().
4. Validate using $flow->isValid($form).
5. If valid, call $flow->saveCurrentStepData($form).
6. Check $flow->nextStep():
   • If true, create the form for the next step.
   • If false, the flow is finished. Persist your data, call $flow->reset(), and redirect.
7. Pass both form (the view) and flow to your template.

public function createVehicleAction() {
	$formData = new Vehicle();
	$flow = $this->get('myCompany.form.flow.createVehicle');
	$flow->bind($formData);

	$form = $flow->createForm();
	if ($flow->isValid($form)) {
		$flow->saveCurrentStepData($form);

		if ($flow->nextStep()) {
			$form = $flow->createForm();
		} else {
			// flow finished
			$em = $this->getDoctrine()->getManager();
			$em->persist($formData);
			$em->flush();

			$flow->reset();
			return $this->redirectToRoute('home');
		}
	}

	return $this->render('@MyCompanyMy/Vehicle/createVehicle.html.twig', [
		'form' => $form->createView(),
		'flow' => $flow,
	]);
}