AsyncCommand::getContainer()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 4
rs 10
c 0
b 0
f 0
cc 1
eloc 2
nc 1
nop 0
1
<?php
2
3
namespace Padawan\Command;
4
5
use DI\Container;
6
use Padawan\Framework\Application\Socket;
7
use Symfony\Component\Console\Command\Command;
8
use Symfony\Component\Console\Input\InputInterface;
9
use Symfony\Component\Console\Output\OutputInterface;
10
use Padawan\Framework\Application\Socket\HttpOutput;
11
use Symfony\Component\Console\Exception\ExceptionInterface;
12
13
abstract class AsyncCommand extends Command
14
{
15
16
    /**
17
     * @return \Generator
18
     */
19
    public function run(InputInterface $input, OutputInterface $output)
20
    {
21
        // force the creation of the synopsis before the merge with the app definition
22
        $this->getSynopsis(true);
23
        $this->getSynopsis(false);
24
25
        // add the application arguments and options
26
        $this->mergeApplicationDefinition();
27
28
        // bind the input against the command specific arguments/options
29
        try {
30
            $input->bind($this->getDefinition());
31
        } catch (ExceptionInterface $e) {
32
            if (!$this->ignoreValidationErrors()) {
33
                throw $e;
34
            }
35
        }
36
37
        $this->initialize($input, $output);
38
39
        // The command name argument is often omitted when a command is executed directly with its run() method.
40
        // It would fail the validation if we didn't make sure the command argument is present,
41
        // since it's required by the application.
42
        if ($input->hasArgument('command') && null === $input->getArgument('command')) {
43
            $input->setArgument('command', $this->getName());
44
        }
45
46
        $input->validate();
47
48
        return $this->execute($input, $output);
0 ignored issues
show
Bug Compatibility introduced by
The expression $this->execute($input, $output); of type Generator|null adds the type Generator to the return on line 48 which is incompatible with the return type of the parent method Symfony\Component\Console\Command\Command::run of type integer.
Loading history...
49
    }
50
51
    protected function execute(InputInterface $input, OutputInterface $output)
52
    {
53
        if ($output instanceof HttpOutput) {
54
            return $this->executeAsync($input, $output);
0 ignored issues
show
Bug Best Practice introduced by
The return type of return $this->executeAsync($input, $output); (Generator) is incompatible with the return type of the parent method Symfony\Component\Console\Command\Command::execute of type null|integer.

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...
55
        }
56
    }
57
58
    /**
59
     * @return \Generator
60
     */
61
    abstract protected function executeAsync(InputInterface $input, HttpOutput $output);
62
63
    /**
64
     * @return Container
65
     */
66
    public function getContainer()
67
    {
68
        return $this->getApplication()->getContainer();
69
    }
70
71
    /**
72
     * @return Socket
73
     */
74
    public function getApplication()
75
    {
76
        return parent::getApplication();
77
    }
78
}
79