[FOLLOWUP] Rename configuration variables and methods, deprecate old …

…methods, reference #140

Classes/Controller/DataModuleController.php

@@ -285,7 +285,7 @@ public function viewConfigurationAction($table, $index): void
                 $table,
                 $index
         );
-        $connector = $configuration->getCtrlConfigurationProperty('connector');
+        $connector = $configuration->getGeneralConfigurationProperty('connector');
         // Define which action to go back to for the close button (depends on whether the configuration is synchronizable or not)
         if (empty($connector)) {
             $returnAction = 'listNonSynchronizable';

Classes/Domain/Model/Configuration.php

@@ -37,9 +37,9 @@ class Configuration
     protected $index;
 
     /**
-     * @var array "ctrl" part of the External Import configuration
+     * @var array General part of the External Import configuration
      */
-    protected $ctrlConfiguration;
+    protected $generalConfiguration;
 
     /**
      * @var array External Import configuration for each column
@@ -121,28 +121,30 @@ public function setIndex($index): void
     }
 
     /**
+     * Returns the general external configuration
+     *
      * @return array|null
      */
-    public function getCtrlConfiguration(): ?array
+    public function getGeneralConfiguration(): ?array
     {
-        return $this->ctrlConfiguration;
+        return $this->generalConfiguration;
     }
 
     /**
-     * Sets the "ctrl" part of the configuration and performs extra processing
+     * Sets the general configuration and performs extra processing
      * on some properties.
      *
-     * @param array $ctrlConfiguration
+     * @param array $generalConfiguration
      * @param array $defaultSteps List of default steps (if null will be guessed by the repository)
      * @return void
      */
-    public function setCtrlConfiguration(array $ctrlConfiguration, $defaultSteps = null): void
+    public function setGeneralConfiguration(array $generalConfiguration, $defaultSteps = null): void
     {
-        $this->ctrlConfiguration = $ctrlConfiguration;
+        $this->generalConfiguration = $generalConfiguration;
         // Define the process default steps, depending on process type or the predefined value
         // NOTE: normally default steps should always be defined
         if ($defaultSteps === null) {
-            if (array_key_exists('connector', $ctrlConfiguration)) {
+            if (array_key_exists('connector', $generalConfiguration)) {
                 $steps = Importer::SYNCHRONYZE_DATA_STEPS;
             } else {
                 $steps = Importer::IMPORT_DATA_STEPS;
@@ -151,22 +153,22 @@ public function setCtrlConfiguration(array $ctrlConfiguration, $defaultSteps = n
             $steps = $defaultSteps;
         }
         // Perform extra processing for custom steps
-        if (array_key_exists('customSteps', $ctrlConfiguration)) {
-            foreach ($ctrlConfiguration['customSteps'] as $customStepConfiguration) {
+        if (array_key_exists('customSteps', $generalConfiguration)) {
+            foreach ($generalConfiguration['customSteps'] as $customStepConfiguration) {
                 $steps = $this->stepUtility->insertStep($steps, $customStepConfiguration);
             }
         }
         $this->steps = $steps;
 
         // Store the storage pid from the configuration
         // It is stored in a separate variable as it might be overridden
-        $this->storagePid = $ctrlConfiguration['pid'];
+        $this->storagePid = $generalConfiguration['pid'];
 
         // Perform extra processing for additional fields
-        if (array_key_exists('additionalFields', $ctrlConfiguration)) {
+        if (array_key_exists('additionalFields', $generalConfiguration)) {
             $additionalFields = GeneralUtility::trimExplode(
                     ',',
-                    $ctrlConfiguration['additionalFields'],
+                    $generalConfiguration['additionalFields'],
                     true
             );
             $this->setAdditionalFields($additionalFields);
@@ -182,14 +184,67 @@ public function setCtrlConfiguration(array $ctrlConfiguration, $defaultSteps = n
      * @param $key
      * @return mixed|null
      */
-    public function getCtrlConfigurationProperty($key)
+    public function getGeneralConfigurationProperty($key)
     {
-        if (array_key_exists($key, $this->ctrlConfiguration)) {
-            return $this->ctrlConfiguration[$key];
+        if (array_key_exists($key, $this->generalConfiguration)) {
+            return $this->generalConfiguration[$key];
         }
         return null;
     }
 
+    /**
+     * TODO: remove once backward-compatibility is dropped
+     *
+     * @return array|null
+     * @deprecated use \Cobweb\ExternalImport\Domain\Model\Configuration::getGeneralConfiguration() instead
+     */
+    public function getCtrlConfiguration(): ?array
+    {
+        trigger_error(
+            'Using \Cobweb\ExternalImport\Domain\Model\Configuration::getCtrlConfiguration() is deprecated. Use \Cobweb\ExternalImport\Domain\Model\Configuration::getGeneralConfiguration() instead.',
+            E_USER_DEPRECATED
+        );
+        return $this->getGeneralConfiguration();
+    }
+
+    /**
+     * Sets the "ctrl" configuration and performs extra processing
+     * on some properties.
+     *
+     * TODO: remove once backward-compatibility is dropped
+     *
+     * @param array $ctrlConfiguration
+     * @param array $defaultSteps List of default steps (if null will be guessed by the repository)
+     * @return void
+     * @deprecated use \Cobweb\ExternalImport\Domain\Model\Configuration::setGeneralConfiguration() instead
+     */
+    public function setCtrlConfiguration(array $ctrlConfiguration, $defaultSteps = null): void
+    {
+        trigger_error(
+            'Using \Cobweb\ExternalImport\Domain\Model\Configuration::setCtrlConfiguration() is deprecated. Use \Cobweb\ExternalImport\Domain\Model\Configuration::setGeneralConfiguration() instead.',
+            E_USER_DEPRECATED
+        );
+        $this->setGeneralConfiguration($ctrlConfiguration, $defaultSteps);
+    }
+
+    /**
+     * Returns a specific property from the "ctrl" configuration.
+     *
+     * TODO: remove once backward-compatibility is dropped
+     *
+     * @param $key
+     * @return mixed|null
+     * @deprecated use \Cobweb\ExternalImport\Domain\Model\Configuration::getGeneralConfigurationProperty() instead
+     */
+    public function getCtrlConfigurationProperty($key)
+    {
+        trigger_error(
+            'Using \Cobweb\ExternalImport\Domain\Model\Configuration::getCtrlConfigurationProperty() is deprecated. Use \Cobweb\ExternalImport\Domain\Model\Configuration::getGeneralConfigurationProperty() instead.',
+            E_USER_DEPRECATED
+        );
+        return $this->getGeneralConfigurationProperty($key);
+    }
+
     /**
      * @return array|null
      */

Classes/Domain/Repository/ConfigurationRepository.php

@@ -253,7 +253,7 @@ public function findConfigurationObject($table, $index, $defaultSteps = null): C
         // Set the values in the Configuration object
         $configuration->setTable($table);
         $configuration->setIndex($index);
-        $configuration->setCtrlConfiguration($ctrlConfiguration, $defaultSteps);
+        $configuration->setGeneralConfiguration($ctrlConfiguration, $defaultSteps);
         $configuration->setColumnConfiguration($columnsConfiguration);
         return $configuration;
     }

Classes/Domain/Repository/UidRepository.php

@@ -73,7 +73,7 @@ protected function retrieveExistingUids(): void
         }
 
         $table = $this->configuration->getTable();
-        $ctrlConfiguration = $this->configuration->getCtrlConfiguration();
+        $ctrlConfiguration = $this->configuration->getGeneralConfiguration();
         $where = '1 = 1';
         // TODO: use QueryBuilder to add constraints properly (verify that whereClause indeed works)
         if ($ctrlConfiguration['enforcePid']) {

Classes/Handler/XmlHandler.php

@@ -37,7 +37,7 @@ public function handleData($rawData, Importer $importer): array
         $data = [];
         $counter = 0;
         $configuration = $importer->getExternalConfiguration();
-        $ctrlConfiguration = $configuration->getCtrlConfiguration();
+        $ctrlConfiguration = $configuration->getGeneralConfiguration();
         $columnConfiguration = $configuration->getColumnConfiguration();
 
         // Load the XML into a DOM object

Classes/Step/ClearCacheStep.php

@@ -32,7 +32,7 @@ class ClearCacheStep extends AbstractStep
      */
     public function run(): void
     {
-        $configuration = $this->configuration->getCtrlConfiguration();
+        $configuration = $this->configuration->getGeneralConfiguration();
         if (empty($configuration['clearCache'])) {
             $this->importer->setPreviewData(
                     [

Classes/Step/ConnectorCallbackStep.php

@@ -41,7 +41,7 @@ public function run(): void
                 $errorStatus = true;
             }
             $this->configuration->getConnector()->postProcessOperations(
-                    $this->configuration->getCtrlConfigurationProperty('parameters'),
+                    $this->configuration->getGeneralConfigurationProperty('parameters'),
                     $errorStatus
             );
         }

Classes/Step/HandleDataStep.php

@@ -56,7 +56,7 @@ public function injectXmlHander(XmlHandler $handler): void
      */
     public function run(): void
     {
-        $ctrlConfiguration = $this->configuration->getCtrlConfiguration();
+        $ctrlConfiguration = $this->configuration->getGeneralConfiguration();
         $originalData = $this->getData()->getRawData();
         // Check for custom data handlers
         if (!empty($ctrlConfiguration['dataHandler'])) {

Classes/Step/ReadDataStep.php

@@ -34,7 +34,7 @@ class ReadDataStep extends AbstractStep
      */
     public function run(): void
     {
-        $ctrlConfiguration = $this->configuration->getCtrlConfiguration();
+        $ctrlConfiguration = $this->configuration->getGeneralConfiguration();
         // Check if there are any services of the given type
         $services = ExtensionManagementUtility::findService(
                 'connector',

Classes/Step/StoreDataStep.php

@@ -75,7 +75,7 @@ public function run(): void
         $existingUids = $existingUids ?? [];
         $currentPids = $currentPids ?? [];
 
-        $ctrlConfiguration = $this->getConfiguration()->getCtrlConfiguration();
+        $ctrlConfiguration = $this->getConfiguration()->getGeneralConfiguration();
         $columnConfiguration = $this->getConfiguration()->getColumnConfiguration();
         $table = $this->importer->getExternalConfiguration()->getTable();
         // Extract list of excluded fields
@@ -104,7 +104,7 @@ public function run(): void
         $countConfiguredAdditionalFields = $this->getConfiguration()->getCountAdditionalFields();
         $isUpdateAllowed = !GeneralUtility::inList($ctrlConfiguration['disabledOperations'], 'update');
         $isInsertAllowed = !GeneralUtility::inList($ctrlConfiguration['disabledOperations'], 'insert');
-        $updateSlugs = (bool)$this->getConfiguration()->getCtrlConfigurationProperty('updateSlugs');
+        $updateSlugs = (bool)$this->getConfiguration()->getGeneralConfigurationProperty('updateSlugs');
         foreach ($records as $theRecord) {
             $localAdditionalFields = [];
             $externalUid = $theRecord[$ctrlConfiguration['referenceUid']];

Classes/Step/ValidateConfigurationStep.php

@@ -52,7 +52,7 @@ public function injectColumnValidator(\Cobweb\ExternalImport\Validator\ColumnCon
      */
     public function run(): void
     {
-        $ctrlConfiguration = $this->configuration->getCtrlConfiguration();
+        $ctrlConfiguration = $this->configuration->getGeneralConfiguration();
         // If there's no "ctrl" configuration, issue error
         if (count($ctrlConfiguration) === 0) {
             $this->importer->addMessage(

Classes/Step/ValidateConnectorStep.php

@@ -31,7 +31,7 @@ class ValidateConnectorStep extends AbstractStep
      */
     public function run(): void
     {
-        $ctrlConfiguration = $this->configuration->getCtrlConfiguration();
+        $ctrlConfiguration = $this->configuration->getGeneralConfiguration();
         if (empty($ctrlConfiguration['connector'])) {
             $this->importer->addMessage(
                     LocalizationUtility::translate(

Classes/Step/ValidateDataStep.php

@@ -34,7 +34,7 @@ class ValidateDataStep extends AbstractStep
      */
     public function run(): void
     {
-        $ctrlConfiguration = $this->configuration->getCtrlConfiguration();
+        $ctrlConfiguration = $this->configuration->getGeneralConfiguration();
         $records = $this->getData()->getRecords();
 
         // Check if number of records is larger than or equal to the minimum required number of records

Classes/Task/AutomatedSyncTask.php

@@ -162,7 +162,7 @@ public function getAdditionalInformation()
                     LocalizationUtility::translate('LLL:EXT:external_import/Resources/Private/Language/ExternalImport.xlf:tableIndexAndPriority'),
                     $this->table,
                     $this->index,
-                    $configuration->getCtrlConfigurationProperty('priority')
+                    $configuration->getGeneralConfigurationProperty('priority')
             );
         }
         return $info;

Classes/Validator/ColumnConfigurationValidator.php

@@ -51,7 +51,7 @@ public function isValid(Configuration $configuration, $column): bool
         $columnConfiguration = $configuration->getConfigurationForColumn($column);
         // Validate properties used to choose the import value
         $this->validateDataSettingProperties(
-                $configuration->getCtrlConfiguration(),
+                $configuration->getGeneralConfiguration(),
                 $columnConfiguration
         );
         // Check for deprecated transformation properties

Classes/Validator/ControlConfigurationValidator.php

@@ -68,7 +68,7 @@ public function injectStepUtility(StepUtility $stepUtility): void
     public function isValid(Configuration $configuration): bool
     {
         $this->table = $configuration->getTable();
-        $ctrlConfiguration = $configuration->getCtrlConfiguration();
+        $ctrlConfiguration = $configuration->getGeneralConfiguration();
 
         // Validate all properties on which conditions apply
         $this->validateDataProperty($ctrlConfiguration['data']);

Classes/ViewHelpers/ProcessedParametersViewHelper.php

@@ -63,7 +63,7 @@ public static function renderStatic(array $arguments, \Closure $renderChildrenCl
             foreach ($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['external_import']['processParameters'] as $className) {
                 $preProcessor = GeneralUtility::makeInstance($className);
                 $processedParameters = $preProcessor->processParameters(
-                        $configuration->getCtrlConfigurationProperty('parameters'),
+                        $configuration->getGeneralConfigurationProperty('parameters'),
                         $configuration
                 );
             }

Documentation/Developer/Api/Index.rst

@@ -98,8 +98,12 @@ table
 index
   The index of the configuration being used.
 
-ctrlConfiguration
-  The "ctrl" part of the External Import TCA configuration.
+generalConfiguration
+  The general part of the External Import TCA configuration.
+
+  .. note::
+
+     This is still availabe as `ctrlConfiguration` but support will be dropped in the future.
 
 columnConfiguration
   The columns configuration part of the External Import TCA configuration.

Tests/Functional/Domain/Model/ConfigurationTest.php

@@ -91,20 +91,20 @@ public function getCountAdditionalFieldsInitiallyReturnsZero(): void
     /**
      * @test
      */
-    public function getCtrlConfigurationInitiallyReturnsNull(): void
+    public function getGenerallConfigurationInitiallyReturnsNull(): void
     {
         self::assertNull(
-                $this->subject->getCtrlConfiguration()
+                $this->subject->getGeneralConfiguration()
         );
     }
 
     /**
      * @test
      */
-    public function getCtrlConfigurationPropertyInitiallyReturnsNull(): void
+    public function getGenerallConfigurationPropertyInitiallyReturnsNull(): void
     {
         self::assertNull(
-                $this->subject->getCtrlConfigurationProperty('foo')
+                $this->subject->getGeneralConfigurationProperty('foo')
         );
     }
 
@@ -171,12 +171,12 @@ public function ctrlConfigurationProvider(): array
      * @param array $additionalFields
      * @dataProvider ctrlConfigurationProvider
      */
-    public function setCtrlConfigurationSetsCtrlConfigurationAndMore($configuration, $pid, $additionalFields): void
+    public function setGeneralConfigurationSetsGeneralConfigurationAndMore($configuration, $pid, $additionalFields): void
     {
-        $this->subject->setCtrlConfiguration($configuration);
+        $this->subject->setGeneralConfiguration($configuration);
         self::assertSame(
                 $configuration,
-                $this->subject->getCtrlConfiguration()
+                $this->subject->getGeneralConfiguration()
         );
         self::assertEquals(
                 $pid,

Tests/Functional/Domain/Repository/ConfigurationRepositoryTest.php

@@ -163,12 +163,12 @@ public function findConfigurationObjectReturnsExpectedConfiguration($table, $ind
         );
         self::assertSame(
                 $expectedCtrlValue,
-                $configuration->getCtrlConfigurationProperty('nodetype')
+                $configuration->getGeneralConfigurationProperty('nodetype')
         );
         self::assertSame(
                 $expectedColumnConfiguration,
                 $configuration->getConfigurationForColumn(
-                        $configuration->getCtrlConfigurationProperty('referenceUid')
+                        $configuration->getGeneralConfigurationProperty('referenceUid')
                 )
         );
     }

Tests/Functional/Domain/Repository/UidRepositoryTest.php

@@ -101,7 +101,7 @@ public function getExistingUidsTriggersFetchingOfUidsAndPids($configuration, $li
         $this->importDataSet(__DIR__ . '/../../Fixtures/UidRepository.xml');
         $configurationObject = $this->objectManager->get(Configuration::class);
         $configurationObject->setTable('tt_content');
-        $configurationObject->setCtrlConfiguration($configuration);
+        $configurationObject->setGeneralConfiguration($configuration);
         if ($configuration['enforcePid']) {
             $configurationObject->setStoragePid(1);
         }

Tests/Functional/Validator/ColumnConfigurationValidatorTest.php

@@ -170,7 +170,7 @@ public function validConfigurationProvider(): array
     public function isValidReturnsTrueForValidConfiguration($controlConfiguration, $columnConfiguration): void
     {
         $configuration = $this->objectManager->get(Configuration::class);
-        $configuration->setCtrlConfiguration($controlConfiguration);
+        $configuration->setGeneralConfiguration($controlConfiguration);
         $configuration->setColumnConfiguration($columnConfiguration);
         self::assertTrue(
                 $this->subject->isValid(
@@ -234,7 +234,7 @@ public function invalidConfigurationProvider(): array
     public function isValidRaisesMessageForInvalidConfiguration($controlConfiguration, $columnConfiguration, $severity): void
     {
         $configuration = $this->objectManager->get(Configuration::class);
-        $configuration->setCtrlConfiguration($controlConfiguration);
+        $configuration->setGeneralConfiguration($controlConfiguration);
         $configuration->setColumnConfiguration($columnConfiguration);
         $this->subject->isValid(
                 $configuration,