MontealegreLuis / phuml

src/Console/Commands/GenerateDotFileCommand.php

<?php declare(strict_types=1);
/**
 * This source file is subject to the license that is bundled with this package in the file LICENSE.
 */

namespace PhUml\Console\Commands;

use PhUml\Console\ConsoleProgressDisplay;
use PhUml\Generators\DigraphConfiguration;
use PhUml\Generators\DigraphGenerator;
use Symfony\Component\Console\Command\Command;

The type Symfony\Component\Console\Command\Command was not found. Maybe you did not declare it correctly or list all dependencies?

use Symfony\Component\Console\Input\InputArgument;

The type Symfony\Component\Console\Input\InputArgument was not found. Maybe you did not declare it correctly or list all dependencies?

use Symfony\Component\Console\Input\InputInterface;

The type Symfony\Component\Console\Input\InputInterface was not found. Maybe you did not declare it correctly or list all dependencies?

use Symfony\Component\Console\Output\OutputInterface;

The type Symfony\Component\Console\Output\OutputInterface was not found. Maybe you did not declare it correctly or list all dependencies?

/**
 * This command will generate file in `DOT` format that is ready to use to generate a UML class
 * diagram using either `neato` or `dot`
 *
 * This command has 2 required arguments
 *
 * 1. `directory`. The path where your codebase lives
 * 2. `output`. The path to where the generated `gv` file will be saved
 *
 * @see WithDigraphConfiguration::addDigraphOptions() for more details about all the available options
 */
final class GenerateDotFileCommand extends Command
{
    use WithDigraphConfiguration;

    protected function configure(): void
    {
        $this
            ->setName('phuml:dot')
            ->setDescription('Generates a digraph in DOT format of a given directory')
            ->setHelp(
                <<<HELP
Example:
    php bin/phuml phuml:dot -r -a ./src dot.gv

    This command will look for PHP files within the `./src` directory and its sub-directories.
    It will extract associations from constructor parameters and properties.
    It will generate a digraph in DOT format and save it to the file `dot.gv`.
HELP
            )
            ->addArgument(
                'directory',
                InputArgument::REQUIRED,
                'The directory to be scanned to generate the DOT file'
            )
            ->addArgument(
                'output',
                InputArgument::REQUIRED,
                'The file name for your DOT file'
            )
        ;
        $this->addDigraphOptions($this);
    }

    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        /**
         * @var array{
         *     recursive: bool,
         *     associations: bool,
         *     "hide-private": bool,
         *     "hide-protected": bool,
         *     "hide-methods": bool,
         *     "hide-attributes": bool,
         *     "hide-empty-blocks": bool,
         *     theme: string
         *  } $options
         */
        $options = $input->getOptions();
        $configuration = new DigraphConfiguration($options, new ConsoleProgressDisplay($output));
        $generator = DigraphGenerator::fromConfiguration($configuration);
        /**
         * @var array{
         *      directory: string,
         *      output: string
         * } $arguments
         */
        $arguments = $input->getArguments();
        $generator->generate(GeneratorInput::dotFile($arguments));

        return self::SUCCESS;
    }
}