Completed
Push — master ( 5ad1da...0209da )
by Julien
04:14
created

Application::getDefaultCommands()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 16
Code Lines 10

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
c 1
b 0
f 0
dl 0
loc 16
rs 9.4286
cc 2
eloc 10
nc 2
nop 0
1
<?php
2
3
namespace Pickle\Console;
4
5
use Symfony\Component\Console\Application as BaseApplication;
6
use Pickle\Console\Helper;
7
8
class Application extends BaseApplication
9
{
10
    const NAME = 'pickle';
11
    const VERSION = '@pickle-version@';
12
13
    public function __construct($name = null, $version = null)
14
    {
15
        self::checkExtensions();
16
17
        parent::__construct($name ?: static::NAME, $version ?: (static::VERSION === '@' . 'pickle-version@' ? 'source' : static::VERSION));
18
    }
19
20
    protected function getDefaultHelperSet()
21
    {
22
        $helperSet = parent::getDefaultHelperSet();
23
24
        $helperSet->set(new Helper\PackageHelper());
25
26
        return $helperSet;
27
    }
28
29
    protected function getDefaultCommands()
30
    {
31
        $commands = parent::getDefaultCommands();
32
33
        $commands[] = new Command\ValidateCommand;
34
        $commands[] = new Command\ConvertCommand;
35
        $commands[] = new Command\ReleaseCommand;
36
        $commands[] = new Command\InstallerCommand;
37
        $commands[] = new Command\InfoCommand;
38
39
        if (\Phar::running() !== '') {
40
            $commands[] = new Command\SelfUpdateCommand;
41
        }
42
43
        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 (Pickle\Console\Command\V...mmand\SelfUpdateCommand) 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...
44
    }
45
46
    private static function checkExtensions()
47
    {
48
        $required_exts = array(
49
            "zlib",
50
            "mbstring",
51
            "simplexml",
52
            "json",
53
            "dom",
54
            "openssl",
55
            "phar",
56
            "zip",
57
        );
58
59
        foreach ($required_exts as $ext) {
60
            if (!extension_loaded($ext)) {
61
                die("Extension '$ext' required but not loaded, full required list: " . implode(", ", $required_exts));
0 ignored issues
show
Coding Style Compatibility introduced by
The method checkExtensions() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
62
            }
63
        }
64
    }
65
}
66