SilverStripeCommand::getOrAskForArgument() - Code Metrics - Inspection of "API Add configuration loader, YAML configuration f..." - silverleague/silverstripe-console - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 53e74a...4c1ea9 )

by Robbie

created 2017-01-03 00:38 UTC

SilverStripeCommand::getOrAskForArgument() A

↳ Parent: SilverStripeCommand

Complexity

Conditions	3
Paths	3

Size

Total Lines	14
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	14
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	8
nc	3
nop	4

<?php

namespace SilverLeague\Console\Command;

use SilverStripe\Core\Config\Config;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\Dev\BuildTask;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Question\Question;

/**
 * A slightly embellished Symfony Command class which is SilverStripe aware
 *
 * @package silverstripe-console
 * @author  Robbie Averill <[email protected]>
 */
class SilverStripeCommand extends Command
{
    /**
     * Retrieve an argument from the input interface, or use the Question helper to ask for input
     * if it wasn't provided. Will automatically hide input for password fields.
     *
     * @param  InputInterface  $input
     * @param  OutputInterface $output
     * @param  string          $key      The argument key, e.g. "username"
     * @param  string          $question The question to ask, e.g. "Which username: "
     * @return string|null
     */
    protected function getOrAskForArgument(InputInterface $input, OutputInterface $output, $key, $question)
    {
        if ($supplied = $input->getArgument($key)) {
            return $supplied;
        }

        $question = new Question($question);
        if (stripos($key, 'password') !== false) {
            $question->setHidden(true);
            $question->setHiddenFallback(false);
        }

        return $this->getHelper('question')->ask($input, $output, $question);
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.
    }
}
    }

    /**
     * Get the SilverStripe Injector
     *
     * @return Injector
     */
    public function getInjector()
    {
        return Injector::inst();
    }

    /**
     * Get the configuration API handler
     *
     * @return Config
     */
    public function getConfig()
    {
        return Config::inst();
    }
}


1			<?php
2
3			namespace SilverLeague\Console\Command;
4
5			use SilverStripe\Core\Config\Config;
6			use SilverStripe\Core\Injector\Injector;
7			use SilverStripe\Dev\BuildTask;
8			use Symfony\Component\Console\Command\Command;
9			use Symfony\Component\Console\Input\InputArgument;
10			use Symfony\Component\Console\Input\InputInterface;
11			use Symfony\Component\Console\Output\OutputInterface;
12			use Symfony\Component\Console\Question\Question;
13
14			/**
15			* A slightly embellished Symfony Command class which is SilverStripe aware
16			*
17			* @package silverstripe-console
18			* @author Robbie Averill <[email protected]>
19			*/
20			class SilverStripeCommand extends Command
21			{
22			/**
23			* Retrieve an argument from the input interface, or use the Question helper to ask for input
24			* if it wasn't provided. Will automatically hide input for password fields.
25			*
26			* @param InputInterface $input
27			* @param OutputInterface $output
28			* @param string $key The argument key, e.g. "username"
29			* @param string $question The question to ask, e.g. "Which username: "
30			* @return string\|null
31			*/
32			protected function getOrAskForArgument(InputInterface $input, OutputInterface $output, $key, $question)
33			{
34			if ($supplied = $input->getArgument($key)) {
35			return $supplied;
36			}
37
38			$question = new Question($question);
39			if (stripos($key, 'password') !== false) {
40			$question->setHidden(true);
41			$question->setHiddenFallback(false);
42			}
43
44			return $this->getHelper('question')->ask($input, $output, $question);
			0 ignored issues – show Bug introduced 2017-01-02 23:31 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Symfony\Component\Console\Helper\HelperInterface` as the method `ask()` does only exist in the following implementations of said interface: `Symfony\Component\Console\Helper\QuestionHelper`, `Symfony\Component\Consol...r\SymfonyQuestionHelper`. 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...
45			}
46
47			/**
48			* Get the SilverStripe Injector
49			*
50			* @return Injector
51			*/
52			public function getInjector()
53			{
54			return Injector::inst();
55			}
56
57			/**
58			* Get the configuration API handler
59			*
60			* @return Config
61			*/
62			public function getConfig()
63			{
64			return Config::inst();
65			}
66			}
67

silverleague / silverstripe-console

Push — master ( 53e74a...4c1ea9 )

SilverStripeCommand::getOrAskForArgument() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like