Completed
Push — master ( 36c960...526274 )
by Sam
03:50
created

LocalFileProvider::getRawCertificate()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
c 0
b 0
f 0
dl 0
loc 4
rs 10
cc 1
eloc 2
nc 1
nop 0
1
<?php
2
3
namespace Jalle19\CertificateParser\Provider;
4
5
use Jalle19\CertificateParser\Provider\Exception\FileNotFoundException;
6
7
/**
8
 * Class LocalFileProvider
9
 * @package Jalle19\CertificateParser\Provider
10
 */
11
class LocalFileProvider implements ProviderInterface
12
{
13
14
    /**
15
     * @var string
16
     */
17
    private $filePath;
18
19
20
    /**
21
     * LocalFileProvider constructor.
22
     *
23
     * @param string $filePath
24
     *
25
     * @throws FileNotFoundException if the file doesn't exist
26
     */
27
    public function __construct($filePath)
28
    {
29
        if (!file_exists($filePath)) {
30
            throw new FileNotFoundException($filePath . ' does not exist or is not readable');
31
        }
32
33
        $this->filePath = $filePath;
34
    }
35
36
37
    /**
38
     * @inheritdoc
39
     */
40
    public function getRawCertificate()
41
    {
42
        return openssl_x509_read(file_get_contents($this->filePath));
0 ignored issues
show
Bug Best Practice introduced by
The return type of return openssl_x509_read...ents($this->filePath)); (resource) is incompatible with the return type declared by the interface Jalle19\CertificateParse...face::getRawCertificate of type array.

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...
43
    }
44
45
}
46