ImportMappingDoctrineCommand::__construct() - Code Metrics - Inspection of "Port commands for Symfony 4.2 (follows #876)" - doctrine/DoctrineBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#877)

by Kévin

created 2018-11-23 18:27 UTC

ImportMappingDoctrineCommand::__construct() A

↳ Parent: ImportMappingDoctrineCommand

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	6
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	2

<?php

namespace Doctrine\Bundle\DoctrineBundle\Command;

use Doctrine\Common\Persistence\ManagerRegistry;
use Doctrine\ORM\Mapping\Driver\DatabaseDriver;
use Doctrine\ORM\Tools\Console\MetadataFilter;
use Doctrine\ORM\Tools\DisconnectedClassMetadataFactory;
use Doctrine\ORM\Tools\Export\ClassMetadataExporter;
use InvalidArgumentException;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;

/**
 * Import Doctrine ORM metadata mapping information from an existing database.
 *
 * @final
 */
class ImportMappingDoctrineCommand extends DoctrineCommand
{
    /**
     * @var string[]
     */
    private $bundles;

    /**
     * @param string[] $bundles
     */
    public function __construct(ManagerRegistry $doctrine, array $bundles)
    {
        parent::__construct($doctrine);

        $this->bundles = $bundles;
    }

    /**
     * {@inheritDoc}
     */
    protected function configure()
    {
        $this
            ->setName('doctrine:mapping:import')
            ->addArgument('name', InputArgument::REQUIRED, 'The bundle or namespace to import the mapping information to')
            ->addArgument('mapping-type', InputArgument::OPTIONAL, 'The mapping type to export the imported mapping information to')
            ->addOption('em', null, InputOption::VALUE_OPTIONAL, 'The entity manager to use for this command')
            ->addOption('shard', null, InputOption::VALUE_REQUIRED, 'The shard connection to use for this command')
            ->addOption('filter', null, InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, 'A string pattern used to match entities that should be mapped.')
            ->addOption('force', null, InputOption::VALUE_NONE, 'Force to overwrite existing mapping files.')
            ->addOption('path', null, InputOption::VALUE_REQUIRED, 'The path where the files would be generated (not used when a bundle is passed).')
            ->setDescription('Imports mapping information from an existing database')
            ->setHelp(<<<EOT
The <info>%command.name%</info> command imports mapping information
from an existing database:

Generate annotation mappings into the src/ directory using App as the namespace:
<info>php %command.full_name% App\\\Entity annotation --path=src/Entity</info>

Generate xml mappings into the config/doctrine/ directory using App as the namespace:
<info>php %command.full_name% App\\\Entity xml --path=config/doctrine</info>

Generate XML mappings into a bundle:
<info>php %command.full_name% "MyCustomBundle" xml</info>

You can also optionally specify which entity manager to import from with the
<info>--em</info> option:

<info>php %command.full_name% "MyCustomBundle" xml --em=default</info>

If you don't want to map every entity that can be found in the database, use the
<info>--filter</info> option. It will try to match the targeted mapped entity with the
provided pattern string.

<info>php %command.full_name% "MyCustomBundle" xml --filter=MyMatchedEntity</info>

Use the <info>--force</info> option, if you want to override existing mapping files:

<info>php %command.full_name% "MyCustomBundle" xml --force</info>
EOT
        );
    }

    /**
     * {@inheritDoc}
     */
    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $type = $input->getArgument('mapping-type') ?: 'xml';
        if ($type === 'yaml') {
            $type = 'yml';
        }

        $namespaceOrBundle = $input->getArgument('name');
        if (isset($this->bundles[$namespaceOrBundle])) {
            $bundle    = $this->getApplication()->getKernel()->getBundle($namespaceOrBundle);
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            $namespace = $bundle->getNamespace() . '\Entity';

            $destPath = $bundle->getPath();
            if ($type === 'annotation') {
                $destPath .= '/Entity';
            } else {
                $destPath .= '/Resources/config/doctrine';
            }
        } else {
            // assume a namespace has been passed
            $namespace = $namespaceOrBundle;
            $destPath  = $input->getOption('path');
            if ($destPath === null) {
                throw new InvalidArgumentException('The --path option is required when passing a namespace (e.g. --path=src). If you intended to pass a bundle name, check your spelling.');
            }
        }

        $cme      = new ClassMetadataExporter();
        $exporter = $cme->getExporter($type);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
        $exporter->setOverwriteExistingFiles($input->getOption('force'));

        if ($type === 'annotation') {
            $entityGenerator = $this->getEntityGenerator();
            $exporter->setEntityGenerator($entityGenerator);
        }

        $em = $this->getEntityManager($input->getOption('em'), $input->getOption('shard'));

        $databaseDriver = new DatabaseDriver($em->getConnection()->getSchemaManager());
        $em->getConfiguration()->setMetadataDriverImpl($databaseDriver);

        $emName = $input->getOption('em');
        $emName = $emName ? $emName : 'default';

        $cmf = new DisconnectedClassMetadataFactory();
        $cmf->setEntityManager($em);
        $metadata = $cmf->getAllMetadata();
        $metadata = MetadataFilter::filter($metadata, $input->getOption('filter'));
        if ($metadata) {

            $output->writeln(sprintf('Importing mapping information from "<info>%s</info>" entity manager', $emName));
            foreach ($metadata as $class) {
                $className   = $class->name;
                $class->name = $namespace . '\\' . $className;
                if ($type === 'annotation') {
                    $path = $destPath . '/' . str_replace('\\', '.', $className) . '.php';
                } else {
                    $path = $destPath . '/' . str_replace('\\', '.', $className) . '.orm.' . $type;
                }
                $output->writeln(sprintf('  > writing <comment>%s</comment>', $path));
                $code = $exporter->exportClassMetadata($class);
                $dir  = dirname($path);
                if (! is_dir($dir)) {
                    mkdir($dir, 0775, true);
                }
                file_put_contents($path, $code);
                chmod($path, 0664);
            }

            return 0;
        }

        $output->writeln('Database does not have any mapping information.');
        $output->writeln('');

        return 1;
    }
}


1			<?php
2
3			namespace Doctrine\Bundle\DoctrineBundle\Command;
4
5			use Doctrine\Common\Persistence\ManagerRegistry;
6			use Doctrine\ORM\Mapping\Driver\DatabaseDriver;
7			use Doctrine\ORM\Tools\Console\MetadataFilter;
8			use Doctrine\ORM\Tools\DisconnectedClassMetadataFactory;
9			use Doctrine\ORM\Tools\Export\ClassMetadataExporter;
10			use InvalidArgumentException;
11			use Symfony\Component\Console\Input\InputArgument;
12			use Symfony\Component\Console\Input\InputInterface;
13			use Symfony\Component\Console\Input\InputOption;
14			use Symfony\Component\Console\Output\OutputInterface;
15
16			/**
17			* Import Doctrine ORM metadata mapping information from an existing database.
18			*
19			* @final
20			*/
21			class ImportMappingDoctrineCommand extends DoctrineCommand
22			{
23			/**
24			* @var string[]
25			*/
26			private $bundles;
27
28			/**
29			* @param string[] $bundles
30			*/
31			public function __construct(ManagerRegistry $doctrine, array $bundles)
32			{
33			parent::__construct($doctrine);
34
35			$this->bundles = $bundles;
36			}
37
38			/**
39			* {@inheritDoc}
40			*/
41			protected function configure()
42			{
43			$this
44			->setName('doctrine:mapping:import')
45			->addArgument('name', InputArgument::REQUIRED, 'The bundle or namespace to import the mapping information to')
46			->addArgument('mapping-type', InputArgument::OPTIONAL, 'The mapping type to export the imported mapping information to')
47			->addOption('em', null, InputOption::VALUE_OPTIONAL, 'The entity manager to use for this command')
48			->addOption('shard', null, InputOption::VALUE_REQUIRED, 'The shard connection to use for this command')
49			->addOption('filter', null, InputOption::VALUE_REQUIRED \| InputOption::VALUE_IS_ARRAY, 'A string pattern used to match entities that should be mapped.')
50			->addOption('force', null, InputOption::VALUE_NONE, 'Force to overwrite existing mapping files.')
51			->addOption('path', null, InputOption::VALUE_REQUIRED, 'The path where the files would be generated (not used when a bundle is passed).')
52			->setDescription('Imports mapping information from an existing database')
53			->setHelp(<<<EOT
54			The <info>%command.name%</info> command imports mapping information
55			from an existing database:
56
57			Generate annotation mappings into the src/ directory using App as the namespace:
58			<info>php %command.full_name% App\\\Entity annotation --path=src/Entity</info>
59
60			Generate xml mappings into the config/doctrine/ directory using App as the namespace:
61			<info>php %command.full_name% App\\\Entity xml --path=config/doctrine</info>
62
63			Generate XML mappings into a bundle:
64			<info>php %command.full_name% "MyCustomBundle" xml</info>
65
66			You can also optionally specify which entity manager to import from with the
67			<info>--em</info> option:
68
69			<info>php %command.full_name% "MyCustomBundle" xml --em=default</info>
70
71			If you don't want to map every entity that can be found in the database, use the
72			<info>--filter</info> option. It will try to match the targeted mapped entity with the
73			provided pattern string.
74
75			<info>php %command.full_name% "MyCustomBundle" xml --filter=MyMatchedEntity</info>
76
77			Use the <info>--force</info> option, if you want to override existing mapping files:
78
79			<info>php %command.full_name% "MyCustomBundle" xml --force</info>
80			EOT
81			);
82			}
83
84			/**
85			* {@inheritDoc}
86			*/
87			protected function execute(InputInterface $input, OutputInterface $output)
88			{
89			$type = $input->getArgument('mapping-type') ?: 'xml';
90			if ($type === 'yaml') {
91			$type = 'yml';
92			}
93
94			$namespaceOrBundle = $input->getArgument('name');
95			if (isset($this->bundles[$namespaceOrBundle])) {
96			$bundle = $this->getApplication()->getKernel()->getBundle($namespaceOrBundle);
			0 ignored issues – show Bug introduced 2018-03-26 00:07 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Symfony\Component\Console\Application` as the method `getKernel()` does only exist in the following sub-classes of `Symfony\Component\Console\Application`: `Symfony\Bundle\FrameworkBundle\Console\Application`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
97			$namespace = $bundle->getNamespace() . '\Entity';
98
99			$destPath = $bundle->getPath();
100			if ($type === 'annotation') {
101			$destPath .= '/Entity';
102			} else {
103			$destPath .= '/Resources/config/doctrine';
104			}
105			} else {
106			// assume a namespace has been passed
107			$namespace = $namespaceOrBundle;
108			$destPath = $input->getOption('path');
109			if ($destPath === null) {
110			throw new InvalidArgumentException('The --path option is required when passing a namespace (e.g. --path=src). If you intended to pass a bundle name, check your spelling.');
111			}
112			}
113
114			$cme = new ClassMetadataExporter();
115			$exporter = $cme->getExporter($type);
			0 ignored issues – show Bug introduced 2018-10-30 22:19 UTC by Report Bug Copy Issue Report It seems like `$type` defined by `$input->getArgument('mapping-type') ?: 'xml'` on line `89` can also be of type `array<integer,string>`; however, `Doctrine\ORM\Tools\Expor...Exporter::getExporter()` does only seem to accept `string`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
116			$exporter->setOverwriteExistingFiles($input->getOption('force'));
117
118			if ($type === 'annotation') {
119			$entityGenerator = $this->getEntityGenerator();
120			$exporter->setEntityGenerator($entityGenerator);
121			}
122
123			$em = $this->getEntityManager($input->getOption('em'), $input->getOption('shard'));
124
125			$databaseDriver = new DatabaseDriver($em->getConnection()->getSchemaManager());
126			$em->getConfiguration()->setMetadataDriverImpl($databaseDriver);
127
128			$emName = $input->getOption('em');
129			$emName = $emName ? $emName : 'default';
130
131			$cmf = new DisconnectedClassMetadataFactory();
132			$cmf->setEntityManager($em);
133			$metadata = $cmf->getAllMetadata();
134			$metadata = MetadataFilter::filter($metadata, $input->getOption('filter'));
135			if ($metadata) {
			0 ignored issues – show Bug Best Practice introduced 2015-11-24 12:12 UTC by Report Bug Copy Issue Report The expression `$metadata` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
136			$output->writeln(sprintf('Importing mapping information from "<info>%s</info>" entity manager', $emName));
137			foreach ($metadata as $class) {
138			$className = $class->name;
139			$class->name = $namespace . '\\' . $className;
140			if ($type === 'annotation') {
141			$path = $destPath . '/' . str_replace('\\', '.', $className) . '.php';
142			} else {
143			$path = $destPath . '/' . str_replace('\\', '.', $className) . '.orm.' . $type;
144			}
145			$output->writeln(sprintf(' > writing <comment>%s</comment>', $path));
146			$code = $exporter->exportClassMetadata($class);
147			$dir = dirname($path);
148			if (! is_dir($dir)) {
149			mkdir($dir, 0775, true);
150			}
151			file_put_contents($path, $code);
152			chmod($path, 0664);
153			}
154
155			return 0;
156			}
157
158			$output->writeln('Database does not have any mapping information.');
159			$output->writeln('');
160
161			return 1;
162			}
163			}
164

doctrine / DoctrineBundle

Pull Request — master (#877)

ImportMappingDoctrineCommand::__construct() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like