Db3v4l\Command\InstanceList

Complexity

Total Complexity

14

Size/Duplication

Total Lines	94
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	1

5 Methods

Rating	Name	Duplication	Size	Complexity
A	listDatabasesVersion()	0	8	1
A	listInstances()	0	11	2
B	writeResult()	0	24	7
A	execute()	0	19	3
A	configure()	0	5	1

<?php

Missing file doc comment

namespace Db3v4l\Command;

use Db3v4l\Core\DatabaseSchemaManager;

The type Db3v4l\Core\DatabaseSchemaManager 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?

use Symfony\Component\Console\Input\InputOption;

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

use Symfony\Component\Yaml\Yaml;

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

class InstanceList extends SQLExecutingCommand

Missing doc comment for class InstanceList

{
    protected static $defaultName = 'db3v4l:instance:list';

    protected function configure()

Missing doc comment for function configure()

    {
        $this
            ->setDescription('Lists all configured database servers')
            ->addCommonOptions()

Space after closing parenthesis of function call prohibited

        ;
    }

    /**

Missing short description in doc comment

     * @todo allow to dump full configuration, not just db vendor + version

Tag @todo cannot be grouped with parameter tags in a doc comment

Tag value for @todo tag indented incorrectly; expected 3 spaces but found 1

     * @param InputInterface $input

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param OutputInterface $output

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return int

Tag @return cannot be grouped with parameter tags in a doc comment

     * @throws \Exception

Tag @throws cannot be grouped with parameter tags in a doc comment

     */
    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $this->setOutput($output);
        $this->setVerbosity($output->getVerbosity());

        $instanceList = $this->parseCommonOptions($input);

        $result = $this->listInstances($instanceList);

        $extraResults = $this->listDatabasesVersion($instanceList)['data'];
        foreach($result as $instanceName => $instanceDesc) {

Expected "foreach (...) {\n"; found "foreach(...) {\n"

            if (isset($extraResults[$instanceName])) {
                $result[$instanceName]['version'] = $extraResults[$instanceName];
            }
        }

        $this->writeResult($result);

        return 0;
    }

    /**

Missing short description in doc comment

     * @todo allow to retrieve exact version number dynamically, see getRetrieveVersionInfoSqlAction

Tag @todo cannot be grouped with parameter tags in a doc comment

Tag value for @todo tag indented incorrectly; expected 3 spaces but found 1

     * @param string[][] $instanceList

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return string[][]

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    protected function listInstances($instanceList)
    {
        $out = [];
        foreach($instanceList as $instanceName => $connectionSpec) {

Expected "foreach (...) {\n"; found "foreach(...) {\n"

            //$connectionSpec = $this->dbConfigurationManager->getInstanceConfiguration($instanceName);
            $out[$instanceName] = [
                'vendor' => $connectionSpec['vendor'],
                'version' => $connectionSpec['version']
            ];
        }
        return $out;
    }

    protected function listDatabasesVersion($instanceList)

Missing doc comment for function listDatabasesVersion()

    {
        return $this->executeSqlAction(
            $instanceList,
            'Getting database version information',
            function ($schemaManager, $instanceName) {

The parameter $instanceName is not used and could be removed.

                /** @var DatabaseSchemaManager $schemaManager */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

                return $schemaManager->getRetrieveVersionInfoSqlAction();
            }
        );
    }

    protected function writeResult($result)

Missing doc comment for function writeResult()

    {
        switch ($this->outputFormat) {
            case 'json':

Line indented incorrectly; expected 8 spaces, found 12

                $data = json_encode($result, JSON_PRETTY_PRINT);
                break;
            case 'php':

Line indented incorrectly; expected 8 spaces, found 12

                $data = var_export($result, true);
                break;
            case 'text':

Line indented incorrectly; expected 8 spaces, found 12

            case 'yml':

Line indented incorrectly; expected 8 spaces, found 12

            case 'yaml':

Line indented incorrectly; expected 8 spaces, found 12

                $data = Yaml::dump($result);
                break;
            default:

Line indented incorrectly; expected 8 spaces, found 12

                throw new \Exception("Unsupported output format: '{$this->outputFormat}'");
                break;
        }

        if ($this->outputFile != null) {
            file_put_contents($this->outputFile, $data);
            $this->writeln("Results saved to file {$this->outputFile}");
        } else {
            $this->writeln($data, OutputInterface::VERBOSITY_QUIET,  OutputInterface::OUTPUT_RAW);
        }

    }
}