[BUGFIX] Generate database documentation via typo3 command

Build/Documentation/dbdocs/Generator.php → Classes/Command/DbDocs/Generator.php

@@ -10,7 +10,7 @@
  * LICENSE.txt file that was distributed with this source code.
  */
 
-namespace Kitodo\DbDocs;
+namespace Kitodo\Dlf\Command\DbDocs;
 
 use Doctrine\DBAL\Schema\Table;
 use Kitodo\Dlf\Common\Helper;
@@ -72,7 +72,7 @@ public function injectDataMapper(DataMapper $dataMapper)
     /**
      * @param SqlReader $sqlReader
      */
-    public function injectSqlReader(DataMapper $sqlReader)
+    public function injectSqlReader(SqlReader $sqlReader)
     {
         $this->sqlReader = $sqlReader;
     }

Build/Documentation/dbdocs/RstSection.php → Classes/Command/DbDocs/RstSection.php

@@ -10,7 +10,7 @@
  * LICENSE.txt file that was distributed with this source code.
  */
 
-namespace Kitodo\DbDocs;
+ namespace Kitodo\Dlf\Command\DbDocs;
 
 /**
  * Simple utility to write .rst (reStructuredText).
@@ -55,7 +55,7 @@
 
     public function subsection()
     {
         $section = new static();
         $this->subsections[] = $section;
         return $section;
     }

Classes/Command/DbDocsCommand.php

@@ -0,0 +1,96 @@
+<?php
+
+/**
+ * (c) Kitodo. Key to digital objects e.V. <contact@kitodo.org>
+ *
+ * This file is part of the Kitodo and TYPO3 projects.
+ *
+ * @license GNU General Public License version 3 or later.
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ */
+
+namespace Kitodo\Dlf\Command;
+
+use Kitodo\Dlf\Common\AbstractDocument;
+use Kitodo\Dlf\Common\Indexer;
+use Kitodo\Dlf\Command\DbDocs\Generator;
+use Kitodo\Dlf\Domain\Model\Document;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
+use TYPO3\CMS\Core\Utility\GeneralUtility;
+use TYPO3\CMS\Core\Utility\MathUtility;
+
+/**
+ * CLI Command for generating the reStructuredText file containing documentation 
+ * about the database schema.
+ *
+ * @package TYPO3
+ * @subpackage dlf
+ *
+ * @access public
+ */
+class DbDocsCommand extends Command
+{
+
+    protected Generator $generator;
+
+    public function __construct(
+        Generator $generator
+    ) {
+        parent::__construct();
+
+       $this->generator = $generator;
+    }
+
+    /**
+     * Configure the command by defining the name, options and arguments
+     *
+     * @access public
+     *
+     * @return void
+     */
+    public function configure(): void
+    {
+        $this
+            ->setDescription('Generate database rst file.')
+            ->setHelp('')
+            ->addArgument('outputPath', InputArgument::OPTIONAL, 'the path to the output rst file');
+    }
+
+    /**
+     * Executes the command to generate the documentation.
+     *
+     * @access protected
+     *
+     * @param InputInterface $input The input parameters
+     * @param OutputInterface $output The Symfony interface for outputs on console
+     *
+     * @return int
+     */
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $io = new SymfonyStyle($input, $output);
+        $io->title($this->getDescription());
+
+        $outputPath = "kitodo-presentation/Documentation/Developers/Database.rst";
+        if ($input->getArgument('outputPath')) {
+            $outputPath = $input->getArgument('outputPath');
+        }
+
+        // $generator = GeneralUtility::makeInstance(\Kitodo\Dlf\Command\DbDocs\Generator::class);
+        $tables = $this->generator->collectTables();
+        $page = $this->generator->generatePage($tables);
+        // file_put_contents($outputPath, $page->render());
+
+        file_put_contents($outputPath, $page->render());
+
+        $io->write("Database documentation written to output file:\n" . $outputPath . "\n");
+        return Command::SUCCESS;
+    }
+
+}

Configuration/Services.yaml

@@ -7,6 +7,11 @@ services:
   Kitodo\Dlf\:
     resource: '../Classes/*'
 
+  Kitodo\Dlf\Command\DbDocsCommand:
+    tags:
+      - name: console.command
+        command: 'kitodo:dbdocs'
+
   Kitodo\Dlf\Command\DeleteCommand:
     tags:
       - name: console.command