AbstractCommand::getConveyor() - Code Metrics - webcreate/conveyor - Measure and Improve Code Quality continuously with Scrutinizer

AbstractCommand::getConveyor() A
last analyzed 2016-12-08 12:42 UTC

↳ Parent: AbstractCommand

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	3
crap	1

<?php

/*
 * This file is part of the Conveyor package.
 *
 * (c) Jeroen Fiege <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Webcreate\Conveyor\Command;

use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

abstract class AbstractCommand extends Command
{
    /**
     * Returns a conveyor instance
     *
     * @param  InputInterface                                   $input     The input instance
     * @param  OutputInterface                                  $output    The output instance
     * @param  null|\Symfony\Component\Console\Helper\HelperSet $helperSet The helperSet instance
     * @return \Webcreate\Conveyor\Conveyor
     */
    public function getConveyor(InputInterface $input, OutputInterface $output, $helperSet)

    {
        return $this->getApplication()->getConveyor();
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.
    }
}
    }
}


1		<?php
2
3		/*
4		* This file is part of the Conveyor package.
5		*
6		* (c) Jeroen Fiege <[email protected]>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace Webcreate\Conveyor\Command;
13
14		use Symfony\Component\Console\Command\Command;
15		use Symfony\Component\Console\Input\InputInterface;
16		use Symfony\Component\Console\Output\OutputInterface;
17
18		abstract class AbstractCommand extends Command
19		{
20		/**
21		* Returns a conveyor instance
22		*
23		* @param InputInterface $input The input instance
24		* @param OutputInterface $output The output instance
25		* @param null\|\Symfony\Component\Console\Helper\HelperSet $helperSet The helperSet instance
26		* @return \Webcreate\Conveyor\Conveyor
27		*/
28	2	public function getConveyor(InputInterface $input, OutputInterface $output, $helperSet)
		0 ignored issues – show Unused Code introduced 2016-01-14 09:42 UTC by Report Bug Copy Issue Report The parameter `$input` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2016-01-14 09:42 UTC by Report Bug Copy Issue Report The parameter `$output` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2016-01-14 09:42 UTC by Report Bug Copy Issue Report The parameter `$helperSet` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
29		{
30	2	return $this->getApplication()->getConveyor();
		0 ignored issues – show Bug introduced 2016-01-14 09:42 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 `getConveyor()` does only exist in the following sub-classes of `Symfony\Component\Console\Application`: `Webcreate\Conveyor\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...
31		}
32		}
33

webcreate / conveyor

AbstractCommand::getConveyor() A last analyzed 2016-12-08 12:42 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

AbstractCommand::getConveyor() A
last analyzed 2016-12-08 12:42 UTC