avoid type error regarding setTranslator with Symfony < 4.2 while s…

…ymfony/translation-contracts is installed

fixes #347

EventListener/FlowExpiredEventListener.php

@@ -34,7 +34,7 @@ protected function getFlowExpiredFormError() {
 }
 
 // TODO revert to one clean class definition as soon as Symfony >= 4.2 is required
-if (interface_exists(TranslatorInterface::class)) {
+if (!interface_exists(LegacyTranslatorInterface::class)) {
 	/**
 	 * Adds a validation error to the current step's form if an expired flow is detected.
 	 *

EventListener/PreviousStepInvalidEventListener.php

@@ -35,7 +35,7 @@ protected function getPreviousStepInvalidFormError($stepNumber) {
 }
 
 // TODO revert to one clean class definition as soon as Symfony >= 4.2 is required
-if (interface_exists(TranslatorInterface::class)) {
+if (!interface_exists(LegacyTranslatorInterface::class)) {
 	/**
 	 * Adds a validation error to the current step's form if revalidating previous steps failed.
 	 *

Tests/EventListener/EventListenerNeedsTranslatorTest.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace Craue\FormFlowBundle\Tests\EventListener;
+
+use Craue\FormFlowBundle\Tests\UnitTestCase;
+use Symfony\Component\Translation\DataCollectorTranslator;
+use Symfony\Component\Translation\TranslatorInterface as LegacyTranslatorInterface;
+use Symfony\Contracts\Translation\TranslatorInterface;
+
+/**
+ * @group unit
+ *
+ * @author Christian Raue <christian.raue@gmail.com>
+ * @copyright 2011-2019 Christian Raue
+ * @license http://opensource.org/licenses/mit-license.php MIT License
+ */
+abstract class EventListenerNeedsTranslatorTest extends UnitTestCase {
+
+	abstract protected function getListener();
+
+	/**
+	 * TranslatorInterface (from contracts) was introduced with Symfony 4.2, but could be installed separately by symfony/translation-contracts along with Symfony < 4.2.
+	 *
+	 * @dataProvider dataSetTranslator
+	 * @doesNotPerformAssertions
+	 */
+	public function testSetTranslator($translator) {
+		$this->getListener()->setTranslator($translator);
+	}
+
+	public function dataSetTranslator() {
+		$translators = [
+			[$this->createMock(DataCollectorTranslator::class)],
+		];
+
+		if (interface_exists(LegacyTranslatorInterface::class)) {
+			// TODO remove as soon as Symfony >= 4.2 is required
+			$translators[] = [$this->createMock(LegacyTranslatorInterface::class)];
+		} else {
+			$translators[] = [$this->createMock(TranslatorInterface::class)];
+		}
+
+		return $translators;
+	}
+
+}

Tests/EventListener/FlowExpiredEventListenerTest.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Craue\FormFlowBundle\Tests\EventListener;
+
+use Craue\FormFlowBundle\EventListener\FlowExpiredEventListener;
+
+/**
+ * @group unit
+ *
+ * @author Christian Raue <christian.raue@gmail.com>
+ * @copyright 2011-2019 Christian Raue
+ * @license http://opensource.org/licenses/mit-license.php MIT License
+ */
+class FlowExpiredEventListenerTest extends EventListenerNeedsTranslatorTest {
+
+	protected function getListener() {
+		return new FlowExpiredEventListener();
+	}
+
+}

Tests/EventListener/PreviousStepInvalidEventListenerTest.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Craue\FormFlowBundle\Tests\EventListener;
+
+use Craue\FormFlowBundle\EventListener\PreviousStepInvalidEventListener;
+
+/**
+ * @group unit
+ *
+ * @author Christian Raue <christian.raue@gmail.com>
+ * @copyright 2011-2019 Christian Raue
+ * @license http://opensource.org/licenses/mit-license.php MIT License
+ */
+class PreviousStepInvalidEventListenerTest extends EventListenerNeedsTranslatorTest {
+
+	protected function getListener() {
+		return new PreviousStepInvalidEventListener();
+	}
+
+}

phpstan-config.neon

@@ -27,6 +27,12 @@ parameters:
 			message: '#^Class Symfony\\Component\\HttpFoundation\\File\\UploadedFile constructor invoked with 6 parameters, 2-5 required\.$#'
 			path: %currentWorkingDirectory%/Storage/SerializableFile.php
 		# TODO remove as soon as Symfony >= 4.2 is required
+		-
+			message: '#^Class Symfony\\Component\\Translation\\TranslatorInterface not found\.$#'
+			paths:
+				- %currentWorkingDirectory%/EventListener/FlowExpiredEventListener.php
+				- %currentWorkingDirectory%/EventListener/PreviousStepInvalidEventListener.php
+		# TODO remove as soon as Symfony >= 4.2 is required
 		-
 			message: '#^Property Craue\\FormFlowBundle\\EventListener\\Base(FlowExpired|PreviousStepInvalid)EventListener::\$translator has unknown class Symfony\\Component\\Translation\\TranslatorInterface as its type\.$#'
 			paths: