SubCommand::setupSubCommands() - Code Metrics - Inspection of "Merge pull request #3 from tarsana/refactoring" - tarsana/command - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 48b451...90ac5a )

by Amine

created 2017-09-02 23:47 UTC

SubCommand::setupSubCommands() A

↳ Parent: SubCommand

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0

<?php namespace Tarsana\Command;

use Tarsana\Command\Command;

/**
 * A SubCommand which has a parent command and can access it.
 */
abstract class SubCommand extends Command {

    /**
     * The parent command.
     *
     * @var Tarsana\Command\Command
     */
    protected $parent;

    /**
     * Creates a new SubCommand.
     *
     * @param Command $parent
     */
    public function __construct(Command $parent)
    {
        parent::__construct();
        $this->parent = $parent;

        $this->console = $parent->console;
    }

    protected function setupSubCommands()
    {
        return $this;
    }

    /**
     * parent getter and setter.
     *
     * @param  Tarsana\Command\Command|null
     * @return Tarsana\Command\Command
     */
    public function parent(Command $value = null)
    {
        if (null === $value) {
            return $this->parent;
        }
        $this->parent = $value;

        return $this;
class Author {
    private $name;

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

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

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

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

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

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

}


1			<?php namespace Tarsana\Command;
2
3			use Tarsana\Command\Command;
4
5			/**
6			* A SubCommand which has a parent command and can access it.
7			*/
8			abstract class SubCommand extends Command {
9
10			/**
11			* The parent command.
12			*
13			* @var Tarsana\Command\Command
14			*/
15			protected $parent;
16
17			/**
18			* Creates a new SubCommand.
19			*
20			* @param Command $parent
21			*/
22			public function __construct(Command $parent)
23			{
24			parent::__construct();
25			$this->parent = $parent;
			0 ignored issues – show Documentation Bug introduced 2017-09-02 17:31 UTC by Report Bug Copy Issue Report It seems like `$parent` of type `object<Tarsana\Command\Command>` is incompatible with the declared type `object<Tarsana\Command\Tarsana\Command\Command>` of property `$parent`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
26			$this->console = $parent->console;
27			}
28
29			protected function setupSubCommands()
30			{
31			return $this;
32			}
33
34			/**
35			* parent getter and setter.
36			*
37			* @param Tarsana\Command\Command\|null
38			* @return Tarsana\Command\Command
39			*/
40			public function parent(Command $value = null)
41			{
42			if (null === $value) {
43			return $this->parent;
44			}
45			$this->parent = $value;
			0 ignored issues – show Documentation Bug introduced 2017-09-02 17:31 UTC by Report Bug Copy Issue Report It seems like `$value` of type `object<Tarsana\Command\Command>` is incompatible with the declared type `object<Tarsana\Command\Tarsana\Command\Command>` of property `$parent`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
46			return $this;
			0 ignored issues – show Bug Best Practice introduced 2016-08-15 21:44 UTC by Report Bug Copy Issue Report The return type of `return $this;` (`Tarsana\Command\SubCommand`) is incompatible with the return type documented by `Tarsana\Command\SubCommand::parent` of type `Tarsana\Command\Tarsana\Command\Command`. 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 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('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...
47			}
48
49			}
50

tarsana / command

Push — master ( 48b451...90ac5a )

SubCommand::setupSubCommands() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like