Lots of new code for new importer routine.

2025-09-29 18:20:01 +00:00 · 2017-06-10 15:09:41 +02:00
parent 0b4efe4ae1
commit 091596e80e
25 changed files with 1415 additions and 423 deletions
--- a/app/Import/Configurator/CsvConfigurator.php
+++ b/app/Import/Configurator/CsvConfigurator.php
@@ -0,0 +1,140 @@
+<?php
+/**
+ * CsvConfigurator.php
+ * Copyright (c) 2017 thegrumpydictator@gmail.com
+ * This software may be modified and distributed under the terms of the Creative Commons Attribution-ShareAlike 4.0 International License.
+ *
+ * See the LICENSE file for details.
+ */
+
+declare(strict_types=1);
+
+namespace FireflyIII\Import\Configurator;
+
+use FireflyIII\Exceptions\FireflyException;
+use FireflyIII\Models\ImportJob;
+use FireflyIII\Support\Import\Configuration\ConfigurationInterface;
+use Log;
+
+/**
+ * Class CsvConfigurator
+ *
+ * @package FireflyIII\Import\Configurator
+ */
+class CsvConfigurator implements ConfiguratorInterface
+{
+    private $job;
+
+    public function __construct(ImportJob $job)
+    {
+        $this->job = $job;
+        if (is_null($this->job->configuration) || count($this->job->configuration) === 0) {
+            Log::debug(sprintf('Gave import job %s initial configuration.', $this->job->key));
+            $this->job->configuration = config('csv.default_config');
+            $this->job->save();
+        }
+    }
+
+    /**
+     * Store any data from the $data array into the job.
+     *
+     * @param array $data
+     *
+     * @return bool
+     * @throws FireflyException
+     */
+    public function configureJob(array $data): bool
+    {
+        $class = $this->getConfigurationClass();
+
+        /** @var ConfigurationInterface $object */
+        $object = new $class($this->job);
+
+        return $object->storeConfiguration($data);
+    }
+
+    /**
+     * Return the data required for the next step in the job configuration.
+     *
+     * @return array
+     * @throws FireflyException
+     */
+    public function getNextData(): array
+    {
+        $class = $this->getConfigurationClass();
+
+        /** @var ConfigurationInterface $object */
+        $object = new $class($this->job);
+
+        return $object->getData();
+
+    }
+
+    /**
+     * @return string
+     * @throws FireflyException
+     */
+    public function getNextView(): string
+    {
+        if (!$this->job->configuration['initial-config-complete']) {
+            return 'import.csv.initial';
+        }
+        if (!$this->job->configuration['column-roles-complete']) {
+            return 'import.csv.roles';
+        }
+        if (!$this->job->configuration['column-mapping-complete']) {
+            return 'import.csv.map';
+        }
+
+        throw new FireflyException('No view for state');
+    }
+
+    /**
+     * @return bool
+     */
+    public function isJobConfigured(): bool
+    {
+        if ($this->job->configuration['initial-config-complete']
+            && $this->job->configuration['column-roles-complete']
+            && $this->job->configuration['column-mapping-complete']
+        ) {
+            $this->job->status = 'configured';
+            $this->job->save();
+
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * @return string
+     * @throws FireflyException
+     */
+    private function getConfigurationClass(): string
+    {
+        $class = false;
+        switch (true) {
+            case(!$this->job->configuration['initial-config-complete']):
+                $class = 'FireflyIII\\Support\\Import\\Configuration\\Csv\\Initial';
+                break;
+            case (!$this->job->configuration['column-roles-complete']):
+                $class = 'FireflyIII\\Support\\Import\\Configuration\\Csv\\Roles';
+                break;
+            case (!$this->job->configuration['column-mapping-complete']):
+                $class = 'FireflyIII\\Support\\Import\\Configuration\\Csv\\Map';
+                break;
+            default:
+                break;
+        }
+
+        if ($class === false) {
+            throw new FireflyException('Cannot handle current job state in getConfigurationClass().');
+        }
+        if (!class_exists($class)) {
+            throw new FireflyException(sprintf('Class %s does not exist in getConfigurationClass().', $class));
+        }
+
+        return $class;
+    }
+}