Merge pull request #98 from craue/revalidate-previous-steps

add a validation error to the current form if a form of a previous step became invalid

CHANGELOG.md

@@ -2,10 +2,12 @@
 
 ## master
 
+- [#98]: add a validation error to the current form if a form of a previous step became invalid
 - BC breaks (follow `UPGRADE-3.0.md` to upgrade):
   - [#101]: support for concurrent instances of the same flow
   - removed the step field template
 
+[#98]: https://github.com/craue/CraueFormFlowBundle/issues/98
 [#101]: https://github.com/craue/CraueFormFlowBundle/issues/101
 
 ## 2.1.4 (2013-12-05)

Form/FormFlow.php

@@ -12,10 +12,12 @@
 use Craue\FormFlowBundle\Storage\StorageInterface;
 use Craue\FormFlowBundle\Util\StringUtil;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
+use Symfony\Component\Form\FormError;
 use Symfony\Component\Form\FormFactoryInterface;
 use Symfony\Component\Form\FormInterface;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\Kernel;
+use Symfony\Component\Translation\TranslatorInterface;
 
 /**
  * @author Christian Raue <[email protected]>
@@ -44,11 +46,21 @@ abstract class FormFlow implements FormFlowInterface {
 	 */
 	protected $eventDispatcher = null;
 
+	/**
+	 * @var TranslatorInterface
+	 */
+	protected $translator;
+
 	/**
 	 * @var string
 	 */
 	protected $transition;
 
+	/**
+	 * @var boolean
+	 */
+	protected $revalidatePreviousSteps = true;
+
 	/**
 	 * @var boolean
 	 */
@@ -129,6 +141,11 @@ abstract class FormFlow implements FormFlowInterface {
 	 */
 	private $currentStepNumber = null;
 
+	/**
+	 * @var FormInterface[]
+	 */
+	private $stepForms = array();
+
 	/**
 	 * {@inheritDoc}
 	 */
@@ -176,6 +193,13 @@ public function setEventDispatcher(EventDispatcherInterface $eventDispatcher) {
 		$this->eventDispatcher = $eventDispatcher;
 	}
 
+	/**
+	 * {@inheritDoc}
+	 */
+	public function setTranslator(TranslatorInterface $translator) {
+		$this->translator = $translator;
+	}
+
 	public function setId($id) {
 		$this->id = $id;
 	}
@@ -296,6 +320,17 @@ public function getCurrentStepNumber() {
 		return $this->currentStepNumber;
 	}
 
+	public function setRevalidatePreviousSteps($revalidatePreviousSteps) {
+		$this->revalidatePreviousSteps = (boolean) $revalidatePreviousSteps;
+	}
+
+	/**
+	 * {@inheritDoc}
+	 */
+	public function isRevalidatePreviousSteps() {
+		return $this->revalidatePreviousSteps;
+	}
+
 	public function setAllowDynamicStepNavigation($allowDynamicStepNavigation) {
 		$this->allowDynamicStepNavigation = (boolean) $allowDynamicStepNavigation;
 	}
@@ -597,12 +632,23 @@ public function invalidateStepData($fromStepNumber) {
 	protected function applyDataFromSavedSteps() {
 		$stepData = $this->retrieveStepData();
 
+		$this->stepForms = array();
+
+		$options = array();
+		if (!$this->revalidatePreviousSteps) {
+			$options['validation_groups'] = array(); // disable validation
+		}
+
 		foreach ($this->getSteps() as $step) {
 			$stepNumber = $step->getNumber();
 
 			if (array_key_exists($stepNumber, $stepData)) {
-				$stepForm = $this->createFormForStep($stepNumber);
-				$stepForm->bind($stepData[$stepNumber]);
+				$stepForm = $this->createFormForStep($stepNumber, $options);
+				$stepForm->bind($stepData[$stepNumber]); // the form is validated here
+
+				if ($this->revalidatePreviousSteps) {
+					$this->stepForms[$stepNumber] = $stepForm;
+				}
 
 				if ($this->hasListeners(FormFlowEvents::POST_BIND_SAVED_DATA)) {
 					$event = new PostBindSavedDataEvent($this, $this->formData, $stepNumber);
@@ -722,6 +768,27 @@ public function isValid(FormInterface $form) {
 				$this->eventDispatcher->dispatch(FormFlowEvents::POST_BIND_REQUEST, $event);
 			}
 
+			if ($this->revalidatePreviousSteps) {
+				// check if forms of previous steps are still valid
+				foreach ($this->stepForms as $stepNumber => $stepForm) {
+					// ignore form of the current step
+					if ($this->currentStepNumber === $stepNumber) {
+						break;
+					}
+
+					// ignore forms of skipped steps
+					if ($this->isStepSkipped($stepNumber)) {
+						break;
+					}
+
+					if (!$stepForm->isValid()) {
+						$form->addError($this->getPreviousStepInvalidFormError($stepNumber));
+
+						return false;
+					}
+				}
+			}
+
 			if ($form->isValid()) {
 				if ($this->hasListeners(FormFlowEvents::POST_VALIDATE)) {
 					$event = new PostValidateEvent($this, $form->getData());
@@ -790,6 +857,23 @@ protected function hasListeners($eventName) {
 		return $this->eventDispatcher !== null && $this->eventDispatcher->hasListeners($eventName);
 	}
 
+	/**
+	 * @param integer $stepNumber
+	 * @return FormError
+	 */
+	protected function getPreviousStepInvalidFormError($stepNumber) {
+		$messageId = 'craueFormFlow.previousStepInvalid';
+		$messageParameters = array('%stepNumber%' => $stepNumber);
+
+		if (version_compare(Kernel::VERSION, '2.2', '>=')) {
+			$message = $this->translator->trans($messageId, $messageParameters, 'validators');
+			return new FormError($message, $messageId, $messageParameters);
+		}
+
+		// TODO remove as soon as Symfony >= 2.2 is required
+		return new FormError($messageId, $messageParameters);
+	}
+
 	// methods for BC with third-party templates (e.g. MopaBootstrapBundle)
 
 	public function getCurrentStep() {

Form/FormFlowInterface.php

@@ -8,6 +8,7 @@
 use Symfony\Component\Form\FormFactoryInterface;
 use Symfony\Component\Form\FormInterface;
 use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\Translation\TranslatorInterface;
 
 /**
  * @author Christian Raue <[email protected]>
@@ -46,6 +47,16 @@ function getStorage();
 	 */
 	function setEventDispatcher(EventDispatcherInterface $eventDispatcher);
 
+	/**
+	 * @param TranslatorInterface $translator
+	 */
+	function setTranslator(TranslatorInterface $translator);
+
+	/**
+	 * @return boolean
+	 */
+	function isRevalidatePreviousSteps();
+
 	/**
 	 * @return boolean
 	 */

README.md

@@ -400,6 +400,23 @@ To validate the form data class a step-based validation group is passed to the f
 By default, if `getName()` of the flow returns `createVehicle`, such a group is named `flow_createVehicle_step1`
 for the first step.
 
+## Disabling revalidation of previous steps
+
+Take a look at [#98](https://github.com/craue/CraueFormFlowBundle/issues/98) for an example on why it's useful to
+revalidate previous steps by default. But if you want (or need) to avoid revalidating previous steps, you could extend
+the flow class mentioned in the example above as follows:
+
+```php
+// in src/MyCompany/MyBundle/Form/CreateVehicleFlow.php
+class CreateVehicleFlow extends FormFlow {
+
+	protected $revalidatePreviousSteps = false;
+
+	// ...
+
+}
+```
+
 ## Passing step-based options to the form type
 
 If your form type needs options to build the form (e.g. conditional fields) you can override method `getFormOptions`

Resources/config/form_flow.xml

@@ -34,6 +34,9 @@
 			<call method="setEventDispatcher">
 				<argument type="service" id="event_dispatcher" on-invalid="ignore" />
 			</call>
+			<call method="setTranslator">
+				<argument type="service" id="translator" />
+			</call>
 		</service>
 
 		<service id="craue.form.flow.form_extension" class="Craue\FormFlowBundle\Form\Extension\FormFlowFormExtension">

Resources/translations/validators.de.yml

@@ -0,0 +1 @@
+craueFormFlow.previousStepInvalid: Das Formular für Schritt %stepNumber% ist ungültig. Gehen Sie bitte zurück und versuchen das Formular erneut zu senden.

Resources/translations/validators.en.yml

@@ -0,0 +1 @@
+craueFormFlow.previousStepInvalid: The form for step %stepNumber% is invalid. Please go back and try to submit it again.

Resources/translations/validators.es.yml

@@ -0,0 +1 @@
+craueFormFlow.previousStepInvalid: El formulario del paso %stepNumber% está inválido. Por favor, utilice el botón de atrás y pruebe de enviar el formulario de nuevo.

Resources/translations/validators.fr.yml

@@ -0,0 +1 @@
+craueFormFlow.previousStepInvalid: Le formulaire pour l'étape %stepNumber% est invalide. Veuillez retourner et essayez de le renvoyer.

Resources/translations/validators.nl.yml

@@ -0,0 +1 @@
+craueFormFlow.previousStepInvalid: Het formulier voor stap %stepNumber% is ongeldig. Ga terug en probeer het opnieuw te versturen.

Resources/translations/validators.pl.yml

@@ -0,0 +1 @@
+craueFormFlow.previousStepInvalid: Formularz dla kroku %stepNumber% został wypełniony nieprawidłowo. Proszę cofnąć się i wypełnić go ponownie.

Resources/translations/validators.ru.yml

@@ -0,0 +1 @@
+craueFormFlow.previousStepInvalid: Форма для шага %stepNumber% имеет недопустимое значение. Пожалуйста, вернитесь назад и попробуйте повторить отправку.

Resources/translations/validators.uk.yml

@@ -0,0 +1 @@
+craueFormFlow.previousStepInvalid: Форма для кроку %stepNumber% є недопустимою. Будь ласка, поверніться та спробуйте повторно відправити форму.

Resources/translations/validators.zh.yml

@@ -0,0 +1 @@
+craueFormFlow.previousStepInvalid: 步驟%stepNumber%的表格無效,請回到上一個步驟並重新提交。

Tests/IntegrationTestBundle/Controller/FormFlowController.php

@@ -4,6 +4,7 @@
 
 use Craue\FormFlowBundle\Form\FormFlow;
 use Craue\FormFlowBundle\Tests\IntegrationTestBundle\Entity\Issue64Data;
+use Craue\FormFlowBundle\Tests\IntegrationTestBundle\Entity\RevalidatePreviousStepsData;
 use Craue\FormFlowBundle\Tests\IntegrationTestBundle\Entity\Topic;
 use Craue\FormFlowBundle\Tests\IntegrationTestBundle\Entity\Vehicle;
 use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
@@ -59,6 +60,18 @@ public function issue87Action() {
 		return $this->processFlow((object) array(), $this->get('integrationTestBundle.form.flow.issue87'));
 	}
 
+	/**
+	 * @Route("/revalidatePreviousSteps/enabled/", defaults={"enabled"=true}, name="_FormFlow_revalidatePreviousSteps_enabled")
+	 * @Route("/revalidatePreviousSteps/disabled/", defaults={"enabled"=false}, name="_FormFlow_revalidatePreviousSteps_disabled")
+	 * @Template("IntegrationTestBundle:FormFlow:revalidatePreviousSteps.html.twig")
+	 */
+	public function revalidatePreviousStepsAction($enabled) {
+		$flow = $this->get('integrationTestBundle.form.flow.revalidatePreviousSteps');
+		$flow->setRevalidatePreviousSteps($enabled);
+
+		return $this->processFlow(new RevalidatePreviousStepsData(), $flow);
+	}
+
 	/**
 	 * @Route("/skipFirstStepUsingClosure/", name="_FormFlow_skipFirstStepUsingClosure")
 	 * @Template("IntegrationTestBundle:FormFlow:skipFirstStepUsingClosure.html.twig")

Tests/IntegrationTestBundle/Entity/RevalidatePreviousStepsData.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Craue\FormFlowBundle\Tests\IntegrationTestBundle\Entity;
+
+use Symfony\Component\Validator\Constraints as Assert;
+use Symfony\Component\Validator\ExecutionContext;
+
+/**
+ * @author Christian Raue <[email protected]>
+ * @copyright 2011-2013 Christian Raue
+ * @license http://opensource.org/licenses/mit-license.php MIT License
+ *
+ * @Assert\Callback(methods={"isDataValid"}, groups={"flow_revalidatePreviousSteps_step1"})
+ */
+class RevalidatePreviousStepsData {
+
+	private static $validationCalls;
+
+	public static function resetValidationCalls() {
+		self::$validationCalls = 0;
+	}
+
+	// TODO replace with ExecutionContextInterface as soon as Symfony >= 2.2 is required
+	public function isDataValid(ExecutionContext $context) {
+		// valid only on first call
+		if (++self::$validationCalls > 1) {
+			$context->addViolation('Take this!');
+		}
+	}
+
+}

Tests/IntegrationTestBundle/Form/RevalidatePreviousStepsFlow.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace Craue\FormFlowBundle\Tests\IntegrationTestBundle\Form;
+
+use Craue\FormFlowBundle\Form\FormFlow;
+
+/**
+ * @author Christian Raue <[email protected]>
+ * @copyright 2011-2013 Christian Raue
+ * @license http://opensource.org/licenses/mit-license.php MIT License
+ */
+class RevalidatePreviousStepsFlow extends FormFlow {
+
+	/**
+	 * {@inheritDoc}
+	 */
+	public function getName() {
+		return 'revalidatePreviousSteps';
+	}
+
+	/**
+	 * {@inheritDoc}
+	 */
+	protected function loadStepsConfig() {
+		return array(
+			array(
+				'label' => 'step1',
+			),
+			array(
+				'label' => 'step2',
+			),
+			array(
+				'label' => 'step3',
+			),
+		);
+	}
+
+}

Tests/IntegrationTestBundle/Resources/config/form_flow.xml

@@ -42,6 +42,12 @@
 				scope="request">
 		</service>
 
+		<service id="integrationTestBundle.form.flow.revalidatePreviousSteps"
+				class="Craue\FormFlowBundle\Tests\IntegrationTestBundle\Form\RevalidatePreviousStepsFlow"
+				parent="craue.form.flow"
+				scope="request">
+		</service>
+
 		<service id="integrationTestBundle.form.flow.skipFirstStepUsingClosure"
 				class="Craue\FormFlowBundle\Tests\IntegrationTestBundle\Form\SkipFirstStepUsingClosureFlow"
 				parent="craue.form.flow"

Tests/IntegrationTestBundle/Resources/views/FormFlow/revalidatePreviousSteps.html.twig

@@ -0,0 +1 @@
+{% extends 'IntegrationTestBundle::layout_flow.html.twig' %}