BitBucketApplication::getDefinition()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 8
Code Lines 4

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 8
rs 9.4285
c 0
b 0
f 0
cc 1
eloc 4
nc 1
nop 0
1
<?php declare(strict_types=1);
2
/**
3
 * Created by Vitaly Iegorov <[email protected]>.
4
 * on 22.09.16 at 13:43
5
 */
6
namespace samsonframework\bitbucket;
7
8
use Symfony\Component\Console\Application;
9
use Symfony\Component\Console\Input\InputInterface;
10
11
/**
12
 * Console application.
13
 *
14
 * @author Vitaly Egorov <[email protected]>
15
 */
16
class BitBucketApplication extends Application
17
{
18
    const VERSION = '0.0.1';
19
20
    /**
21
     * Gets the name of the command based on input.
22
     *
23
     * @param InputInterface $input The input interface
24
     *
25
     * @return string The command name
26
     */
27
    protected function getCommandName(InputInterface $input)
28
    {
29
        // This should return the name of your command.
30
        return 'reporter';
31
    }
32
33
    /**
34
     * Gets the default commands that should always be available.
35
     *
36
     * @return array An array of default Command instances
37
     */
38
    protected function getDefaultCommands()
39
    {
40
        // Keep the core default commands to have the HelpCommand
41
        // which is used when using the --help option
42
        $defaultCommands = parent::getDefaultCommands();
43
44
        $defaultCommands[] = new ReporterCommand();
45
46
        return $defaultCommands;
0 ignored issues
show
Best Practice introduced by
The expression return $defaultCommands; seems to be an array, but some of its elements' types (samsonframework\bitbucket\ReporterCommand) 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...
47
    }
48
49
    /**
50
     * Overridden so that the application doesn't expect the command
51
     * name to be the first argument.
52
     */
53
    public function getDefinition()
54
    {
55
        $inputDefinition = parent::getDefinition();
56
        // clear out the normal first argument, which is the command name
57
        $inputDefinition->setArguments();
58
59
        return $inputDefinition;
60
    }
61
}
62