[TASK] Rewrite Extbase Command Controller to Symfony Command Controller

Author: Rudy Gnodde

Classes/Controller/RandomdataCommandController.php

@@ -15,31 +15,49 @@
  */
 
 use Faker\Factory;
-use TYPO3\CMS\Extbase\Mvc\Controller\CommandController;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use TYPO3\CMS\Core\Core\Bootstrap;
+use TYPO3\CMS\Core\Utility\GeneralUtility;
+use TYPO3\CMS\Extbase\Object\ObjectManager;
 use TYPO3\CMS\Extbase\SignalSlot\Exception\InvalidSlotException;
 use TYPO3\CMS\Extbase\SignalSlot\Exception\InvalidSlotReturnException;
-use \WIND\Randomdata\Exception\ConfigurationFileNotFoundException;
-use \WIND\Randomdata\Exception\FieldsNotFoundForItemException;
-use \WIND\Randomdata\Exception\PidNotFoundForItemException;
-use \WIND\Randomdata\Exception\TableNotFoundInTcaException;
-use \WIND\Randomdata\Exception\UnknownActionException;
-use \WIND\Randomdata\Exception\CountNotFoundForItemException;
-use \WIND\Randomdata\Exception\DataHandlerException;
-use \WIND\Randomdata\Exception\ProviderException;
+use WIND\Randomdata\Exception\ConfigurationFileNotFoundException;
+use WIND\Randomdata\Exception\FieldsNotFoundForItemException;
+use WIND\Randomdata\Exception\PidNotFoundForItemException;
+use WIND\Randomdata\Exception\TableNotFoundInTcaException;
+use WIND\Randomdata\Exception\UnknownActionException;
+use WIND\Randomdata\Exception\CountNotFoundForItemException;
+use WIND\Randomdata\Exception\DataHandlerException;
+use WIND\Randomdata\Exception\ProviderException;
 use WIND\Randomdata\Service\RandomdataService;
 
 /**
  * Randomdata Command Controller
  */
-class RandomdataCommandController extends CommandController
+class RandomdataCommandController extends Command
 {
     /**
-     * Generate random data
+     * Configure
      *
-     * @param string $file YAML configuration file
-     * @param string $locale Locale used to generate data
-     * @param bool $quiet Only output errors if true
      * @return void
+     */
+    public function configure()
+    {
+        $this->setDescription('Generate random data');
+        $this->setHelp('This command allows your to create random data or replace existing data with random data');
+        $this->addArgument('file', InputArgument::REQUIRED, 'YAML configuration file');
+        $this->addArgument('locale', InputArgument::OPTIONAL, 'Locale used to generate data', Factory::DEFAULT_LOCALE);
+    }
+
+    /**
+     * Execute
+     *
+     * @param InputInterface $input
+     * @param OutputInterface $output
+     * @return int|void|null
      * @throws \RuntimeException
      * @throws ConfigurationFileNotFoundException
      * @throws FieldsNotFoundForItemException
@@ -52,10 +70,13 @@ class RandomdataCommandController extends CommandController
      * @throws InvalidSlotException
      * @throws InvalidSlotReturnException
      */
-    public function generateCommand($file, $locale = Factory::DEFAULT_LOCALE, $quiet = false)
+    public function execute(InputInterface $input, OutputInterface $output)
     {
+        Bootstrap::initializeBackendAuthentication();
+        /** @var ObjectManager $objectManager */
+        $objectManager = GeneralUtility::makeInstance(ObjectManager::class);
         /** @var RandomdataService $randomdataService */
-        $randomdataService = $this->objectManager->get(RandomdataService::class);
-        $randomdataService->generate($file, $locale, $quiet);
+        $randomdataService = $objectManager->get(RandomdataService::class);
+        $randomdataService->generate($input->getArgument('file'), $input->getArgument('locale'), $output);
     }
 }

Classes/Service/RandomdataService.php

@@ -16,6 +16,7 @@
 
 use Faker\Factory;
 use Faker\Generator;
+use Symfony\Component\Console\Output\OutputInterface;
 use TYPO3\CMS\Core\Configuration\Loader\YamlFileLoader;
 use TYPO3\CMS\Core\Database\ConnectionPool;
 use TYPO3\CMS\Core\Database\Query\QueryBuilder;
@@ -46,9 +47,9 @@ class RandomdataService
     protected $configuration;
 
     /**
-     * @var bool
+     * @var OutputInterface
      */
-    protected $quiet = false;
+    protected $output;
 
     /**
      * @var DataHandler
@@ -78,7 +79,7 @@ public function injectObjectManager(ObjectManager $objectManager)
      *
      * @param string $configurationFile
      * @param string $locale
-     * @param bool $quiet
+     * @param OutputInterface $output
      * @return void
      * @throws \RuntimeException
      * @throws ConfigurationFileNotFoundException
@@ -92,11 +93,10 @@ public function injectObjectManager(ObjectManager $objectManager)
      * @throws InvalidSlotException
      * @throws InvalidSlotReturnException
      */
-    public function generate($configurationFile, $locale, $quiet = false)
+    public function generate($configurationFile, $locale, $output = null)
     {
-        $this->quiet = $quiet;
+        $this->output = $output;
 
-        $GLOBALS['BE_USER']->user['admin'] = true;
         $this->dataHandler = GeneralUtility::makeInstance(DataHandler::class);
 
         $this->faker = Factory::create($locale);
@@ -307,7 +307,6 @@ protected function generateAndInsertRecords($configurationKey, $table, $pid, arr
         }
 
         $this->dataHandler->start($dataMap, []);
-        $this->dataHandler->admin = true;
         $this->dataHandler->process_datamap();
 
         if (!empty($this->dataHandler->errorLog)) {
@@ -345,7 +344,6 @@ protected function generateAndReplaceRecords($configurationKey, $table, $pid, ar
             }
 
             $this->dataHandler->start($dataMap, []);
-            $this->dataHandler->admin = true;
             $this->dataHandler->process_datamap();
 
             if (!empty($this->dataHandler->errorLog)) {
@@ -416,8 +414,8 @@ protected function dispatchSignalSlot($name, array $arguments)
      */
     protected function output($message)
     {
-        if (!$this->quiet) {
-            echo($message . "\n");
+        if (!empty($this->output)) {
+            $this->output->writeln($message);
         }
     }
 }

Configuration/Commands.php

@@ -0,0 +1,6 @@
+<?php
+return [
+    'randomdata:generate' => [
+        'class' => \WIND\Randomdata\Controller\RandomdataCommandController::class,
+    ],
+];

README.md

@@ -15,10 +15,11 @@ After installing randomdata in TYPO3 you can run it using the following command:
 vendor/bin/typo3 randomdata:generate configuration.yaml
 ```
 
-The command has 2 optional parameters:
+For more information about the command line options, use the following command: 
 
-- **--locale** The locale used to generate the data (default: en_US)
-- **--quiet** If set, the command will not display any messages other than errors
+```
+vendor/bin/typo3 help randomdata:generate
+```
 
 The location of the configuration yaml file needs to be inside the site root.
 

ext_emconf.php

@@ -9,7 +9,7 @@
     'state' => 'stable',
     'uploadfolder' => false,
     'clearCacheOnLoad' => false,
-    'version' => '1.0.0',
+    'version' => '1.0.1',
     'constraints' => [
         'depends' => [
             'typo3' => '8.7.13-9.5.99',

ext_localconf.php

@@ -2,6 +2,5 @@
 defined('TYPO3_MODE') or die();
 
 if (TYPO3_MODE === 'BE') {
-    $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['extbase']['commandControllers']['Randomdata-Generate'] = \WIND\Randomdata\Controller\RandomdataCommandController::class;
     $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['randomdata']['allowedActions'] = ['insert', 'replace'];
 }