MontealegreLuis / phuml

src/Console/Commands/GenerateDotFileCommand.php

<?php
/**
 * PHP version 7.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\Configuration\DigraphConfiguration;
use PhUml\Configuration\DotFileBuilder;
use PhUml\Parser\CodebaseDirectory;
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
 */
class GenerateDotFileCommand extends GeneratorCommand
{
    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 attributes.
    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
    {
        $generatorInput = new GeneratorInput($input->getArguments(), $input->getOptions());
        $codebasePath = $generatorInput->directory();
        $dotFilePath = $generatorInput->outputFile();

        $builder = new DotFileBuilder(new DigraphConfiguration($generatorInput->options()));

        $dotFileGenerator = $builder->dotFileGenerator();
        $dotFileGenerator->attach($this->display);

        $codeFinder = $builder->codeFinder();
        $codeFinder->addDirectory(CodebaseDirectory::from($codebasePath));

        $dotFileGenerator->generate($codeFinder, $dotFilePath);

        return self::SUCCESS;
    }
}