DoctrineCommand::__construct() - Code Metrics - Inspection of "Remove deprecated functionality from DoctrineComma..." - doctrine/DoctrineBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1026)

by Alexander M.

created 2019-10-07 15:39 UTC

DoctrineCommand::__construct() A

↳ Parent: DoctrineCommand

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	1

<?php

namespace Doctrine\Bundle\DoctrineBundle\Command;

use Doctrine\Common\Persistence\ManagerRegistry;
use Doctrine\DBAL\Connection;
use Doctrine\DBAL\Sharding\PoolingShardConnection;
use Doctrine\ORM\EntityManager;
use Doctrine\ORM\Tools\EntityGenerator;
use LogicException;
use Symfony\Component\Console\Command\Command;

/**
 * Base class for Doctrine console commands to extend from.
 *
 * @internal
 */
abstract class DoctrineCommand extends Command
{
    /** @var ManagerRegistry */
    private $doctrine;

    public function __construct(ManagerRegistry $doctrine)
    {
        parent::__construct();

        $this->doctrine = $doctrine;
    }

    /**
     * get a doctrine entity generator
     *
     * @return EntityGenerator
     */
    protected function getEntityGenerator()
    {
        $entityGenerator = new EntityGenerator();
        $entityGenerator->setGenerateAnnotations(false);
        $entityGenerator->setGenerateStubMethods(true);
        $entityGenerator->setRegenerateEntityIfExists(false);
        $entityGenerator->setUpdateEntityIfExists(true);
        $entityGenerator->setNumSpaces(4);
        $entityGenerator->setAnnotationPrefix('ORM\\');

        return $entityGenerator;
    }

    /**
     * Get a doctrine entity manager by symfony name.
     *
     * @param string   $name
     * @param int|null $shardId
     *
     * @return EntityManager
     */
    protected function getEntityManager($name, $shardId = null)
    {
        $manager = $this->getDoctrine()->getManager($name);

        if ($shardId) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            if (! $manager->getConnection() instanceof PoolingShardConnection) {
                throw new LogicException(sprintf("Connection of EntityManager '%s' must implement shards configuration.", $name));
            }

            $manager->getConnection()->connect($shardId);
        }

        return $manager;
    }

    /**
     * Get a doctrine dbal connection by symfony name.
     *
     * @param string $name
     *
     * @return Connection
     */
    protected function getDoctrineConnection($name)
    {
        return $this->getDoctrine()->getConnection($name);
    }

    /**
     * @return ManagerRegistry
     */
    protected function getDoctrine()
    {
        return $this->doctrine;
    }
}


1			<?php
2
3			namespace Doctrine\Bundle\DoctrineBundle\Command;
4
5			use Doctrine\Common\Persistence\ManagerRegistry;
6			use Doctrine\DBAL\Connection;
7			use Doctrine\DBAL\Sharding\PoolingShardConnection;
8			use Doctrine\ORM\EntityManager;
9			use Doctrine\ORM\Tools\EntityGenerator;
10			use LogicException;
11			use Symfony\Component\Console\Command\Command;
12
13			/**
14			* Base class for Doctrine console commands to extend from.
15			*
16			* @internal
17			*/
18			abstract class DoctrineCommand extends Command
19			{
20			/** @var ManagerRegistry */
21			private $doctrine;
22
23			public function __construct(ManagerRegistry $doctrine)
24			{
25			parent::__construct();
26
27			$this->doctrine = $doctrine;
28			}
29
30			/**
31			* get a doctrine entity generator
32			*
33			* @return EntityGenerator
34			*/
35			protected function getEntityGenerator()
36			{
37			$entityGenerator = new EntityGenerator();
38			$entityGenerator->setGenerateAnnotations(false);
39			$entityGenerator->setGenerateStubMethods(true);
40			$entityGenerator->setRegenerateEntityIfExists(false);
41			$entityGenerator->setUpdateEntityIfExists(true);
42			$entityGenerator->setNumSpaces(4);
43			$entityGenerator->setAnnotationPrefix('ORM\\');
44
45			return $entityGenerator;
46			}
47
48			/**
49			* Get a doctrine entity manager by symfony name.
50			*
51			* @param string $name
52			* @param int\|null $shardId
53			*
54			* @return EntityManager
55			*/
56			protected function getEntityManager($name, $shardId = null)
57			{
58			$manager = $this->getDoctrine()->getManager($name);
59
60			if ($shardId) {
			0 ignored issues – show Bug Best Practice introduced 2018-09-26 00:42 UTC by Report Bug Copy Issue Report The expression `$shardId` of type `integer\|null` is loosely compared to `true`; this is ambiguous if the integer can be zero. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `integer` values, zero is a special case, in particular the following results might be unexpected: 0 == false // true 0 == null // true 123 == false // false 123 == null // false // It is often better to use strict comparison 0 === false // false 0 === null // false Loading history...
61			if (! $manager->getConnection() instanceof PoolingShardConnection) {
62			throw new LogicException(sprintf("Connection of EntityManager '%s' must implement shards configuration.", $name));
63			}
64
65			$manager->getConnection()->connect($shardId);
66			}
67
68			return $manager;
69			}
70
71			/**
72			* Get a doctrine dbal connection by symfony name.
73			*
74			* @param string $name
75			*
76			* @return Connection
77			*/
78			protected function getDoctrineConnection($name)
79			{
80			return $this->getDoctrine()->getConnection($name);
81			}
82
83			/**
84			* @return ManagerRegistry
85			*/
86			protected function getDoctrine()
87			{
88			return $this->doctrine;
89			}
90			}
91

doctrine / DoctrineBundle

Pull Request — master (#1026)

DoctrineCommand::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like