Application::getLongVersion()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 10
Code Lines 5

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
c 1
b 0
f 0
dl 0
loc 10
rs 9.4286
cc 1
eloc 5
nc 1
nop 0
1
<?php
2
3
4
namespace NilPortugues\TodoFinder\Console;
5
6
use NilPortugues\TodoFinder\Command\FinderCommand;
7
8
class Application extends \Symfony\Component\Console\Application
9
{
10
    /**
11
     * Returns the long version of the application.
12
     *
13
     * @return string The long application version
14
     */
15
    public function getLongVersion()
16
    {
17
        $name = <<<NAME
18
19
<info> PHP To-Do Finder</info>                                   <comment>by Nil Portugués</comment>
20
====================================================================
21
NAME;
22
23
        return sprintf($name);
24
    }
25
26
    /**
27
     * Initializes all the composer commands
28
     *
29
     * @return \Symfony\Component\Console\Command\Command[]
30
     */
31
    protected function getDefaultCommands()
32
    {
33
        $commands = parent::getDefaultCommands();
34
        $commands[] = new FinderCommand();
35
36
        return $commands;
0 ignored issues
show
Best Practice introduced by
The expression return $commands; seems to be an array, but some of its elements' types (NilPortugues\TodoFinder\Command\FinderCommand) 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...
37
    }
38
}
39