PdfBase64Model::save()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 4

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 4
rs 10
c 0
b 0
f 0
cc 1
nc 1
nop 1
1
<?php
2
3
namespace Fousky\Component\iDoklad\Model\Other;
4
5
use Fousky\Component\iDoklad\Model\iDokladAbstractModel;
6
use Fousky\Component\iDoklad\Model\iDokladModelInterface;
7
use Psr\Http\Message\ResponseInterface;
8
9
/**
10
 * @author Lukáš Brzák <[email protected]>
11
 */
12
class PdfBase64Model extends iDokladAbstractModel
13
{
14
    /**
15
     * @var string base64 encoded PDF content
16
     */
17
    public $raw;
18
19
    /**
20
     * @param ResponseInterface $response
21
     *
22
     * @return iDokladModelInterface
23
     *
24
     * @throws \RuntimeException
25
     */
26
    public static function createFromResponse(ResponseInterface $response): iDokladModelInterface
27
    {
28
        $model = new static();
29
        $model->raw = $response->getBody()->getContents();
30
31
        return $model;
0 ignored issues
show
Bug Best Practice introduced by
The return type of return $model; (Fousky\Component\iDoklad...el\Other\PdfBase64Model) is incompatible with the return type declared by the interface Fousky\Component\iDoklad...ace::createFromResponse of type self.

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...
32
    }
33
34
    /**
35
     * @param string $file
36
     *
37
     * @return bool if was successfully saved
38
     */
39
    public function save(string $file): bool
40
    {
41
        return false !== file_put_contents($file, base64_decode($this->raw));
42
    }
43
}
44