Issues in AbstractCommand.php - All Issues - Inspection of "Merge branch '1.1.x'" - doctrine/mongodb-odm - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2a52ee...a45a67 )

by Andreas

created 2017-09-27 17:13 UTC

Tools/Console/Command/Schema/AbstractCommand.php (1 issue)

Labels

Bug 1

Severity

Minor 1

Bulat Shakirzyanov 1

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php
/*
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the MIT license. For more information, see
 * <http://www.doctrine-project.org>.
 */

namespace Doctrine\ODM\MongoDB\Tools\Console\Command\Schema;

use Doctrine\ODM\MongoDB\SchemaManager;
use Symfony\Component\Console\Command\Command;

abstract class AbstractCommand extends Command
{
    const DB = 'db';
    const COLLECTION = 'collection';
    const INDEX = 'index';

    abstract protected function processDocumentCollection(SchemaManager $sm, $document);

    abstract protected function processCollection(SchemaManager $sm);

    abstract protected function processDocumentDb(SchemaManager $sm, $document);

    abstract protected function processDb(SchemaManager $sm);

    abstract protected function processDocumentIndex(SchemaManager $sm, $document);

    abstract protected function processIndex(SchemaManager $sm);

    /**
     * @return SchemaManager
     */
    protected function getSchemaManager()
    {
        return $this->getDocumentManager()->getSchemaManager();
    }

    /**
     * @return \Doctrine\ODM\MongoDB\DocumentManager
     */
    protected function getDocumentManager()
    {
        return $this->getHelper('documentManager')->getDocumentManager();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements 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.
    }
}
    }

    /**
     * @return \Doctrine\ODM\MongoDB\Mapping\ClassMetadataFactory
     */
    protected function getMetadataFactory()
    {
        return $this->getDocumentManager()->getMetadataFactory();
    }
}


Push — master ( 2a52ee...a45a67 )

Tools/Console/Command/Schema/AbstractCommand.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Available Fixes

1			<?php
2			/*
3			* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
4			* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
5			* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
6			* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
7			* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
8			* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
9			* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
10			* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
11			* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
12			* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
13			* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
14			*
15			* This software consists of voluntary contributions made by many individuals
16			* and is licensed under the MIT license. For more information, see
17			* <http://www.doctrine-project.org>.
18			*/
19
20			namespace Doctrine\ODM\MongoDB\Tools\Console\Command\Schema;
21
22			use Doctrine\ODM\MongoDB\SchemaManager;
23			use Symfony\Component\Console\Command\Command;
24
25			abstract class AbstractCommand extends Command
26			{
27			const DB = 'db';
28			const COLLECTION = 'collection';
29			const INDEX = 'index';
30
31			abstract protected function processDocumentCollection(SchemaManager $sm, $document);
32
33			abstract protected function processCollection(SchemaManager $sm);
34
35			abstract protected function processDocumentDb(SchemaManager $sm, $document);
36
37			abstract protected function processDb(SchemaManager $sm);
38
39			abstract protected function processDocumentIndex(SchemaManager $sm, $document);
40
41			abstract protected function processIndex(SchemaManager $sm);
42
43			/**
44			* @return SchemaManager
45			*/
46			protected function getSchemaManager()
47			{
48			return $this->getDocumentManager()->getSchemaManager();
49			}
50
51			/**
52			* @return \Doctrine\ODM\MongoDB\DocumentManager
53			*/
54			protected function getDocumentManager()
55			{
56			return $this->getHelper('documentManager')->getDocumentManager();
			0 ignored issues – show Bug introduced 2016-06-18 17:19 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like you code against a concrete implementation and not the interface `Symfony\Component\Console\Helper\HelperInterface` as the method `getDocumentManager()` does only exist in the following implementations of said interface: `Doctrine\ODM\MongoDB\Too...r\DocumentManagerHelper`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements 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 implementation 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 interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
57			}
58
59			/**
60			* @return \Doctrine\ODM\MongoDB\Mapping\ClassMetadataFactory
61			*/
62			protected function getMetadataFactory()
63			{
64			return $this->getDocumentManager()->getMetadataFactory();
65			}
66			}
67

doctrine / mongodb-odm

Push — master ( 2a52ee...a45a67 )

Tools/Console/Command/Schema/AbstractCommand.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Available Fixes

Duplication Side-by-Side

Filter issues like