Merge pull request #21 from netlogix/feature/rector-update

.editorconfig

@@ -3,58 +3,23 @@
 # top-most EditorConfig file
 root = true
 
-# Unix-style newlines with a newline ending every file
 [*]
 charset = utf-8
 end_of_line = lf
-indent_style = space
 indent_size = 4
+indent_style = space
 insert_final_newline = true
 trim_trailing_whitespace = true
+max_line_length = 180
 
-# TS/JS-Files
-[*.{ts,js}]
-indent_size = 2
-
-# JSON-Files
-[*.json]
-indent_style = tab
-
-# ReST-Files
-[*.{rst,rst.txt}]
-indent_size = 4
-max_line_length = 80
-
-# Markdown-Files
-[*.md]
-max_line_length = 80
+[*.php]
+max_line_length = 115
 
-# YAML-Files
-[*.{yaml,yml}]
+[*.{ts,tsx,js,json}]
 indent_size = 2
 
-# NEON-Files
-[*.neon]
-indent_size = 2
-indent_style = tab
-
-# package.json
-[package.json]
-indent_size = 2
-
-# TypoScript
 [*.{typoscript,tsconfig}]
 indent_size = 2
 
-# XLF-Files
-[*.xlf]
-indent_style = tab
-
-# SQL-Files
-[*.sql]
-indent_style = tab
+[{*.yml,*.yaml}]
 indent_size = 2
-
-# .htaccess
-[{_.htaccess,.htaccess}]
-indent_style = tab

Classes/Command/BatchCommand.php

@@ -7,6 +7,7 @@
 use Netlogix\Nxgooglelocations\Domain\Model\Batch;
 use Netlogix\Nxgooglelocations\Domain\Repository\BatchRepository;
 use Netlogix\Nxgooglelocations\Enumerations\BatchState;
+use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
@@ -15,6 +16,10 @@
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 use TYPO3\CMS\Extbase\Persistence\PersistenceManagerInterface;
 
+#[AsCommand(
+    name: 'nxgooglelocations:runscheduledjobs',
+    description: 'Run batch processing for Google Locations'
+)]
 class BatchCommand extends Command
 {
     public function __construct(

Classes/Controller/ModuleController.php

@@ -31,7 +31,7 @@ abstract class ModuleController extends ActionController
 {
     protected array $pageRecord = [];
 
-    protected ?ModuleTemplate $moduleTemplate;
+    protected ?ModuleTemplate $moduleTemplate = null;
 
     public function __construct(
         private readonly ModuleTemplateFactory $moduleTemplateFactory,
@@ -129,7 +129,7 @@ public function importAction(int $id, bool $deleteUnused, bool $cancelPrevious,
         try {
             $batch->validate();
         } catch (Exception $exception) {
-            $this->addFlashMessage($exception->getMessage(), '', AbstractMessage::ERROR);
+            $this->addFlashMessage($exception->getMessage(), '', \TYPO3\CMS\Core\Type\ContextualFeedbackSeverity::ERROR);
             return $this->redirect('index');
         }
 
@@ -162,7 +162,7 @@ public function exportAction(): ResponseInterface
         return $this->htmlResponse();
     }
 
-    public function errorAction(): ResponseInterface
+    protected function errorAction(): ResponseInterface
     {
         return $this->getModuleTemplateResponse()
             ->withStatus(400);
@@ -174,7 +174,7 @@ protected function forwardToErrorWithCannedMessage(string $reason): ResponseInte
         $this->addFlashMessage(
             LocalizationUtility::translate(sprintf('module.flash-messages.%s.content', $reason), $extensionName),
             LocalizationUtility::translate(sprintf('module.flash-messages.%s.title', $reason), $extensionName),
-            AbstractMessage::ERROR
+            \TYPO3\CMS\Core\Type\ContextualFeedbackSeverity::ERROR
         );
         return $this->redirect('error');
     }

Classes/Domain/Model/Batch.php

@@ -23,8 +23,6 @@ class Batch extends AbstractEntity
 
     protected string $fileHash;
 
-    protected bool $deleteUnused;
-
     #[TYPO3\Transient]
     protected ?BackendUserImpersonator $impersonator = null;
 
@@ -51,7 +49,7 @@ class Batch extends AbstractEntity
 
     protected int $geocodingRequests = 0;
 
-    protected ?DateTime $tstamp;
+    protected ?DateTime $tstamp = null;
 
     /**
      * @var string[]
@@ -69,12 +67,11 @@ public function __construct(
         protected int $backendUserId,
         string $filePath,
         string $fileName = '',
-        bool $deleteUnused = true
+        protected bool $deleteUnused = true
     ) {
         $this->fileName = pathinfo($fileName ?: $filePath, PATHINFO_BASENAME);
         $this->fileContent = base64_encode(file_get_contents(GeneralUtility::getFileAbsFileName($filePath)));
         $this->fileHash = sha1($this->fileContent);
-        $this->deleteUnused = $deleteUnused;
     }
 
     public function getFileName(): string
@@ -161,7 +158,7 @@ protected function collectTcaRecords(): array
         return $tcaRecords;
     }
 
-    protected function executeDataHandler($tcaRecords): void
+    protected function executeDataHandler(array $tcaRecords): void
     {
         $backendUserId = $this->backendUserId;
         $storagePageId = $this->storagePageId;
@@ -243,19 +240,19 @@ protected function getLocationFactory(): LocationFactory
 
     protected function initializeServices(): void
     {
-        if (!$this->impersonator) {
+        if (!$this->impersonator instanceof \Netlogix\Nxgooglelocations\Service\BackendUserImpersonator) {
             $this->impersonator = GeneralUtility::makeInstance(BackendUserImpersonator::class);
         }
 
-        if (!$this->geoCoder) {
+        if (!$this->geoCoder instanceof \Netlogix\Nxgooglelocations\Service\GeoCoder) {
             $this->geoCoder = GeneralUtility::makeInstance($this->serviceClasses[GeoCoder::class], $this->apiKey);
         }
 
-        if (!$this->importer) {
+        if (!$this->importer instanceof \Netlogix\Nxgooglelocations\Service\Importer) {
             $this->importer = GeneralUtility::makeInstance($this->serviceClasses[Importer::class], $this->storagePageId);
         }
 
-        if (!$this->locationFactory) {
+        if (!$this->locationFactory instanceof \Netlogix\Nxgooglelocations\Service\LocationFactory) {
             $this->locationFactory = GeneralUtility::makeInstance($this->serviceClasses[LocationFactory::class]);
         }
     }

Classes/Enumerations/BatchState.php

@@ -11,30 +11,30 @@ final class BatchState extends Enumeration
     /**
      * @var string
      */
-    final public const __default = self::NEW;
+    public const __default = self::NEW;
 
     /**
      * @var string
      */
-    final public const NEW = 'new';
+    public const NEW = 'new';
 
     /**
      * @var string
      */
-    final public const VALIDATING = 'validating';
+    public const VALIDATING = 'validating';
 
     /**
      * @var string
      */
-    final public const GEOCODING = 'running';
+    public const GEOCODING = 'running';
 
     /**
      * @var string
      */
-    final public const PERSISTING = 'persisting';
+    public const PERSISTING = 'persisting';
 
     /**
      * @var string
      */
-    final public const CLOSED = 'closed';
+    public const CLOSED = 'closed';
 }

Classes/Enumerations/CodingResultProbability.php

@@ -11,15 +11,15 @@ final class CodingResultProbability extends Enumeration
     /**
      * @var int
      */
-    final public const ZERO_RESULTS = -1;
+    public const ZERO_RESULTS = -1;
 
     /**
      * @var int
      */
-    final public const MANUALLY_IMPORT = -255;
+    public const MANUALLY_IMPORT = -255;
 
     /**
      * @var int
      */
-    final public const MANUALLY_EDITOR = -256;
+    public const MANUALLY_EDITOR = -256;
 }

Classes/Enumerations/GeoCoderStatus.php

@@ -11,10 +11,10 @@ final class GeoCoderStatus extends Enumeration
     /**
      * @var string
      */
-    final public const OK = 'OK';
+    public const OK = 'OK';
 
     /**
      * @var string
      */
-    final public const ZERO_RESULTS = 'ZERO_RESULTS';
+    public const ZERO_RESULTS = 'ZERO_RESULTS';
 }

Classes/Service/ExcelServiceTrait.php

@@ -12,6 +12,7 @@
 trait ExcelServiceTrait
 {
     protected ?Worksheet $templateSheet;
+
     protected ?Worksheet $contentSheet;
 
     public function resetTemplateSheet(string $templateFileName): void

Classes/Service/GeoCoder.php

@@ -14,20 +14,12 @@
 
 abstract class GeoCoder
 {
-    /**
-     * @var string
-     */
+
     final public const FETCH_URL = 'https://maps.googleapis.com/maps/api/geocode/json?address=%s&key=%s';
 
-    /**
-     * @var FieldMap
-     */
-    protected $fieldMap;
+    protected FieldMap $fieldMap;
 
-    /**
-     * @var string
-     */
-    protected $fieldMapClassName = FieldMap::class;
+    protected string $fieldMapClassName = FieldMap::class;
 
     /**
      * The number of geocoding results must be lower than this in order to make an existing

Classes/Service/LocationFactory.php

@@ -15,22 +15,13 @@ abstract class LocationFactory
 {
     use ExcelServiceTrait;
 
-    protected $templateFileName = '/dev/null';
+    protected string $templateFileName = '/dev/null';
 
-    /**
-     * @var FieldMap
-     */
-    protected $fieldMap;
+    protected FieldMap $fieldMap;
 
-    /**
-     * @var string
-     */
-    protected $fieldMapClassName = FieldMap::class;
+    protected string $fieldMapClassName = FieldMap::class;
 
-    /**
-     * @var string
-     */
-    protected $recordTableName = '';
+    protected string $recordTableName = '';
 
     protected array $columnNameMap = [
         'A' => 'title',
@@ -40,7 +31,7 @@ abstract class LocationFactory
         'E' => 'longitude',
     ];
 
-    protected ?Worksheet $templateSheet;
+    protected ?Worksheet $templateSheet = null;
 
     public function __construct()
     {
@@ -110,7 +101,7 @@ public function writeCoordinatesToTcaRecord(array $tcaRecord, CodingResult $codi
     {
         $map = ['rawData', 'addressResultFromGeocoding', 'latitude', 'longitude', 'position', 'probability'];
         foreach ($map as $fieldName) {
-            if ($this->fieldMap->__get($fieldName)) {
+            if ($this->fieldMap->__get($fieldName) !== '' && $this->fieldMap->__get($fieldName) !== '0') {
                 $tcaRecord[$this->fieldMap->__get($fieldName)] = $codingResult->__get($fieldName);
                 if (in_array($fieldName, ['rawData', 'position'], true)) {
                     $tcaRecord[$this->fieldMap->__get($fieldName)] = json_encode(

Classes/ViewHelpers/Be/TableListViewHelper.php

@@ -27,6 +27,7 @@ final class TableListViewHelper extends AbstractBackendViewHelper
      * @var bool
      */
     protected $escapeOutput = false;
+
     protected ConfigurationManagerInterface $configurationManager;
 
     public function injectConfigurationManager(ConfigurationManagerInterface $configurationManager): void
@@ -82,7 +83,7 @@ public function initializeArguments(): void
         $this->registerArgument(
             'readOnly',
             'bool',
-            'if TRUE, the edit icons won\'t be shown. Otherwise edit icons will be shown, if the current BE user has edit rights for the specified table!',
+            "if TRUE, the edit icons won't be shown. Otherwise edit icons will be shown, if the current BE user has edit rights for the specified table!",
             false,
             false
         );
@@ -118,7 +119,7 @@ protected function render(): string
         $clickTitleMode = $this->arguments['clickTitleMode'];
         $enableControlPanels = $this->arguments['enableControlPanels'];
 
-        $languageService = $this->getLanguageService();
+        $this->getLanguageService();
         $backendUser = $this->getBackendUser();
         /** @var RenderingContext $renderingContext */
         $renderingContext = $this->renderingContext;
@@ -161,12 +162,14 @@ protected function render(): string
         $dbList->displayRecordDownload = false;
         $dbList->setRequest($request);
         $dbList->setModuleData($moduleData);
+
         $dbList->pageRow = $pageInfo;
         if ($readOnly) {
             $dbList->setIsEditable(false);
         } else {
             $dbList->calcPerms = new Permission($backendUser->calcPerms($pageInfo));
         }
+
         $dbList->disableSingleTableView = true;
         $dbList->clickTitleMode = $clickTitleMode;
         $dbList->clickMenuEnabled = $enableClickMenu;
@@ -176,6 +179,7 @@ protected function render(): string
             );
             $storagePid = $frameworkConfiguration['persistence']['storagePid'];
         }
+
         $dbList->start($storagePid, $tableName, $pointer, $filter, $levels, $recordsPerPage);
         // Column selector is disabled since fields are defined by the "fieldList" argument
         $dbList->displayColumnSelector = false;

Configuration/Icons.php

@@ -0,0 +1,10 @@
+<?php
+
+use TYPO3\CMS\Core\Imaging\IconProvider\SvgIconProvider;
+
+return [
+    'ext-nxgooglelocations-batch-type-default'=> [
+        'provider' => SvgIconProvider::class,
+        'source' => 'EXT:nxgooglelocations/Resources/Public/Icons/tx_nxgooglelocations_domain_model_batch.svg',
+    ],
+];