Completed
Push — master ( 4984e7...9ad690 )
by John
03:58
created

StaticGraphicRenderer::setGraphicResolver()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 2

Importance

Changes 0
Metric Value
dl 0
loc 4
rs 10
c 0
b 0
f 0
ccs 0
cts 0
cp 0
cc 1
eloc 2
nc 1
nop 1
crap 2
1
<?php
2
3
namespace Graze\CiffRenderer\Field\Renderer;
4
5
use Graze\CiffRenderer\Field\Renderer\AbstractRenderer;
6
7
class StaticGraphicRenderer extends AbstractRenderer
8
{
9
    /**
10
     * @var callable
11
     */
12
    protected $graphicResolver;
13
14
    /**
15
     * @param callable $graphicResolver
16
     */
17
    public function setGraphicResolver(callable $graphicResolver)
18
    {
19
        $this->graphicResolver = $graphicResolver;
20
    }
21
22
    /**
23
     * @return callable
24
     */
25
    protected function getGraphicResolver()
26
    {
27
        return $this->graphicResolver;
28
    }
29
30
    /**
31
     * @return string
32
     */
33
    protected function getGraphic()
34
    {
35
        return $this->parser->getGraphic();
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Graze\CiffRenderer\Field\Parser\ParserInterface as the method getGraphic() does only exist in the following implementations of said interface: Graze\CiffRenderer\Field...ser\StaticGraphicParser.

Let’s take a look at an example:

interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break.

Available Fixes

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. Add an additional type-check:

    class AuthSystem
    {
        public function authenticate(User $user)
        {
            if ($user instanceof MyUser) {
                $this->logger->info(/** ... */);
            }
    
            // or alternatively
            if ( ! $user instanceof MyUser) {
                throw new \LogicException(
                    '$user must be an instance of MyUser, '
                   .'other instances are not supported.'
                );
            }
    
        }
    }
    
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
36
    }
37
38
    /**
39
     * @return Intervention/Image/Image
0 ignored issues
show
Documentation introduced by
The doc-type Intervention/Image/Image could not be parsed: Unknown type name "Intervention/Image/Image" at position 0. (view supported doc-types)

This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.

Loading history...
40
     */
41 1
    public function render()
42
    {
43 1
        $graphicResolver = $this->getGraphicResolver();
44
45 1
        $gdResource = $graphicResolver($this->getGraphic());
46
47 1
        return $this->getImageManager()->make($gdResource);
48
    }
49
}
50