[RFT] Separation of frontend mapping functionality

Separate the frontend mapping functionality and persist the mapping
configuration for simpler and more consistent usage. This allowed to
exclude the additional properties from the SpreadsheetImportService and
move it to the controllers for the individual implementations.

refs KIME-4583

Classes/WE/SpreadsheetImport/FrontendMappingUtility.php → Classes/WE/SpreadsheetImport/FrontendMappingService.php

@@ -11,42 +11,76 @@ namespace WE\SpreadsheetImport;
  * The TYPO3 project - inspiring people to share!                         *
  *                                                                        */
 
+use TYPO3\Flow\Annotations as Flow;
 use TYPO3\Flow\Mvc\ActionRequest;
 use WE\SpreadsheetImport\Annotations\Mapping;
 
 /**
- * Utility class of basic FE mapping functionality for simple usage on separate implementations.
+ * Service class of basic FE mapping functionality for simple usage on separate implementations.
+ *
+ * @Flow\Scope("singleton")
  */
-class FrontendMappingUtility {
+class FrontendMappingService {
 
 	/**
-	 * @param \WE\SpreadsheetImport\SpreadsheetImportService $spreadsheetImportService
+	 * @Flow\Inject
+	 * @var \WE\SpreadsheetImport\SpreadsheetImportService
+	 */
+	protected $spreadsheetImportService;
+
+	/**
+	 * @Flow\InjectConfiguration
+	 * @var array
+	 */
+	protected $settings;
+
+	/**
+	 * @param string $context
 	 * @param \TYPO3\Flow\Mvc\ActionRequest $request
 	 *
 	 * @return array
 	 */
-	public static function getSpreadsheetImportMappingByRequest(SpreadsheetImportService $spreadsheetImportService, ActionRequest $request) {
+	public function getContextArgumentsForRequest($context, ActionRequest $request) {
+		$arguments = array();
+		$contextArguments = $this->settings[$context]['arguments'];
+		if (is_array($contextArguments)) {
+			foreach ($contextArguments as $contextArgument) {
+				$name = $contextArgument['name'];
+				$default = isset($contextArgument['default']) ? $contextArgument['default'] : NULL;
+				$arguments[$name] = $request->hasArgument($name) ? $request->getArgument($name) : $default;
+			}
+		}
+		return $arguments;
+	}
+
+	/**
+	 * @param array $mappingProperties
+	 * @param array $columns
+	 *
+	 * @return array
+	 */
+	public function getSpreadsheetImportMapping($mappingProperties, $columns = array()) {
 		$mappings = array();
-		$domainMappingProperties = $spreadsheetImportService->getMappingProperties();
-		foreach ($domainMappingProperties as $property => $mapping) {
-			$columnMapping = array('column' => $request->getArgument($property), 'mapping' => $mapping);
+		foreach ($mappingProperties as $property => $mapping) {
+			$column = isset($columns[$property]) ? $columns[$property] : '';
+			$columnMapping = array('column' => $column, 'mapping' => $mapping);
 			$mappings[$property] = $columnMapping;
 		}
 		return $mappings;
 	}
 
 	/**
-	 * @param \WE\SpreadsheetImport\SpreadsheetImportService $spreadsheetImportService
+	 * @param array $mapping
 	 * @param int $record
 	 *
 	 * @return array
 	 */
-	public static function getMappingPreview(SpreadsheetImportService $spreadsheetImportService, $record) {
-		$domainMappingProperties = $spreadsheetImportService->getMappingProperties();
-		$previewObject = $spreadsheetImportService->getObjectByRow($record);
+	public function getMappingPreview($mapping, $record) {
+		$previewObject = $this->spreadsheetImportService->getObjectByRow($record);
 		$preview = array();
-		/** @var Mapping $mapping */
-		foreach ($domainMappingProperties as $property => $mapping) {
+		foreach ($mapping as $property => $columnMapping) {
+			/** @var Mapping $mapping */
+			$mapping = $columnMapping['mapping'];
 			$getter = empty($mapping->getter) ? 'get' . ucfirst($property) : $mapping->getter;
 			$preview[$property] = $previewObject->$getter();
 		}

Classes/WE/SpreadsheetImport/SpreadsheetImportService.php

@@ -20,6 +20,7 @@ use WE\SpreadsheetImport\Domain\Model\SpreadsheetImport;
  * @Flow\Scope("singleton")
  */
 class SpreadsheetImportService {
+
 	/**
 	 * @var SpreadsheetImport
 	 */
@@ -30,16 +31,6 @@ class SpreadsheetImportService {
 	 */
 	protected $domain;
 
-	/**
-	 * @var array
-	 */
-	protected $mappingProperties;
-
-	/**
-	 * @var array
-	 */
-	protected $inverseSpreadsheetImportMapping;
-
 	/**
 	 * @Flow\InjectConfiguration
 	 * @var array
@@ -76,6 +67,13 @@ class SpreadsheetImportService {
 	 */
 	protected $validatorResolver;
 
+	/**
+	 * Inverse SpreadsheetImport mapping array
+	 *
+	 * @var array
+	 */
+	private $inverseSpreadsheetImportMapping;
+
 	/**
 	 * @param \WE\SpreadsheetImport\Domain\Model\SpreadsheetImport $spreadsheetImport
 	 *
@@ -84,65 +82,20 @@ class SpreadsheetImportService {
 	public function init(SpreadsheetImport $spreadsheetImport) {
 		$this->spreadsheetImport = $spreadsheetImport;
 		$this->domain = $this->settings[$spreadsheetImport->getContext()]['domain'];
-		$this->initDomainMappingProperties();
 
 		return $this;
 	}
 
 	/**
-	 * Initializes the properties declared by annotations.
+	 * @return array
 	 */
-	private function initDomainMappingProperties() {
-		$this->mappingProperties = array();
+	public function getAnnotationMappingProperties() {
+		$mappingPropertyAnnotations = array();
 		$properties = $this->reflectionService->getPropertyNamesByAnnotation($this->domain, Mapping::class);
 		foreach ($properties as $property) {
-			$this->mappingProperties[$property] = $this->reflectionService->getPropertyAnnotation($this->domain, $property, Mapping::class);
+			$mappingPropertyAnnotations[$property] = $this->reflectionService->getPropertyAnnotation($this->domain, $property, Mapping::class);
 		}
-	}
-
-	/**
-	 * Return an inverse SpreadsheetImport mapping array. It flips the property and column attribute and returns it as a
-	 * 3-dim array instead of a 2-dim array. The reason for that is the case when the same column is assigned to multiple
-	 * properties.
-	 */
-	private function getInverseSpreadsheetImportMapping() {
-		if (empty($this->inverseSpreadsheetImportMapping)) {
-			$this->inverseSpreadsheetImportMapping = array();
-			foreach ($this->spreadsheetImport->getMapping() as $property => $columnMapping) {
-				$column = $columnMapping['column'];
-				$propertyMapping = array('property' => $property, 'mapping' => $columnMapping['mapping']);
-				$this->inverseSpreadsheetImportMapping[$column][] = $propertyMapping;
-			}
-		}
-		return $this->inverseSpreadsheetImportMapping;
-	}
-
-	/**
-	 * Adds additional mapping properties to the domain mapping properties retrieved by annotations. This increases
-	 * flexibility for dynamic property mapping.
-	 *
-	 * This is implemented for the single use case to support the Flow package Radmiraal.CouchDB
-	 *
-	 * @param array $additionalMappingProperties
-	 */
-	public function addAdditionalMappingProperties(array $additionalMappingProperties) {
-		$this->mappingProperties = array_merge($this->mappingProperties, $additionalMappingProperties);
-	}
-
-	/**
-	 * @return array
-	 */
-	public function getMappingProperties() {
-		return $this->mappingProperties;
-	}
-
-	/**
-	 * @param string $context
-	 *
-	 * @return array
-	 */
-	public function getArgumentsByContext($context) {
-		return $this->settings[$context]['arguments'];
+		return $mappingPropertyAnnotations;
 	}
 
 	/**
@@ -348,11 +301,28 @@ class SpreadsheetImportService {
 		$this->setObjectArgumentProperties($object);
 	}
 
+	/**
+	 * Return an inverse SpreadsheetImport mapping array. It flips the property and column attribute and returns it as a
+	 * 3-dim array instead of a 2-dim array. The reason for that is the case when the same column is assigned to multiple
+	 * properties.
+	 */
+	private function getInverseSpreadsheetImportMapping() {
+		if (empty($this->inverseSpreadsheetImportMapping)) {
+			$this->inverseSpreadsheetImportMapping = array();
+			foreach ($this->spreadsheetImport->getMapping() as $property => $columnMapping) {
+				$column = $columnMapping['column'];
+				$propertyMapping = array('property' => $property, 'mapping' => $columnMapping['mapping']);
+				$this->inverseSpreadsheetImportMapping[$column][] = $propertyMapping;
+			}
+		}
+		return $this->inverseSpreadsheetImportMapping;
+	}
+
 	/**
 	 * @param $object
 	 */
 	private function setObjectArgumentProperties($object) {
-		$contextArguments = $this->getArgumentsByContext($this->spreadsheetImport->getContext());
+		$contextArguments = $this->settings[$this->spreadsheetImport->getContext()]['arguments'];
 		if (is_array($contextArguments)) {
 			$arguments = $this->spreadsheetImport->getArguments();
 			foreach ($contextArguments as $contextArgument) {

Tests/Functional/SpreadsheetImportServiceTest.php

@@ -72,7 +72,7 @@ class SpreadsheetImportServiceTest extends FunctionalTestCase {
 	 * @test
 	 */
 	public function getMappingPropertiesReturnsPropertiesWithMappingAnnotation() {
-		$properties = $this->spreadsheetImportService->getMappingProperties();
+		$properties = $this->spreadsheetImportService->getAnnotationMappingProperties();
 		$this->assertArrayHasKey('id', $properties);
 		$this->assertArrayHasKey('name', $properties);
 		/** @var Mapping $id */