WhichApplication::getDefinition() - Code Metrics - nubs/which-cli - Measure and Improve Code Quality continuously with Scrutinizer

WhichApplication::getDefinition() A
last analyzed 2016-09-25 02:31 UTC

↳ Parent: WhichApplication

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	9
rs	9.6666
c	0
b	0
f	0
cc	1
eloc	4
nc	1
nop	0

<?php
namespace Nubs\Which\Application;

use Nubs\Which\Locator;
use Symfony\Component\Console\Application as SymfonyApplication;
use Symfony\Component\Console\Input\InputInterface;

class WhichApplication extends SymfonyApplication
{
    /** @type \Nubs\Which\Locator The application's locator. */
    protected $_locator;

    /**
     * Initialize the application.
     *
     * @param \Nubs\Which\Locator $locator The locator to use.
     */
    public function __construct(Locator $locator)
    {
        parent::__construct('Which', '1.0.0');

        $this->_locator = $locator;
    }

    /**
     * Fetch the locator.
     *
     * @return \Nubs\Which\Locator The locator to use for the application.
     */
    public function getLocator()
    {
        return $this->_locator;
    }

    /**
     * Gets the name of the command based on input.
     *
     * @param \Symfony\Component\Console\Input\InputInterface $input The input
     *     interface.
     *
     * @return string The command name
     */
    protected function getCommandName(InputInterface $input)
    {
        return 'which';
    }

    /**
     * Gets the default commands that should always be available.
     *
     * @return array An array of default Command instances
     */
    protected function getDefaultCommands()
    {
        // Keep the core default commands to have the HelpCommand which is used
        // when using the --help option
        $defaultCommands = parent::getDefaultCommands();

        $defaultCommands[] = new WhichCommand();

        return $defaultCommands;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * Overridden so that the application doesn't expect the command name to be
     * the first argument.
     *
     * @return \Symfony\Component\Console\Input\InputDefinition
     */
    public function getDefinition()
    {
        $inputDefinition = parent::getDefinition();

        // clear out the normal first argument, which is the command name
        $inputDefinition->setArguments();

        return $inputDefinition;
    }
}


1			<?php
2			namespace Nubs\Which\Application;
3
4			use Nubs\Which\Locator;
5			use Symfony\Component\Console\Application as SymfonyApplication;
6			use Symfony\Component\Console\Input\InputInterface;
7
8			class WhichApplication extends SymfonyApplication
9			{
10			/** @type \Nubs\Which\Locator The application's locator. */
11			protected $_locator;
12
13			/**
14			* Initialize the application.
15			*
16			* @param \Nubs\Which\Locator $locator The locator to use.
17			*/
18			public function __construct(Locator $locator)
19			{
20			parent::__construct('Which', '1.0.0');
21
22			$this->_locator = $locator;
23			}
24
25			/**
26			* Fetch the locator.
27			*
28			* @return \Nubs\Which\Locator The locator to use for the application.
29			*/
30			public function getLocator()
31			{
32			return $this->_locator;
33			}
34
35			/**
36			* Gets the name of the command based on input.
37			*
38			* @param \Symfony\Component\Console\Input\InputInterface $input The input
39			* interface.
40			*
41			* @return string The command name
42			*/
43			protected function getCommandName(InputInterface $input)
44			{
45			return 'which';
46			}
47
48			/**
49			* Gets the default commands that should always be available.
50			*
51			* @return array An array of default Command instances
52			*/
53			protected function getDefaultCommands()
54			{
55			// Keep the core default commands to have the HelpCommand which is used
56			// when using the --help option
57			$defaultCommands = parent::getDefaultCommands();
58
59			$defaultCommands[] = new WhichCommand();
60
61			return $defaultCommands;
			0 ignored issues – show Best Practice introduced 2015-12-06 21:30 UTC by Report Bug Copy Issue Report The expression `return $defaultCommands;` seems to be an `array`, but some of its elements' types (`Nubs\Which\Application\WhichCommand`) are incompatible with the return type of the parent method `Symfony\Component\Consol...ion::getDefaultCommands` of type `array<Symfony\Component\...le\Command\ListCommand>`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return new Author('Johannes'); } } class BlogPost extends Post { public function getAuthor() { return 'Johannes'; } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
62			}
63
64			/**
65			* Overridden so that the application doesn't expect the command name to be
66			* the first argument.
67			*
68			* @return \Symfony\Component\Console\Input\InputDefinition
69			*/
70			public function getDefinition()
71			{
72			$inputDefinition = parent::getDefinition();
73
74			// clear out the normal first argument, which is the command name
75			$inputDefinition->setArguments();
76
77			return $inputDefinition;
78			}
79			}
80

nubs / which-cli

WhichApplication::getDefinition() A last analyzed 2016-09-25 02:31 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

WhichApplication::getDefinition() A
last analyzed 2016-09-25 02:31 UTC